org.apache.sshd.client.subsystem.sftp

Class AbstractSftpClient

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.client.subsystem.sftp.AbstractSftpClient

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, RawSftpClient, SftpClient, SubsystemClient, NamedResource

Direct Known Subclasses:

DefaultSftpClient

public abstract class AbstractSftpClient
extends AbstractLoggingBean
implements SftpClient, RawSftpClient

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.sshd.client.subsystem.sftp.SftpClient

SftpClient.Attribute, SftpClient.Attributes, SftpClient.CloseableHandle, SftpClient.CopyMode, SftpClient.DirEntry, SftpClient.Handle, SftpClient.OpenMode

Nested classes/interfaces inherited from interface org.apache.sshd.common.NamedResource

NamedResource.Utils

Field Summary

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.apache.sshd.client.subsystem.sftp.SftpClient

DEFAULT_CHANNEL_OPEN_TIMEOUT, DEFAULT_READ_BUFFER_SIZE, DEFAULT_WAIT_TIMEOUT, DEFAULT_WRITE_BUFFER_SIZE, IO_BUFFER_SIZE, MIN_BUFFER_SIZE, MIN_READ_BUFFER_SIZE, MIN_WRITE_BUFFER_SIZE, SFTP_CHANNEL_OPEN_TIMEOUT

Fields inherited from interface org.apache.sshd.common.NamedResource

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSftpClient()

Method Summary

Modifier and Type	Method and Description
String	canonicalPath(String path)
protected SftpClient.Attributes	checkAttributes(Buffer buffer)
protected SftpClient.Attributes	checkAttributes(int cmd, Buffer request)
protected int	checkData(Buffer buffer, int dstoff, byte[] dst)
protected int	checkData(int cmd, Buffer request, int dstOffset, byte[] dst)
protected List<SftpClient.DirEntry>	checkDir(Buffer buffer)
protected byte[]	checkHandle(Buffer buffer)
protected byte[]	checkHandle(int cmd, Buffer request)
protected String	checkOneName(Buffer buffer)
protected String	checkOneName(int cmd, Buffer request)
protected void	checkStatus(Buffer buffer) Checks if the incoming response is an SSH_FXP_STATUS one, and if so whether the substatus is SSH_FX_OK.
protected void	checkStatus(int cmd, Buffer request) Sends the specified command, waits for the response and then invokes checkStatus(Buffer)
protected void	checkStatus(int id, int substatus, String msg, String lang)
void	close(SftpClient.Handle handle)
<E extends SftpClientExtension> E	getExtension(Class<? extends E> extensionType)
protected SftpClientExtension	getExtension(SftpClientExtensionFactory factory)
SftpClientExtension	getExtension(String extensionName)
String	getName()
protected Map<String,Object>	getParsedServerExtensions()
protected Map<String,Object>	getParsedServerExtensions(Map<String,byte[]> extensions)
void	link(String linkPath, String targetPath, boolean symbolic)
void	lock(SftpClient.Handle handle, long offset, long length, int mask)
SftpClient.Attributes	lstat(String path)
void	mkdir(String path)
SftpClient.CloseableHandle	open(String path) Opens a remote file for read
SftpClient.CloseableHandle	open(String path, Collection<SftpClient.OpenMode> options) Opens a remote file with the specified mode(s)
SftpClient.CloseableHandle	open(String path, SftpClient.OpenMode... options) Opens a remote file with the specified mode(s)
SftpClient.CloseableHandle	openDir(String path)
int	read(SftpClient.Handle handle, long fileOffset, byte[] dst)
int	read(SftpClient.Handle handle, long fileOffset, byte[] dst, int dstOffset, int len)
InputStream	read(String path)
InputStream	read(String path, Collection<SftpClient.OpenMode> mode)
InputStream	read(String path, int bufferSize)
InputStream	read(String path, int bufferSize, Collection<SftpClient.OpenMode> mode)
InputStream	read(String path, int bufferSize, SftpClient.OpenMode... mode)
InputStream	read(String path, SftpClient.OpenMode... mode)
protected SftpClient.Attributes	readAttributes(Buffer buffer)
List<SftpClient.DirEntry>	readDir(SftpClient.Handle handle)
Iterable<SftpClient.DirEntry>	readDir(String path)
String	readLink(String path)
protected FileTime	readTime(Buffer buffer, int flags)
void	remove(String path)
void	rename(String oldPath, String newPath)
void	rename(String oldPath, String newPath, Collection<SftpClient.CopyMode> options)
void	rename(String oldPath, String newPath, SftpClient.CopyMode... options)
void	rmdir(String path)
void	setStat(SftpClient.Handle handle, SftpClient.Attributes attributes)
void	setStat(String path, SftpClient.Attributes attributes)
SftpClient.Attributes	stat(SftpClient.Handle handle)
SftpClient.Attributes	stat(String path)
void	symLink(String linkPath, String targetPath)
protected void	throwStatusException(int id, int substatus, String msg, String lang)
void	unlock(SftpClient.Handle handle, long offset, long length)
void	write(SftpClient.Handle handle, long fileOffset, byte[] src)
void	write(SftpClient.Handle handle, long fileOffset, byte[] src, int srcOffset, int len)
OutputStream	write(String path)
OutputStream	write(String path, Collection<SftpClient.OpenMode> mode)
OutputStream	write(String path, int bufferSize)
OutputStream	write(String path, int bufferSize, Collection<SftpClient.OpenMode> mode)
OutputStream	write(String path, int bufferSize, SftpClient.OpenMode... mode)
OutputStream	write(String path, SftpClient.OpenMode... mode)
protected void	writeAttributes(Buffer buffer, SftpClient.Attributes attributes)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.client.subsystem.sftp.SftpClient

