Package org.springframework.integration.file.remote.handler

Class FileTransferringMessageHandler<F>

java.lang.Object
org.springframework.integration.context.IntegrationObjectSupport
org.springframework.integration.handler.MessageHandlerSupport
org.springframework.integration.handler.AbstractMessageHandler
org.springframework.integration.file.remote.handler.FileTransferringMessageHandler<F>
Type Parameters:
F - the file type.
All Implemented Interfaces:
org.reactivestreams.Subscriber<org.springframework.messaging.Message<?>>, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, org.springframework.integration.context.ExpressionCapable, org.springframework.integration.context.Orderable, org.springframework.integration.IntegrationPattern, org.springframework.integration.support.context.NamedComponent, org.springframework.integration.support.management.IntegrationManagement, org.springframework.integration.support.management.TrackableComponent, org.springframework.messaging.MessageHandler, reactor.core.CoreSubscriber<org.springframework.messaging.Message<?>>
public class FileTransferringMessageHandler<F>
extends org.springframework.integration.handler.AbstractMessageHandler
A MessageHandler implementation that transfers files to a remote server.
Since:
2.0

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

    org.springframework.integration.support.management.IntegrationManagement.ManagementOverrides

  • Field Summary

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

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

    EXPRESSION_PARSER, logger

    Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

    METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

    Fields inherited from interface org.springframework.core.Ordered

    HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

  • Constructor Summary

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

  • Method Summary

    Modifier and Type Method Description
    protected void doChmod​(RemoteFileTemplate<F> remoteFileTemplate, java.lang.String path, int chmod)
    Set the mode on the remote file after transfer; the default implementation does nothing.
    protected java.lang.String getTemporaryFileSuffix()  
    protected void handleMessageInternal​(org.springframework.messaging.Message<?> message)  
    boolean isChmodCapable()  
    protected boolean isUseTemporaryFileName()  
    protected void onInit()  
    void setAutoCreateDirectory​(boolean autoCreateDirectory)
    A boolean flag to indicate automatically create the directory or not.
    void setCharset​(java.lang.String charset)
    Set the charset to use when converting String payloads to bytes as the content of the remote file.
    void setChmod​(int chmod)
    Set the file permissions after uploading, e.g.
    void setChmodOctal​(java.lang.String chmod)
    String setter for Spring XML convenience.
    void setFileNameGenerator​(FileNameGenerator fileNameGenerator)
    Set the file name generator used to generate the remote filename to be used when transferring files to the remote system.
    void setRemoteDirectoryExpression​(org.springframework.expression.Expression remoteDirectoryExpression)
    Specify a remote directory path SpEL expression.
    void setRemoteDirectoryExpressionString​(java.lang.String remoteDirectoryExpression)
    Specify a remote directory path SpEL expression.
    void setRemoteFileSeparator​(java.lang.String remoteFileSeparator)
    Specify a remote file separator symbol.
    void setTemporaryFileSuffix​(java.lang.String temporaryFileSuffix)
    Set the temporary suffix to use when transferring files to the remote system.
    void setTemporaryRemoteDirectoryExpression​(org.springframework.expression.Expression temporaryRemoteDirectoryExpression)
    Specify a remote directory path SpEL expression.
    void setTemporaryRemoteDirectoryExpressionString​(java.lang.String temporaryRemoteDirectoryExpression)
    Specify a remote directory path SpEL expression.
    void setUseTemporaryFileName​(boolean useTemporaryFileName)
    A boolean flag to use temporary files names or not.

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

    handleMessage, onComplete, onError, onNext, onSubscribe

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

    buildSendTimer, destroy, getComponentType, getIntegrationPatternType, getManagedName, getManagedType, getMetricsCaptor, getOrder, getOverrides, isLoggingEnabled, registerMetricsCaptor, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrack

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

    afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface reactor.core.CoreSubscriber

    currentContext

    Methods inherited from interface org.springframework.integration.support.management.IntegrationManagement

    getThisAs

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

    getBeanName, getComponentName