org.apache.sshd.client.subsystem.sftp

Interface SftpClient

All Superinterfaces:

AutoCloseable, Channel, Closeable, NamedResource, SubsystemClient

All Known Implementing Classes:

AbstractSftpClient, DefaultSftpClient

public interface SftpClient
extends SubsystemClient

Author:

Apache MINA Project

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SftpClient.Attribute
static class	SftpClient.Attributes
static class	SftpClient.CloseableHandle
static class	SftpClient.CopyMode
static class	SftpClient.DirEntry
static class	SftpClient.Handle
static class	SftpClient.OpenMode

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

NamedResource.Utils

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_CHANNEL_OPEN_TIMEOUT
static int	DEFAULT_READ_BUFFER_SIZE
static long	DEFAULT_WAIT_TIMEOUT
static int	DEFAULT_WRITE_BUFFER_SIZE
static int	IO_BUFFER_SIZE
static int	MIN_BUFFER_SIZE
static int	MIN_READ_BUFFER_SIZE
static int	MIN_WRITE_BUFFER_SIZE
static String	SFTP_CHANNEL_OPEN_TIMEOUT Property that can be used on the FactoryManager to control the internal timeout used by the client to open a channel.

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

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Method Summary

Modifier and Type	Method and Description
String	canonicalPath(String path)
void	close(SftpClient.Handle handle)
<E extends SftpClientExtension> E	getExtension(Class<? extends E> extensionType)
SftpClientExtension	getExtension(String extensionName)
Map<String,byte[]>	getServerExtensions()
int	getVersion()
boolean	isClosing()
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)
List<SftpClient.DirEntry>	readDir(SftpClient.Handle handle)
Iterable<SftpClient.DirEntry>	readDir(String path)
String	readLink(String path)
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)
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)

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

getClientSession

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

getName

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Field Detail

MIN_BUFFER_SIZE

static final int MIN_BUFFER_SIZE

See Also:

Constant Field Values

MIN_READ_BUFFER_SIZE

static final int MIN_READ_BUFFER_SIZE

See Also:

Constant Field Values

MIN_WRITE_BUFFER_SIZE

static final int MIN_WRITE_BUFFER_SIZE

See Also:

Constant Field Values

IO_BUFFER_SIZE

static final int IO_BUFFER_SIZE

See Also:

Constant Field Values

DEFAULT_READ_BUFFER_SIZE

static final int DEFAULT_READ_BUFFER_SIZE

See Also:

Constant Field Values

DEFAULT_WRITE_BUFFER_SIZE

static final int DEFAULT_WRITE_BUFFER_SIZE

See Also:

Constant Field Values

DEFAULT_WAIT_TIMEOUT

static final long DEFAULT_WAIT_TIMEOUT

SFTP_CHANNEL_OPEN_TIMEOUT

static final String SFTP_CHANNEL_OPEN_TIMEOUT

Property that can be used on the FactoryManager to control the internal timeout used by the client to open a channel. If not specified then DEFAULT_CHANNEL_OPEN_TIMEOUT value is used

See Also:

Constant Field Values

DEFAULT_CHANNEL_OPEN_TIMEOUT

static final long DEFAULT_CHANNEL_OPEN_TIMEOUT

Method Detail

getVersion

int getVersion()

getServerExtensions

Map<String,byte[]> getServerExtensions()

Returns:

An (unmodifiable) Map of the reported server extensions.

isClosing

boolean isClosing()

open

SftpClient.CloseableHandle open(String path)
                         throws IOException

Opens a remote file for read

Parameters:

path - The remote path

Returns:

The file's SftpClient.CloseableHandle

Throws:

IOException - If failed to open the remote file

open

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

Opens a remote file with the specified mode(s)

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

open

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

Opens a remote file with the specified mode(s)

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

void close(SftpClient.Handle handle)
    throws IOException

Throws:

IOException

remove

void remove(String path)
     throws IOException

Throws:

IOException

rename

void rename(String oldPath,
            String newPath)
     throws IOException

Throws:

IOException

rename

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

Throws:

IOException

rename

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

Throws:

IOException

read

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

Throws:

IOException

read

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

Throws:

IOException

write

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

Throws:

IOException

write

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

Throws:

IOException

mkdir

void mkdir(String path)
    throws IOException

Throws:

IOException

rmdir

void rmdir(String path)
    throws IOException

Throws:

IOException

openDir

SftpClient.CloseableHandle openDir(String path)
                            throws IOException

Throws:

IOException

readDir

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

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 readDir(String)

Throws:

IOException - If failed to access the remote site

canonicalPath

String canonicalPath(String path)
              throws IOException

Throws:

IOException

stat

SftpClient.Attributes stat(String path)
                    throws IOException

Throws:

IOException

lstat

SftpClient.Attributes lstat(String path)
                     throws IOException

Throws:

IOException

stat

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

Throws:

IOException

setStat

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

Throws:

IOException

setStat

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

Throws:

IOException

readLink

String readLink(String path)
         throws IOException

Throws:

IOException

symLink

void symLink(String linkPath,
             String targetPath)
      throws IOException

Throws:

IOException

link

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

Throws:

IOException

lock

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

Throws:

IOException

unlock

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

Throws:

IOException

readDir

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

Parameters:

path - The remote directory path

Returns:

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

Throws:

IOException - If failed to access the remote site

See Also:

readDir(Handle)

read

InputStream read(String path)
          throws IOException

Throws:

IOException

read

InputStream read(String path,
                 int bufferSize)
          throws IOException

Throws:

IOException

read

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

Throws:

IOException

read

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

Throws:

IOException

read

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

Throws:

IOException

read

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

Throws:

IOException

write

OutputStream write(String path)
            throws IOException

Throws:

IOException

write

OutputStream write(String path,
                   int bufferSize)
            throws IOException

Throws:

IOException

write

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

Throws:

IOException

write

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

Throws:

IOException

write

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

Throws:

IOException

write

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

Throws:

IOException

getExtension

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

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:

getServerExtensions()

getExtension

SftpClientExtension getExtension(String extensionName)

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:

getServerExtensions()