getServerExtensions, getVersion, isClosing

Methods inherited from interface org.apache.sshd.client.subsystem.SubsystemClient

getClientSession

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Methods inherited from interface org.apache.sshd.client.subsystem.sftp.RawSftpClient

receive, send

Constructor Detail

AbstractSftpClient

protected AbstractSftpClient()

Method Detail

getName

public String getName()

Specified by:

getName in interface NamedResource

Returns:

The resource name

open

public SftpClient.CloseableHandle open(String path)
                                throws IOException

Description copied from interface: SftpClient

Opens a remote file for read

Specified by:

open in interface SftpClient

Parameters:

path - The remote path

Returns:

The file's SftpClient.CloseableHandle

Throws:

IOException - If failed to open the remote file

open

public SftpClient.CloseableHandle open(String path,
                                       SftpClient.OpenMode... options)
                                throws IOException

Description copied from interface: SftpClient

Opens a remote file with the specified mode(s)

Specified by:

open in interface SftpClient

Parameters:

path - The remote path

options - The desired mode - if none specified then SftpClient.OpenMode.Read is assumed

Returns:

The file's SftpClient.CloseableHandle

Throws:

IOException - If failed to open the remote file

rename

public void rename(String oldPath,
                   String newPath)
            throws IOException

Specified by:

rename in interface SftpClient

Throws:

IOException

rename

public void rename(String oldPath,
                   String newPath,
                   SftpClient.CopyMode... options)
            throws IOException

Specified by:

rename in interface SftpClient

Throws:

IOException

read

public InputStream read(String path)
                 throws IOException

Specified by:

read in interface SftpClient

Throws:

IOException

read

public InputStream read(String path,
                        int bufferSize)
                 throws IOException

Specified by:

read in interface SftpClient

Throws:

IOException

read

public InputStream read(String path,
                        SftpClient.OpenMode... mode)
                 throws IOException

Specified by:

read in interface SftpClient

Throws:

IOException

read

public InputStream read(String path,
                        int bufferSize,
                        SftpClient.OpenMode... mode)
                 throws IOException

Specified by:

read in interface SftpClient

Throws:

IOException

read

public InputStream read(String path,
                        Collection<SftpClient.OpenMode> mode)
                 throws IOException

Specified by:

read in interface SftpClient

Throws:

IOException

read

public int read(SftpClient.Handle handle,
                long fileOffset,
                byte[] dst)
         throws IOException

Specified by:

read in interface SftpClient

Throws:

IOException

write

public OutputStream write(String path)
                   throws IOException

Specified by:

write in interface SftpClient

Throws:

IOException

write

public OutputStream write(String path,
                          int bufferSize)
                   throws IOException

Specified by:

write in interface SftpClient

Throws:

IOException

write

public OutputStream write(String path,
                          SftpClient.OpenMode... mode)
                   throws IOException

Specified by:

write in interface SftpClient

Throws:

IOException

write

public OutputStream write(String path,
                          Collection<SftpClient.OpenMode> mode)
                   throws IOException

Specified by:

write in interface SftpClient

Throws:

IOException

write

public OutputStream write(String path,
                          int bufferSize,
                          SftpClient.OpenMode... mode)
                   throws IOException

Specified by:

write in interface SftpClient

Throws:

IOException

write

public void write(SftpClient.Handle handle,
                  long fileOffset,
                  byte[] src)
           throws IOException

Specified by:

write in interface SftpClient

Throws:

IOException

symLink

public void symLink(String linkPath,
                    String targetPath)
             throws IOException

