org.springframework.integration.file.remote

Class RemoteFileTemplate<F>

java.lang.Object

org.springframework.integration.file.remote.RemoteFileTemplate<F>

All Implemented Interfaces:

Aware, BeanFactoryAware, InitializingBean, RemoteFileOperations<F>

public class RemoteFileTemplate<F>
extends Object
implements RemoteFileOperations<F>, InitializingBean, BeanFactoryAware

Since:

3.0

Author:

Iwein Fuld, Mark Fisher, Josh Long, Oleg Zhurakousky, David Turanski, Gary Russell

Constructor Summary

Constructors

Constructor and Description
RemoteFileTemplate(SessionFactory<F> sessionFactory)

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
<T> T	execute(SessionCallback<F,T> callback) Execute the callback's doInSession method after obtaining a session.
boolean	get(Message<?> message, InputStreamCallback callback) Retrieve a remote file as an InputStream, based on information in a message.
boolean	get(String remotePath, InputStreamCallback callback) Retrieve a remote file as an InputStream.
String	getRemoteFileSeparator()
String	getTemporaryFileSuffix()
boolean	isUseTemporaryFileName()
boolean	remove(String path) Remove a remote file.
void	rename(String fromPath, String toPath) Rename a remote file, creating directories if needed.
String	send(Message<?> message) Send a file to a remote server, based on information in a message.
String	send(Message<?> message, String subDirectory) Send a file to a remote server, based on information in a message.
void	setAutoCreateDirectory(boolean autoCreateDirectory)
void	setBeanFactory(BeanFactory beanFactory)
void	setCharset(String charset)
void	setFileNameExpression(Expression fileNameExpression)
void	setFileNameGenerator(FileNameGenerator fileNameGenerator)
void	setRemoteDirectoryExpression(Expression remoteDirectoryExpression)
void	setRemoteFileSeparator(String remoteFileSeparator)
void	setTemporaryFileSuffix(String temporaryFileSuffix)
void	setTemporaryRemoteDirectoryExpression(Expression temporaryRemoteDirectoryExpression)
void	setUseTemporaryFileName(boolean useTemporaryFileName)

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteFileTemplate

public RemoteFileTemplate(SessionFactory<F> sessionFactory)

Method Detail

setAutoCreateDirectory

public void setAutoCreateDirectory(boolean autoCreateDirectory)

setRemoteFileSeparator

public void setRemoteFileSeparator(String remoteFileSeparator)

getRemoteFileSeparator

public final String getRemoteFileSeparator()

setRemoteDirectoryExpression

public void setRemoteDirectoryExpression(Expression remoteDirectoryExpression)

setTemporaryRemoteDirectoryExpression

public void setTemporaryRemoteDirectoryExpression(Expression temporaryRemoteDirectoryExpression)

setFileNameExpression

public void setFileNameExpression(Expression fileNameExpression)

getTemporaryFileSuffix

public String getTemporaryFileSuffix()

isUseTemporaryFileName

public boolean isUseTemporaryFileName()

setUseTemporaryFileName

public void setUseTemporaryFileName(boolean useTemporaryFileName)

setFileNameGenerator

public void setFileNameGenerator(FileNameGenerator fileNameGenerator)

setCharset

public void setCharset(String charset)

setTemporaryFileSuffix

public void setTemporaryFileSuffix(String temporaryFileSuffix)

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException

Specified by:

setBeanFactory in interface BeanFactoryAware

Throws:

BeansException

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

send

public String send(Message<?> message)

Description copied from interface: RemoteFileOperations

Send a file to a remote server, based on information in a message.

Specified by:

send in interface RemoteFileOperations<F>

Parameters:

message - The message.

Returns:

The remote path, or null if no local file was found.

send

public String send(Message<?> message,
          String subDirectory)

Description copied from interface: RemoteFileOperations

Send a file to a remote server, based on information in a message. The subDirectory is appended to the remote directory evaluated from the message.

Specified by:

send in interface RemoteFileOperations<F>

Parameters:

message - The message.

subDirectory - The sub directory.

Returns:

The remote path, or null if no local file was found.

remove

public boolean remove(String path)

Description copied from interface: RemoteFileOperations

Remove a remote file.

Specified by:

remove in interface RemoteFileOperations<F>

Parameters:

path - The full path to the file.

Returns:

true when successful

rename

public void rename(String fromPath,
          String toPath)

Description copied from interface: RemoteFileOperations

Rename a remote file, creating directories if needed.

Specified by:

rename in interface RemoteFileOperations<F>

Parameters:

fromPath - The current path.

toPath - The new path.

get

public boolean get(Message<?> message,
          InputStreamCallback callback)

Description copied from interface: RemoteFileOperations

Retrieve a remote file as an InputStream, based on information in a message.

Specified by:

get in interface RemoteFileOperations<F>

Parameters:

message - The message which will be evaluated to generate the remote path.

callback - the callback.

Returns:

true if the operation was successful.

get

public boolean get(String remotePath,
          InputStreamCallback callback)

Description copied from interface: RemoteFileOperations

Retrieve a remote file as an InputStream.

Specified by:

get in interface RemoteFileOperations<F>

Parameters:

remotePath - The remote path to the file.

callback - the callback.

Returns:

true if the operation was successful.

execute

public <T> T execute(SessionCallback<F,T> callback)

Description copied from interface: RemoteFileOperations

Execute the callback's doInSession method after obtaining a session. Reliably closes the session when the method exits.

Specified by:

execute in interface RemoteFileOperations<F>

Type Parameters:

T - The type returned by SessionCallback.doInSession(org.springframework.integration.file.remote.session.Session).

Parameters:

callback - the SessionCallback.

Returns:

The result of the callback method.