org.springframework.integration.file.remote.handler

Class FileTransferringMessageHandler<F>

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.file.remote.handler.FileTransferringMessageHandler<F>

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, Ordered, Orderable, TrackableComponent, NamedComponent, MessageHandler

public class FileTransferringMessageHandler<F>
extends AbstractMessageHandler

A MessageHandler implementation that transfers files to a remote server.

Since:

2.0

Author:

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

Field Summary

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
FileTransferringMessageHandler(RemoteFileTemplate<F> remoteFileTemplate)
FileTransferringMessageHandler(RemoteFileTemplate<F> remoteFileTemplate, FileExistsMode mode)
FileTransferringMessageHandler(SessionFactory<F> sessionFactory)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getTemporaryFileSuffix()
protected void	handleMessageInternal(Message<?> message)
protected boolean	isUseTemporaryFileName()
protected void	onInit() Subclasses may implement this for initialization logic.
void	setAutoCreateDirectory(boolean autoCreateDirectory)
void	setCharset(java.lang.String charset)
void	setFileNameGenerator(FileNameGenerator fileNameGenerator)
void	setRemoteDirectoryExpression(Expression remoteDirectoryExpression)
void	setRemoteFileSeparator(java.lang.String remoteFileSeparator)
void	setTemporaryFileSuffix(java.lang.String temporaryFileSuffix)
void	setTemporaryRemoteDirectoryExpression(Expression temporaryRemoteDirectoryExpression)
void	setUseTemporaryFileName(boolean useTemporaryFileName)

Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler

getComponentType, getOrder, handleMessage, setOrder, setShouldTrack

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, getApplicationContext, getApplicationContextId, getBeanFactory, getComponentName, getConversionService, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setComponentName, setConversionService, setMessageBuilderFactory, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getComponentName

Constructor Detail

FileTransferringMessageHandler

public FileTransferringMessageHandler(SessionFactory<F> sessionFactory)

FileTransferringMessageHandler

public FileTransferringMessageHandler(RemoteFileTemplate<F> remoteFileTemplate)

FileTransferringMessageHandler

public FileTransferringMessageHandler(RemoteFileTemplate<F> remoteFileTemplate,
                                      FileExistsMode mode)

Method Detail

setAutoCreateDirectory

public void setAutoCreateDirectory(boolean autoCreateDirectory)

setRemoteFileSeparator

public void setRemoteFileSeparator(java.lang.String remoteFileSeparator)

setRemoteDirectoryExpression

public void setRemoteDirectoryExpression(Expression remoteDirectoryExpression)

setTemporaryRemoteDirectoryExpression

public void setTemporaryRemoteDirectoryExpression(Expression temporaryRemoteDirectoryExpression)

getTemporaryFileSuffix

protected java.lang.String getTemporaryFileSuffix()

isUseTemporaryFileName

protected boolean isUseTemporaryFileName()

setUseTemporaryFileName

public void setUseTemporaryFileName(boolean useTemporaryFileName)

setFileNameGenerator

public void setFileNameGenerator(FileNameGenerator fileNameGenerator)

setCharset

public void setCharset(java.lang.String charset)

setTemporaryFileSuffix

public void setTemporaryFileSuffix(java.lang.String temporaryFileSuffix)

onInit

protected void onInit()
               throws java.lang.Exception

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class IntegrationObjectSupport

Throws:

java.lang.Exception - Any exception.

handleMessageInternal

protected void handleMessageInternal(Message<?> message)
                              throws java.lang.Exception

Specified by:

handleMessageInternal in class AbstractMessageHandler

Throws:

java.lang.Exception