Specified by:

symLink in interface SftpClient

Throws:

IOException

getExtension

public <E extends SftpClientExtension> E getExtension(Class<? extends E> extensionType)

Specified by:

getExtension in interface SftpClient

Type Parameters:

E - The generic extension type

Parameters:

extensionType - The extension type

Returns:

The extension instance - Note: it is up to the caller to invoke OptionalFeature.isSupported() - null if this extension type is not implemented by the client

See Also:

SftpClient.getServerExtensions()

getExtension

public SftpClientExtension getExtension(String extensionName)

Specified by:

getExtension in interface SftpClient

Parameters:

extensionName - The extension name

Returns:

The extension instance - Note: it is up to the caller to invoke OptionalFeature.isSupported() - null if this extension type is not implemented by the client

See Also:

SftpClient.getServerExtensions()

getExtension

protected SftpClientExtension getExtension(SftpClientExtensionFactory factory)

getParsedServerExtensions

protected Map<String,Object> getParsedServerExtensions()

getParsedServerExtensions

protected Map<String,Object> getParsedServerExtensions(Map<String,byte[]> extensions)

checkStatus

protected void checkStatus(int cmd,
                           Buffer request)
                    throws IOException

Sends the specified command, waits for the response and then invokes checkStatus(Buffer)

Parameters:

cmd - The command to send

request - The request Buffer

Throws:

IOException - If failed to send, receive or check the returned status

See Also:

RawSftpClient.send(int, Buffer), RawSftpClient.receive(int), checkStatus(Buffer)

checkStatus

protected void checkStatus(Buffer buffer)
                    throws IOException

Checks if the incoming response is an SSH_FXP_STATUS one, and if so whether the substatus is SSH_FX_OK.

Parameters:

buffer - The received response Buffer

Throws:

IOException - If response does not carry a status or carries a bad status code

See Also:

checkStatus(int, int, String, String)

checkStatus

protected void checkStatus(int id,
                           int substatus,
                           String msg,
                           String lang)
                    throws IOException

Parameters:

id - The request id

substatus - The sub-status value

msg - The message

lang - The language

Throws:

IOException - if the sub-status is not SSH_FX_OK

See Also:

throwStatusException(int, int, String, String)

throwStatusException

protected void throwStatusException(int id,
                                    int substatus,
                                    String msg,
                                    String lang)
                             throws IOException

Throws:

IOException

checkHandle

protected byte[] checkHandle(int cmd,
                             Buffer request)
                      throws IOException

Parameters:

cmd - Command to be sent

request - The Buffer containing the request

Returns:

The received handle identifier

Throws:

IOException - If failed to send/receive or process the response

See Also:

RawSftpClient.send(int, Buffer), RawSftpClient.receive(int), checkHandle(Buffer)

checkHandle

protected byte[] checkHandle(Buffer buffer)
                      throws IOException

Throws:

IOException

checkAttributes

protected SftpClient.Attributes checkAttributes(int cmd,
                                                Buffer request)
                                         throws IOException

Parameters:

cmd - Command to be sent

request - Request Buffer

Returns:

The decoded response Attributes

Throws:

IOException - If failed to send/receive or process the response

See Also:

RawSftpClient.send(int, Buffer), RawSftpClient.receive(int), checkAttributes(Buffer)

checkAttributes

protected SftpClient.Attributes checkAttributes(Buffer buffer)
                                         throws IOException

Throws:

IOException

checkOneName

protected String checkOneName(int cmd,
                              Buffer request)
                       throws IOException

Parameters:

cmd - Command to be sent

request - The request Buffer

Returns:

The retrieve name

Throws:

IOException - If failed to send/receive or process the response

See Also:

RawSftpClient.send(int, Buffer), RawSftpClient.receive(int), checkOneName(Buffer)

checkOneName

protected String checkOneName(Buffer buffer)
                       throws IOException

Throws:

IOException

readAttributes

protected SftpClient.Attributes readAttributes(Buffer buffer)
                                        throws IOException

Throws:

IOException

readTime

protected FileTime readTime(Buffer buffer,
                            int flags)

writeAttributes

protected void writeAttributes(Buffer buffer,
                               SftpClient.Attributes attributes)
                        throws IOException

Throws:

IOException

open

public SftpClient.CloseableHandle open(String path,
                                       Collection<SftpClient.OpenMode> options)
                                throws IOException

Description copied from interface: SftpClient

Opens a remote file with the specified mode(s)

Specified by:

open in interface SftpClient

Parameters:

path - The remote path

options - The desired mode - if none specified then SftpClient.OpenMode.Read is assumed

Returns:

The file's SftpClient.CloseableHandle

