net.sf.sshapi.sftp

Class AbstractSftpClient

java.lang.Object

net.sf.sshapi.AbstractLifecycleComponent

net.sf.sshapi.AbstractLifecycleComponentWithEvents

net.sf.sshapi.sftp.AbstractSftpClient

All Implemented Interfaces:

SftpClient, SshLifecycleComponent

public abstract class AbstractSftpClient
extends AbstractLifecycleComponentWithEvents
implements SftpClient

Abstract implementation of an SftpClient, providing some common methods. All provider implentations will probably want to exted this.

Constructor Summary

Constructors

Constructor and Description
AbstractSftpClient()

Method Summary

Modifier and Type	Method and Description
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, long filePointer) Retrieve the contents of a remote file, writing it to the provided output stream.
void	mkdirs(java.lang.String dir, int permissions) Default implementation of mkdirs(String, int) that uses SftpClient.mkdir(String, int).
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.

Methods inherited from class net.sf.sshapi.AbstractLifecycleComponentWithEvents

checkOpen, close, isOpen, onClose, onOpen, open

Methods inherited from class net.sf.sshapi.AbstractLifecycleComponent

addListener, fireClosed, fireClosing, fireOpened, getListeners, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.sshapi.sftp.SftpClient

chgrp, chmod, chown, get, getDefaultPath, ls, mkdir, put, rename, rm, rmdir, setLastModified, stat

Methods inherited from interface net.sf.sshapi.SshLifecycleComponent

addListener, close, isOpen, open, removeListener

Constructor Detail

AbstractSftpClient

public AbstractSftpClient()

Method Detail

mkdirs

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

Default implementation of mkdirs(String, int) that uses SftpClient.mkdir(String, int).

Specified by:

mkdirs in interface SftpClient

Parameters:

path - path

permissions - permissions

Throws:

SshException - on any error

get

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

Description copied from interface: SftpClient

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.

Specified by:

get in interface SftpClient

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

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

Description copied from interface: SftpClient

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.

Specified by:

get in interface SftpClient

Parameters:

path - path of remote file

filePointer - position to set filePointer to

Returns:

input stream

Throws:

SshException

See Also:

#get(String, OutputStream)}

get

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

Description copied from interface: SftpClient

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.

Specified by:

get in interface SftpClient

Parameters:

path - path of remote file

Returns:

input stream

Throws:

SshException

See Also:

#get(String, OutputStream)}

put

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

Description copied from interface: SftpClient

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.

Specified by:

put in interface SftpClient

Parameters:

path - path to save file to

permissions - permissions of file when created

Returns:

output stream

Throws:

SshException

put

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

Description copied from interface: SftpClient

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.

Specified by:

put in interface SftpClient

Parameters:

path - path to save file to

permissions - permissions of file when created

Returns:

output stream

Throws:

SshException