Package net.schmizz.sshj.sftp

Class SFTPEngine

java.lang.Object

net.schmizz.sshj.sftp.SFTPEngine

All Implemented Interfaces:

Closeable, AutoCloseable, Requester

public class SFTPEngine
extends Object
implements Requester, Closeable

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_TIMEOUT_MS
protected final org.slf4j.Logger	log
protected final LoggerFactory	loggerFactory	Logger
static final int	MAX_SUPPORTED_VERSION
protected int	operativeVersion
protected final OutputStream	out
protected final PathHelper	pathHelper
protected final PacketReader	reader
protected long	reqID
protected final Map<String,String>	serverExtensions
private final Session	session
protected final Session.Subsystem	sub
protected int	timeoutMs

Constructor Summary

Constructors

Constructor	Description
SFTPEngine(SessionFactory ssh)
SFTPEngine(SessionFactory ssh, String pathSep)

Method Summary

Modifier and Type	Method	Description
String	canonicalize(String path)
void	close()
private Response	doRequest(Request req)
protected LoggerFactory	getLoggerFactory()
int	getOperativeProtocolVersion()
PathHelper	getPathHelper()
String	getServerExtensionData(String extension, String domain)
Session.Subsystem	getSubsystem()
int	getTimeoutMs()
SFTPEngine	init()
protected SFTPEngine	init(int requestedVersion)	Introduced for internal use by testcases.
FileAttributes	lstat(String path)
void	makeDir(String path)
void	makeDir(String path, FileAttributes attrs)
Request	newExtendedRequest(String reqName)
Request	newRequest(PacketType type)
RemoteFile	open(String filename)
RemoteFile	open(String filename, Set<OpenMode> modes)
RemoteFile	open(String path, Set<OpenMode> modes, FileAttributes fa)
RemoteDirectory	openDir(String path)
String	readLink(String path)
protected static String	readSingleName(Response res)	Using UTF-8
protected static String	readSingleName(Response res, Charset charset)	Using any character set
private static byte[]	readSingleNameAsBytes(Response res)
void	remove(String filename)
void	removeDir(String path)
void	rename(String oldPath, String newPath, Set<RenameFlags> flags)
Promise<Response,SFTPException>	request(Request req)
void	setAttributes(String path, FileAttributes attrs)
void	setTimeoutMs(int timeoutMs)
FileAttributes	stat(String path)
protected FileAttributes	stat(PacketType pt, String path)
boolean	supportsServerExtension(String extension, String domain)
void	symlink(String linkpath, String targetpath)
protected void	transmit(SFTPPacket<Request> payload)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MAX_SUPPORTED_VERSION

public static final int MAX_SUPPORTED_VERSION

See Also:

• Constant Field Values

DEFAULT_TIMEOUT_MS

public static final int DEFAULT_TIMEOUT_MS

See Also:

• Constant Field Values

loggerFactory

protected final LoggerFactory loggerFactory

Logger

log

protected final org.slf4j.Logger log

timeoutMs

protected volatile int timeoutMs

pathHelper

protected final PathHelper pathHelper

session

private final Session session

sub

protected final Session.Subsystem sub

reader

protected final PacketReader reader

out

protected final OutputStream out

reqID

protected long reqID

operativeVersion

protected int operativeVersion

serverExtensions

protected final Map<String,String> serverExtensions

Constructor Details

SFTPEngine

public SFTPEngine(SessionFactory ssh)
           throws SSHException

Throws:

SSHException

SFTPEngine

public SFTPEngine(SessionFactory ssh,
 String pathSep)
           throws SSHException

Throws:

SSHException

Method Details

init

public SFTPEngine init()
                throws IOException

Throws:

IOException

init

protected SFTPEngine init(int requestedVersion)
                   throws IOException

Introduced for internal use by testcases.

Parameters:

requestedVersion -

Throws:

IOException

getSubsystem

public Session.Subsystem getSubsystem()

getOperativeProtocolVersion

public int getOperativeProtocolVersion()

supportsServerExtension

public boolean supportsServerExtension(String extension,
 String domain)

getServerExtensionData

public String getServerExtensionData(String extension,
 String domain)

newExtendedRequest

public Request newExtendedRequest(String reqName)

getPathHelper

public PathHelper getPathHelper()

Specified by:

getPathHelper in interface Requester

newRequest

public Request newRequest(PacketType type)

Specified by:

newRequest in interface Requester

request

public Promise<Response,SFTPException> request(Request req)
                                        throws IOException

Specified by:

request in interface Requester

Throws:

IOException

doRequest

private Response doRequest(Request req)
                    throws IOException

Throws:

IOException

open

public RemoteFile open(String path,
 Set<OpenMode> modes,
 FileAttributes fa)
                throws IOException

Throws:

IOException

open

public RemoteFile open(String filename,
 Set<OpenMode> modes)
                throws IOException

Throws:

IOException

open

public RemoteFile open(String filename)
                throws IOException

Throws:

IOException

openDir

public RemoteDirectory openDir(String path)
                        throws IOException

Throws:

IOException

setAttributes

public void setAttributes(String path,
 FileAttributes attrs)
                   throws IOException

Throws:

IOException

readLink

public String readLink(String path)
                throws IOException

Throws:

IOException

makeDir

public void makeDir(String path,
 FileAttributes attrs)
             throws IOException

Throws:

IOException

makeDir

public void makeDir(String path)
             throws IOException

Throws:

IOException

symlink

public void symlink(String linkpath,
 String targetpath)
             throws IOException

Throws:

IOException

remove

public void remove(String filename)
            throws IOException

Throws:

IOException

removeDir

public void removeDir(String path)
               throws IOException

Throws:

IOException

stat

public FileAttributes stat(String path)
                    throws IOException

Throws:

IOException

lstat

public FileAttributes lstat(String path)
                     throws IOException

Throws:

IOException

rename

public void rename(String oldPath,
 String newPath,
 Set<RenameFlags> flags)
            throws IOException

Throws:

IOException

canonicalize

public String canonicalize(String path)
                    throws IOException

Throws:

IOException

setTimeoutMs

public void setTimeoutMs(int timeoutMs)

getTimeoutMs

public int getTimeoutMs()

Specified by:

getTimeoutMs in interface Requester

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getLoggerFactory

protected LoggerFactory getLoggerFactory()

stat

protected FileAttributes stat(PacketType pt,
 String path)
                       throws IOException

Throws:

IOException

readSingleNameAsBytes

private static byte[] readSingleNameAsBytes(Response res)
                                     throws IOException

Throws:

IOException

readSingleName

protected static String readSingleName(Response res)
                                throws IOException

Using UTF-8

Throws:

IOException

readSingleName

protected static String readSingleName(Response res,
 Charset charset)
                                throws IOException

Using any character set

Throws:

IOException

transmit

protected void transmit(SFTPPacket<Request> payload)
                 throws IOException

Throws:

IOException