org.springframework.integration.ftp.session

Class FtpRemoteFileTemplate

java.lang.Object

org.springframework.integration.file.remote.RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile>

org.springframework.integration.ftp.session.FtpRemoteFileTemplate

All Implemented Interfaces:

Aware, BeanFactoryAware, InitializingBean, RemoteFileOperations<org.apache.commons.net.ftp.FTPFile>

public class FtpRemoteFileTemplate
extends RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile>

FTP version of RemoteFileTemplate providing type-safe access to the underlying FTPClient object.

Since:

4.1

Author:

Gary Russell, Artem Bilan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FtpRemoteFileTemplate.ExistsMode The exists(String) operation mode.

Nested classes/interfaces inherited from interface org.springframework.integration.file.remote.RemoteFileOperations

RemoteFileOperations.OperationsCallback<F,T>

Field Summary

Fields inherited from class org.springframework.integration.file.remote.RemoteFileTemplate

sessionFactory

Constructor Summary

Constructors

Constructor and Description
FtpRemoteFileTemplate(SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory)

Method Summary

Modifier and Type	Method and Description
protected <T> T	doExecuteWithClient(ClientCallback<org.apache.commons.net.ftp.FTPClient,T> callback)
<T,C> T	executeWithClient(ClientCallback<C,T> callback) Execute the callback's doWithClient method after obtaining a session's client, providing access to low level methods.
boolean	exists(String path) This particular FTP implementation is based on the FTPClient.getStatus(String) by default, but since not all FTP servers properly implement the STAT command, the framework internal FtpRemoteFileTemplate instances are switched to the FTPClient.listNames(String) for only files operations.
void	setExistsMode(FtpRemoteFileTemplate.ExistsMode existsMode) Specify an FtpRemoteFileTemplate.ExistsMode for exists(String) operation.

Methods inherited from class org.springframework.integration.file.remote.RemoteFileTemplate

afterPropertiesSet, append, append, execute, get, get, getRemoteFileSeparator, getSession, getSessionFactory, getTemporaryFileSuffix, invoke, isUseTemporaryFileName, list, remove, rename, send, send, setAutoCreateDirectory, setBeanFactory, setCharset, setFileNameExpression, setFileNameGenerator, setRemoteDirectoryExpression, setRemoteFileSeparator, setTemporaryFileSuffix, setTemporaryRemoteDirectoryExpression, setUseTemporaryFileName

Methods inherited from class java.lang.Object

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

Constructor Detail

FtpRemoteFileTemplate

public FtpRemoteFileTemplate(SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory)

Method Detail

executeWithClient

public <T,C> T executeWithClient(ClientCallback<C,T> callback)

Description copied from interface: RemoteFileOperations

Execute the callback's doWithClient method after obtaining a session's client, providing access to low level methods. Reliably closes the session when the method exits.

Specified by:

executeWithClient in interface RemoteFileOperations<org.apache.commons.net.ftp.FTPFile>

Overrides:

executeWithClient in class RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile>

Type Parameters:

T - The type returned by ClientCallback.doWithClient(Object).

C - The type of the underlying client object.

Parameters:

callback - the ClientCallback.

Returns:

The result of the callback method.

setExistsMode

public void setExistsMode(FtpRemoteFileTemplate.ExistsMode existsMode)

Specify an FtpRemoteFileTemplate.ExistsMode for exists(String) operation. Defaults to FtpRemoteFileTemplate.ExistsMode.STAT. When used internally by framework components for file operation, switched to FtpRemoteFileTemplate.ExistsMode.NLST.

Parameters:

existsMode - the FtpRemoteFileTemplate.ExistsMode to use.

Since:

4.1.9

doExecuteWithClient

protected <T> T doExecuteWithClient(ClientCallback<org.apache.commons.net.ftp.FTPClient,T> callback)

exists

public boolean exists(String path)

This particular FTP implementation is based on the FTPClient.getStatus(String) by default, but since not all FTP servers properly implement the STAT command, the framework internal FtpRemoteFileTemplate instances are switched to the FTPClient.listNames(String) for only files operations.

The mode can be switched with the setExistsMode(ExistsMode) property.

Any custom implementation can be done in an extension of the FtpRemoteFileTemplate.

Specified by:

exists in interface RemoteFileOperations<org.apache.commons.net.ftp.FTPFile>

Overrides:

exists in class RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile>

Parameters:

path - the remote file path to check.

Returns:

true or false if remote file exists or not.