org.apache.commons.vfs2.provider.ftp

Class AbstractFtpClientWrapper

java.lang.Object

org.apache.commons.vfs2.provider.ftp.AbstractFtpClientWrapper

All Implemented Interfaces:

FtpClient

public abstract class AbstractFtpClientWrapper
extends Object
implements FtpClient

Base class with FTP client wrapper logic.

Constructor Summary

Constructors

Constructor and Description
AbstractFtpClientWrapper(GenericFileName root, FileSystemOptions fileSystemOptions, Integer defaultTimeout)

Method Summary

Modifier and Type	Method and Description
boolean	abort()
OutputStream	appendFileStream(String relPath)
boolean	completePendingCommand()
protected abstract org.apache.commons.net.ftp.FTPClient	createClient()
boolean	deleteFile(String relPath)
void	disconnect()
protected Integer	getDefaultTimeout()
FileSystemOptions	getFileSystemOptions()
String	getReplyString()
GenericFileName	getRoot()
boolean	isConnected()
org.apache.commons.net.ftp.FTPFile[]	listFiles(String relPath)
boolean	makeDirectory(String relPath)
boolean	removeDirectory(String relPath)
boolean	rename(String oldName, String newName)
InputStream	retrieveFileStream(String relPath)
InputStream	retrieveFileStream(String relPath, long restartOffset)
OutputStream	storeFileStream(String relPath)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFtpClientWrapper

public AbstractFtpClientWrapper(GenericFileName root,
                                FileSystemOptions fileSystemOptions,
                                Integer defaultTimeout)
                         throws FileSystemException

Throws:

FileSystemException

Method Detail

getRoot

public GenericFileName getRoot()

getFileSystemOptions

public FileSystemOptions getFileSystemOptions()

getDefaultTimeout

protected Integer getDefaultTimeout()

createClient

protected abstract org.apache.commons.net.ftp.FTPClient createClient()
                                                              throws FileSystemException

Throws:

FileSystemException

isConnected

public boolean isConnected()
                    throws FileSystemException

Specified by:

isConnected in interface FtpClient

Throws:

FileSystemException

disconnect

public void disconnect()
                throws IOException

Specified by:

disconnect in interface FtpClient

Throws:

IOException

listFiles

public org.apache.commons.net.ftp.FTPFile[] listFiles(String relPath)
                                               throws IOException

Specified by:

listFiles in interface FtpClient

Throws:

IOException

removeDirectory

public boolean removeDirectory(String relPath)
                        throws IOException

Specified by:

removeDirectory in interface FtpClient

Throws:

IOException

deleteFile

public boolean deleteFile(String relPath)
                   throws IOException

Specified by:

deleteFile in interface FtpClient

Throws:

IOException

rename

public boolean rename(String oldName,
                      String newName)
               throws IOException

Specified by:

rename in interface FtpClient

Throws:

IOException

makeDirectory

public boolean makeDirectory(String relPath)
                      throws IOException

Specified by:

makeDirectory in interface FtpClient

Throws:

IOException

completePendingCommand

public boolean completePendingCommand()
                               throws IOException

Specified by:

completePendingCommand in interface FtpClient

Throws:

IOException

retrieveFileStream

public InputStream retrieveFileStream(String relPath)
                               throws IOException

Specified by:

retrieveFileStream in interface FtpClient

Throws:

IOException

retrieveFileStream

public InputStream retrieveFileStream(String relPath,
                                      long restartOffset)
                               throws IOException

Specified by:

retrieveFileStream in interface FtpClient

Throws:

IOException

appendFileStream

public OutputStream appendFileStream(String relPath)
                              throws IOException

Specified by:

appendFileStream in interface FtpClient

Throws:

IOException

storeFileStream

public OutputStream storeFileStream(String relPath)
                             throws IOException

Specified by:

storeFileStream in interface FtpClient

Throws:

IOException

abort

public boolean abort()
              throws IOException

Specified by:

abort in interface FtpClient

Throws:

IOException

getReplyString

public String getReplyString()
                      throws IOException

Specified by:

getReplyString in interface FtpClient

Throws:

IOException