Throws:

IOException - If failed to open the remote file

close

public void close(SftpClient.Handle handle)
           throws IOException

Specified by:

close in interface SftpClient

Throws:

IOException

remove

public void remove(String path)
            throws IOException

Specified by:

remove in interface SftpClient

Throws:

IOException

rename

public void rename(String oldPath,
                   String newPath,
                   Collection<SftpClient.CopyMode> options)
            throws IOException

Specified by:

rename in interface SftpClient

Throws:

IOException

read

public int read(SftpClient.Handle handle,
                long fileOffset,
                byte[] dst,
                int dstOffset,
                int len)
         throws IOException

Specified by:

read in interface SftpClient

Throws:

IOException

checkData

protected int checkData(int cmd,
                        Buffer request,
                        int dstOffset,
                        byte[] dst)
                 throws IOException

Throws:

IOException

checkData

protected int checkData(Buffer buffer,
                        int dstoff,
                        byte[] dst)
                 throws IOException

Throws:

IOException

write

public void write(SftpClient.Handle handle,
                  long fileOffset,
                  byte[] src,
                  int srcOffset,
                  int len)
           throws IOException

Specified by:

write in interface SftpClient

Throws:

IOException

mkdir

public void mkdir(String path)
           throws IOException

Specified by:

mkdir in interface SftpClient

Throws:

IOException

rmdir

public void rmdir(String path)
           throws IOException

Specified by:

rmdir in interface SftpClient

Throws:

IOException

openDir

public SftpClient.CloseableHandle openDir(String path)
                                   throws IOException

Specified by:

openDir in interface SftpClient

Throws:

IOException

readDir

public List<SftpClient.DirEntry> readDir(SftpClient.Handle handle)
                                  throws IOException

Specified by:

readDir in interface SftpClient

Parameters:

handle - Directory SftpClient.Handle to read from

Returns:

A List of entries - null to indicate no more entries Note: the list may be incomplete since the client and server have some internal imposed limit on the number of entries they can process. Therefore several calls to this method may be required (until null). In order to iterate over all the entries use SftpClient.readDir(String)

Throws:

IOException - If failed to access the remote site

checkDir

protected List<SftpClient.DirEntry> checkDir(Buffer buffer)
                                      throws IOException

Throws:

IOException

canonicalPath

public String canonicalPath(String path)
                     throws IOException

Specified by:

canonicalPath in interface SftpClient

Throws:

IOException

stat

public SftpClient.Attributes stat(String path)
                           throws IOException

Specified by:

stat in interface SftpClient

Throws:

IOException

lstat

public SftpClient.Attributes lstat(String path)
                            throws IOException

Specified by:

lstat in interface SftpClient

Throws:

IOException

stat

public SftpClient.Attributes stat(SftpClient.Handle handle)
                           throws IOException

Specified by:

stat in interface SftpClient

Throws:

IOException

setStat

public void setStat(String path,
                    SftpClient.Attributes attributes)
             throws IOException

Specified by:

setStat in interface SftpClient

Throws:

IOException

setStat

public void setStat(SftpClient.Handle handle,
                    SftpClient.Attributes attributes)
             throws IOException

Specified by:

setStat in interface SftpClient

Throws:

IOException

readLink

public String readLink(String path)
                throws IOException

Specified by:

readLink in interface SftpClient

Throws:

IOException

link

public void link(String linkPath,
                 String targetPath,
                 boolean symbolic)
          throws IOException

Specified by:

link in interface SftpClient

Throws:

IOException

lock

public void lock(SftpClient.Handle handle,
                 long offset,
                 long length,
                 int mask)
          throws IOException

Specified by:

lock in interface SftpClient

Throws:

IOException

unlock

public void unlock(SftpClient.Handle handle,
                   long offset,
                   long length)
            throws IOException

Specified by:

unlock in interface SftpClient

Throws:

IOException

readDir

public Iterable<SftpClient.DirEntry> readDir(String path)
                                      throws IOException

Specified by:

readDir in interface SftpClient

Parameters:

path - The remote directory path

Returns:

An Iterable that can be used to iterate over all the directory entries (unlike SftpClient.readDir(Handle))

Throws:

IOException - If failed to access the remote site

See Also:

SftpClient.readDir(Handle)

read

public InputStream read(String path,
                        int bufferSize,
                        Collection<SftpClient.OpenMode> mode)
                 throws IOException

Specified by:

read in interface SftpClient

Throws:

IOException

write

public OutputStream write(String path,
                          int bufferSize,
                          Collection<SftpClient.OpenMode> mode)
                   throws IOException

Specified by:

write in interface SftpClient

Throws:

IOException