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

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) Check if a file exists on the remote server.

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

afterPropertiesSet, append, append, execute, get, get, getRemoteFileSeparator, getSessionFactory, getTemporaryFileSuffix, isUseTemporaryFileName, 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.

doExecuteWithClient

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

exists

public boolean exists(String path)

Description copied from interface: RemoteFileOperations

Check if a file exists on the remote server.

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 full path to the file.

Returns:

true when the file exists.