Package org.apache.commons.vfs2.provider.ftp

Class FTPClientWrapper

java.lang.Object

org.apache.commons.vfs2.provider.ftp.FTPClientWrapper

All Implemented Interfaces:

FtpClient

public class FTPClientWrapper
extends Object
implements FtpClient

A wrapper to the FTPClient to allow automatic reconnect on connection loss.

I decided to not to use eg. noop() to determine the state of the connection to avoid unnecessary server round-trips.

Field Summary

Fields

Modifier and Type	Field	Description
protected final FileSystemOptions	fileSystemOptions
private org.apache.commons.net.ftp.FTPClient	ftpClient
private static final org.apache.commons.logging.Log	LOG
private final GenericFileName	root

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FTPClientWrapper(GenericFileName root, FileSystemOptions fileSystemOptions)

Method Summary

Modifier and Type	Method	Description
boolean	abort()
OutputStream	appendFileStream(String relPath)
boolean	completePendingCommand()
private org.apache.commons.net.ftp.FTPClient	createClient()
protected org.apache.commons.net.ftp.FTPClient	createClient(GenericFileName rootName, UserAuthenticationData authData)
boolean	deleteFile(String relPath)
void	disconnect()
FileSystemOptions	getFileSystemOptions()
private org.apache.commons.net.ftp.FTPClient	getFtpClient()
int	getReplyCode()
String	getReplyString()
GenericFileName	getRoot()
boolean	hasFeature(String feature)	Queries the server for a supported feature.
boolean	isConnected()
org.apache.commons.net.ftp.FTPFile[]	listFiles(String relPath)
private org.apache.commons.net.ftp.FTPFile[]	listFilesInDirectory(String relPath)
boolean	makeDirectory(String relPath)
Instant	mdtmInstant(String relPath)	Sends the MDTM command to get a file's date and time information after file transfer.
boolean	removeDirectory(String relPath)
boolean	rename(String oldName, String newName)
InputStream	retrieveFileStream(String relPath)
InputStream	retrieveFileStream(String relPath, int bufferSize)
InputStream	retrieveFileStream(String relPath, long restartOffset)
void	setBufferSize(int bufferSize)
OutputStream	storeFileStream(String relPath)

Methods inherited from class java.lang.Object

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

Field Details

LOG

private static final org.apache.commons.logging.Log LOG

fileSystemOptions

protected final FileSystemOptions fileSystemOptions

ftpClient

private org.apache.commons.net.ftp.FTPClient ftpClient

root

private final GenericFileName root

Constructor Details

FTPClientWrapper

protected FTPClientWrapper(GenericFileName root,
 FileSystemOptions fileSystemOptions)
                    throws FileSystemException

Throws:

FileSystemException

Method Details

abort

public boolean abort()
              throws IOException

Specified by:

abort in interface FtpClient

Throws:

IOException

appendFileStream

public OutputStream appendFileStream(String relPath)
                              throws IOException

Specified by:

appendFileStream in interface FtpClient

Throws:

IOException

completePendingCommand

public boolean completePendingCommand()
                               throws IOException

Specified by:

completePendingCommand in interface FtpClient

Throws:

IOException

createClient

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

Throws:

FileSystemException

createClient

protected org.apache.commons.net.ftp.FTPClient createClient(GenericFileName rootName,
 UserAuthenticationData authData)
                                                     throws FileSystemException

Throws:

FileSystemException

deleteFile

public boolean deleteFile(String relPath)
                   throws IOException

Specified by:

deleteFile in interface FtpClient

Throws:

IOException

disconnect

public void disconnect()
                throws IOException

Specified by:

disconnect in interface FtpClient

Throws:

IOException

getFileSystemOptions

public FileSystemOptions getFileSystemOptions()

getFtpClient

private org.apache.commons.net.ftp.FTPClient getFtpClient()
                                                   throws FileSystemException

Throws:

FileSystemException

getReplyCode

public int getReplyCode()
                 throws IOException

Specified by:

getReplyCode in interface FtpClient

Throws:

IOException

getReplyString

public String getReplyString()
                      throws IOException

Specified by:

getReplyString in interface FtpClient

Throws:

IOException

getRoot

public GenericFileName getRoot()

hasFeature

public boolean hasFeature(String feature)
                   throws IOException

Queries the server for a supported feature.

Specified by:

hasFeature in interface FtpClient

Parameters:

feature - the name of the feature, converted to upper case.

Returns:

true if the feature is present, false if the feature is not present or the FTP command failed.

Throws:

IOException - on error

isConnected

public boolean isConnected()
                    throws FileSystemException

Specified by:

isConnected in interface FtpClient

Throws:

FileSystemException

listFiles

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

Specified by:

listFiles in interface FtpClient

Throws:

IOException

listFilesInDirectory

private org.apache.commons.net.ftp.FTPFile[] listFilesInDirectory(String relPath)
                                                           throws IOException

Throws:

IOException

makeDirectory

public boolean makeDirectory(String relPath)
                      throws IOException

Specified by:

makeDirectory in interface FtpClient

Throws:

IOException

mdtmInstant

public Instant mdtmInstant(String relPath)
                    throws IOException

Sends the MDTM command to get a file's date and time information after file transfer. It is typically more accurate than the "LIST" command response. Time values are always represented in UTC (GMT), and in the Gregorian calendar regardless of what calendar may have been in use at the date and time the file was last modified.

NOTE: not all remote FTP servers support MDTM.

Specified by:

mdtmInstant in interface FtpClient

Parameters:

relPath - The relative path of the file object to execute MDTM command against

Returns:

new Instant object containing the MDTM timestamp.

Throws:

IOException - If the underlying FTP client encountered an error.

removeDirectory

public boolean removeDirectory(String relPath)
                        throws IOException

Specified by:

removeDirectory in interface FtpClient

Throws:

IOException

rename

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

Specified by:

rename 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,
 int bufferSize)
                               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

setBufferSize

public void setBufferSize(int bufferSize)
                   throws FileSystemException

Specified by:

setBufferSize in interface FtpClient

Throws:

FileSystemException

storeFileStream

public OutputStream storeFileStream(String relPath)
                             throws IOException

Specified by:

storeFileStream in interface FtpClient

Throws:

IOException