Interface FtpClient

All Known Implementing Classes:

FTPClientWrapper

public interface FtpClient

What VFS expects from an FTP client to provide.

Method Summary

Modifier and Type	Method	Description
boolean	abort()
OutputStream	appendFileStream(String relPath)
boolean	completePendingCommand()
boolean	deleteFile(String relPath)
void	disconnect()
default int	getReplyCode()
String	getReplyString()
boolean	hasFeature(String feature)	Queries the server for a supported feature.
boolean	isConnected()
org.apache.commons.net.ftp.FTPFile[]	listFiles(String relPath)
boolean	makeDirectory(String relPath)
default 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)
default InputStream	retrieveFileStream(String relPath, int bufferSize)
InputStream	retrieveFileStream(String relPath, long restartOffset)
default void	setBufferSize(int bufferSize)
OutputStream	storeFileStream(String relPath)

Method Details

abort

boolean abort()
       throws IOException

Throws:

IOException

appendFileStream

OutputStream appendFileStream(String relPath)
                       throws IOException

Throws:

IOException

completePendingCommand

boolean completePendingCommand()
                        throws IOException

Throws:

IOException

deleteFile

boolean deleteFile(String relPath)
            throws IOException

Throws:

IOException

disconnect

void disconnect()
         throws IOException

Throws:

IOException

getReplyCode

default int getReplyCode()
                  throws IOException

Throws:

IOException

getReplyString

String getReplyString()
               throws IOException

Throws:

IOException

hasFeature

boolean hasFeature(String feature)
            throws IOException

Queries the server for a supported feature.

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

Since:

2.8.0

isConnected

boolean isConnected()
             throws FileSystemException

Throws:

FileSystemException

listFiles

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

Throws:

IOException

makeDirectory

boolean makeDirectory(String relPath)
               throws IOException

Throws:

IOException

mdtmInstant

default 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.

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.

Since:

2.8.0

removeDirectory

boolean removeDirectory(String relPath)
                 throws IOException

Throws:

IOException

rename

boolean rename(String oldName,
 String newName)
        throws IOException

Throws:

IOException

retrieveFileStream

InputStream retrieveFileStream(String relPath)
                        throws IOException

Throws:

IOException

retrieveFileStream

default InputStream retrieveFileStream(String relPath,
 int bufferSize)
                                throws IOException

Throws:

IOException

retrieveFileStream

InputStream retrieveFileStream(String relPath,
 long restartOffset)
                        throws IOException

Throws:

IOException

setBufferSize

default void setBufferSize(int bufferSize)
                    throws FileSystemException

Throws:

FileSystemException

storeFileStream

OutputStream storeFileStream(String relPath)
                      throws IOException

Throws:

IOException