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:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, Orderable, NamedComponent, ConfigurableMetricsAware<AbstractMessageHandlerMetrics>, IntegrationManagement, IntegrationStatsManagement, MessageHandlerMetrics, TrackableComponent, org.springframework.messaging.MessageHandler

Direct Known Subclasses:

FtpMessageHandler, SftpMessageHandler

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

Modifier and Type	Field and Description
protected RemoteFileTemplate<F>	remoteFileTemplate

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(org.springframework.messaging.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(org.springframework.expression.Expression remoteDirectoryExpression)
void	setRemoteFileSeparator(java.lang.String remoteFileSeparator)
void	setTemporaryFileSuffix(java.lang.String temporaryFileSuffix)
void	setTemporaryRemoteDirectoryExpression(org.springframework.expression.Expression temporaryRemoteDirectoryExpression)
void	setUseTemporaryFileName(boolean useTemporaryFileName)

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

configureMetrics, getActiveCount, getActiveCountLong, getComponentType, getDuration, getErrorCount, getErrorCountLong, getHandleCount, getHandleCountLong, getManagedName, getManagedType, getMaxDuration, getMeanDuration, getMinDuration, getOrder, getStandardDeviationDuration, handleMessage, isCountsEnabled, isLoggingEnabled, isStatsEnabled, reset, setCountsEnabled, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, setStatsEnabled

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

afterPropertiesSet, extractTypeIfPossible, getApplicationContext, getApplicationContextId, getBeanFactory, getChannelResolver, getComponentName, getConversionService, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, 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

Field Detail

remoteFileTemplate

protected final RemoteFileTemplate<F> remoteFileTemplate

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)

Parameters:

autoCreateDirectory - true to automatically create the direcotory.

See Also:

RemoteFileTemplate.setAutoCreateDirectory(boolean)

setRemoteFileSeparator

public void setRemoteFileSeparator(java.lang.String remoteFileSeparator)

Parameters:

remoteFileSeparator - the remote file separator.

See Also:

RemoteFileTemplate.setRemoteFileSeparator(String)

setRemoteDirectoryExpression

public void setRemoteDirectoryExpression(org.springframework.expression.Expression remoteDirectoryExpression)

Parameters:

remoteDirectoryExpression - the remote directory expression

See Also:

RemoteFileTemplate.setRemoteDirectoryExpression(Expression)

setTemporaryRemoteDirectoryExpression

public void setTemporaryRemoteDirectoryExpression(org.springframework.expression.Expression temporaryRemoteDirectoryExpression)

Parameters:

temporaryRemoteDirectoryExpression - the temporary remote directory expression

See Also:

RemoteFileTemplate.setTemporaryRemoteDirectoryExpression(Expression)

getTemporaryFileSuffix

protected java.lang.String getTemporaryFileSuffix()

isUseTemporaryFileName

protected boolean isUseTemporaryFileName()

setUseTemporaryFileName

public void setUseTemporaryFileName(boolean useTemporaryFileName)

Parameters:

useTemporaryFileName - true to use a temporary file name.

See Also:

RemoteFileTemplate.setUseTemporaryFileName(boolean)

setFileNameGenerator

public void setFileNameGenerator(FileNameGenerator fileNameGenerator)

Parameters:

fileNameGenerator - the file name generator.

See Also:

RemoteFileTemplate.setFileNameGenerator(FileNameGenerator)

setCharset

public void setCharset(java.lang.String charset)

Parameters:

charset - the charset.

See Also:

RemoteFileTemplate.setCharset(String)

setTemporaryFileSuffix

public void setTemporaryFileSuffix(java.lang.String temporaryFileSuffix)

Parameters:

temporaryFileSuffix - the temporary file suffix.

See Also:

RemoteFileTemplate.setTemporaryFileSuffix(String)

onInit

protected void onInit()
               throws java.lang.Exception

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class AbstractMessageHandler

Throws:

java.lang.Exception - Any exception.

handleMessageInternal

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

Specified by:

handleMessageInternal in class AbstractMessageHandler

Throws:

java.lang.Exception