net.sf.sshapi.sftp

Interface SftpClient

All Superinterfaces:

SshLifecycleComponent

All Known Implementing Classes:

AbstractSftpClient

public interface SftpClient
extends SshLifecycleComponent

Providers will create an instance of an implementation of this interface to access the SFTP system. All paths provides should be fully qualified. Some providers internally may provide 'pwd' and 'cd' like functionality, but as not all do SSHAPI does NOT expose this.

See Also:

SshClient#createSftpClient()

Method Summary

Modifier and Type	Method and Description
void	chgrp(java.lang.String path, int gid) Change the owning group of a remote file.
void	chmod(java.lang.String path, int permissions) Change the permission of a remove file.
void	chown(java.lang.String path, int uid) Change the owner of a remote file.
java.io.InputStream	get(java.lang.String path) Retrieve the contents of a remote file, presenting it as an input stream.
java.io.InputStream	get(java.lang.String path, long filePointer) Retrieve the contents of a remote file, presenting it as an input stream.
void	get(java.lang.String path, java.io.OutputStream out) Retrieve the contents of a remote file, writing it to the provided output stream.
void	get(java.lang.String path, java.io.OutputStream out, long filePointer) Retrieve the contents of a remote file, writing it to the provided output stream.
java.lang.String	getDefaultPath() Get the default path
SftpFile[]	ls(java.lang.String path) List a directory.
void	mkdir(java.lang.String path, int permissions) Create a directory.
void	mkdirs(java.lang.String path, int permissions) Create a directory, creating missing parents.
void	put(java.lang.String path, java.io.InputStream in, int permissions) Write to a remote from the provided input stream.
java.io.OutputStream	put(java.lang.String path, int permissions) Open a remote file for writing to.
java.io.OutputStream	put(java.lang.String path, int permissions, long offset) Open a remote file for writing to.
void	rename(java.lang.String path, java.lang.String newPath) Rename or move a file.
void	rm(java.lang.String path) Remove a file given it's path.
void	rmdir(java.lang.String path) Remove a directory given it's path.
void	setLastModified(java.lang.String path, long modtime) Set the last modified time of a file.
SftpFile	stat(java.lang.String path) Get an SFTP file object (containing all of it's attributes) given a path in the remote file system.

Methods inherited from interface net.sf.sshapi.SshLifecycleComponent

addListener, close, isOpen, open, removeListener

Method Detail

ls

SftpFile[] ls(java.lang.String path)
       throws SshException

List a directory.

Parameters:

path - directory to list

Returns:

files contain in directory

Throws:

SshException

getDefaultPath

java.lang.String getDefaultPath()
                         throws SshException

Get the default path

Returns:

default path

Throws:

SshException

stat

SftpFile stat(java.lang.String path)
       throws SshException

Get an SFTP file object (containing all of it's attributes) given a path in the remote file system.

Parameters:

path - path

Returns:

file object

Throws:

SshException

mkdir

void mkdir(java.lang.String path,
           int permissions)
    throws SshException

Create a directory. If any element of the parent path does not exist an exception will be thrown.

Parameters:

path - path of directory to create.

permissions - permissions

Throws:

SshException

mkdirs

void mkdirs(java.lang.String path,
            int permissions)
     throws SshException

Create a directory, creating missing parents. If any element of the parent path does not exist it will be created.

Parameters:

path - path of directory to create.

permissions - permissions

Throws:

SshException

rm

void rm(java.lang.String path)
 throws SshException

Remove a file given it's path. If the path is a directory, use rmdir(String) instead.

Parameters:

path - path of file to remove.

Throws:

SshException

rmdir

void rmdir(java.lang.String path)
    throws SshException

Remove a directory given it's path.

Parameters:

path - path of directory to remove.

Throws:

SshException

rename

void rename(java.lang.String path,
            java.lang.String newPath)
     throws SshException

Rename or move a file. If a file or folder on the remove system is on a different file system, a move may not be possible.

Parameters:

path - path of file or directory to rename or move.

newPath - new path of file or directry

Throws:

SshException

get

void get(java.lang.String path,
         java.io.OutputStream out)
  throws SshException

Retrieve the contents of a remote file, writing it to the provided output stream. This method will block until all data has been received.

Parameters:

path - path of remote file

out - output stream to write data to

Throws:

SshException

See Also:

#get(String)}

get

void get(java.lang.String path,
         java.io.OutputStream out,
         long filePointer)
  throws SshException

Retrieve the contents of a remote file, writing it to the provided output stream. This method will block until all data has been received. A file pointer should be provided indicating the position in the file to start the stream. This may be used to 'resume' downloads.

If the provider doesn't support setting the file pointer, an exception will be thrown.

Parameters:

path - path of remote file

out - output stream to write data to

filePointer - position to set filePointer to

Throws:

SshException

See Also:

#get(String)}

get

java.io.InputStream get(java.lang.String path)
                 throws SshException

Retrieve the contents of a remote file, presenting it as an input stream. This method will return immediately for the input stream to be read. Remember to close the input stream when you are done with it.

Parameters:

path - path of remote file

Returns:

input stream

Throws:

SshException

See Also:

#get(String, OutputStream)}

get

java.io.InputStream get(java.lang.String path,
                        long filePointer)
                 throws SshException

Retrieve the contents of a remote file, presenting it as an input stream. This method will return immediately for the input stream to be read. Remember to close the input stream when you are done with it. A file pointer should be provided indicating the position in the file to start the stream. This may be used to 'resume' downloads.

If the provider doesn't support setting the file pointer, an exception will be thrown.

Parameters:

path - path of remote file

filePointer - position to set filePointer to

Returns:

input stream

Throws:

SshException

java.lang.UnsupportedOperationException - uoe

See Also:

#get(String, OutputStream)}

put

void put(java.lang.String path,
         java.io.InputStream in,
         int permissions)
  throws SshException

Write to a remote from the provided input stream. This method will block until the input stream reports EOF. Note, it is up to the caller to close the input stream when complete.

Parameters:

path - path to save file to

in - input stream providing content

permissions - permissions of file when created

Throws:

SshException

put

java.io.OutputStream put(java.lang.String path,
                         int permissions,
                         long offset)
                  throws SshException

Open a remote file for writing to. This method will return immediately, with any bytes written to the returned output stream written to the remote file. A file pointer should be provided indicating the position in the file to start writing. This may be used to 'resume' uploads.

Parameters:

path - path to save file to

permissions - permissions of file when created

filePointer - position to set filePointer to

Returns:

output stream

Throws:

SshException

put

java.io.OutputStream put(java.lang.String path,
                         int permissions)
                  throws SshException

Open a remote file for writing to. This method will return immediately, with any bytes written to the returned output stream written to the remote file.

Parameters:

path - path to save file to

permissions - permissions of file when created

Returns:

output stream

Throws:

SshException

chmod

void chmod(java.lang.String path,
           int permissions)
    throws SshException

Change the permission of a remove file.

Parameters:

path - path of remote file

permissions - permissions

Throws:

SshException

chown

void chown(java.lang.String path,
           int uid)
    throws SshException

Change the owner of a remote file.

Parameters:

path - path of remote file

uid - new UID

Throws:

SshException

chgrp

void chgrp(java.lang.String path,
           int gid)
    throws SshException

Change the owning group of a remote file.

Parameters:

path - path of remote file

gid - new GID

Throws:

SshException

setLastModified

void setLastModified(java.lang.String path,
                     long modtime)
              throws SshException

Set the last modified time of a file.

Parameters:

path -

modtime - last modified time in milliseconds since 00:00:00, Jan 1st 1970.

Throws:

SshException