Package org.springframework.integration.file.dsl

Class RemoteFileOutboundGatewaySpec<F,​S extends RemoteFileOutboundGatewaySpec<F,​S>>

java.lang.Object
org.springframework.beans.factory.config.AbstractFactoryBean<T>
org.springframework.integration.dsl.IntegrationComponentSpec<S,​H>
org.springframework.integration.dsl.MessageHandlerSpec<S,​AbstractRemoteFileOutboundGateway<F>>
org.springframework.integration.file.dsl.RemoteFileOutboundGatewaySpec<F,​S>
Type Parameters:
F - the target file type.
S - the target RemoteFileOutboundGatewaySpec implementation type.
All Implemented Interfaces:
org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<AbstractRemoteFileOutboundGateway<F>>, org.springframework.beans.factory.InitializingBean, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, org.springframework.integration.dsl.ComponentsRegistration
public abstract class RemoteFileOutboundGatewaySpec<F,​S extends RemoteFileOutboundGatewaySpec<F,​S>>
extends org.springframework.integration.dsl.MessageHandlerSpec<S,​AbstractRemoteFileOutboundGateway<F>>
implements org.springframework.integration.dsl.ComponentsRegistration
The MessageHandlerSpec for the AbstractRemoteFileOutboundGateway.
Since:
5.0

  • Field Summary

    Fields inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

    PARSER, target

    Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

    logger

    Fields inherited from interface org.springframework.beans.factory.FactoryBean

    OBJECT_TYPE_ATTRIBUTE

    Fields inherited from interface org.springframework.context.SmartLifecycle

    DEFAULT_PHASE

  • Constructor Summary

    Constructors 
    Modifier Constructor Description
    protected RemoteFileOutboundGatewaySpec​(AbstractRemoteFileOutboundGateway<F> outboundGateway)  

  • Method Summary

    Modifier and Type Method Description
    S autoCreateDirectory​(boolean autoCreateDirectory)
    Determine whether the remote directory should automatically be created when sending files to the remote system.
    S autoCreateLocalDirectory​(boolean autoCreateLocalDirectory)
    A boolean flag to identify if local directory should be created automatically.
    S charset​(java.lang.String charset)
    Set the charset to use when converting String payloads to bytes as the content of the remote file.
    S chmod​(int chmod)
    Set the file permissions after uploading, e.g.
    S fileExistsMode​(FileExistsMode fileExistsMode)
    Determine the action to take when using GET and MGET operations when the file already exists locally, or PUT and MPUT when the file exists on the remote system.
    S fileNameExpression​(java.lang.String fileNameExpression)
    Set the file name expression to determine the full path to the remote file.
    S fileNameExpression​(org.springframework.expression.Expression fileNameExpression)
    Set the file name expression to determine the full path to the remote file.
    <P> S fileNameFunction​(java.util.function.Function<org.springframework.messaging.Message<P>,​java.lang.String> fileNameFunction)
    Set the file name function to determine the full path to the remote file.
    S fileNameGenerator​(FileNameGenerator fileNameGenerator)
    Set the file name generator used to generate the remote filename to be used when transferring files to the remote system.
    S filter​(FileListFilter<F> filter)
    Set a FileListFilter to filter remote files.
    S filterExpression​(java.lang.String expression)
    Configure the ExpressionFileListFilter.
    S filterFunction​(java.util.function.Function<F,​java.lang.Boolean> filterFunction)
    Configure the ExpressionFileListFilter.
    java.util.Map<java.lang.Object,​java.lang.String> getComponentsToRegister()  
    S localDirectory​(java.io.File localDirectory)
    Specify a directory path where remote files will be transferred to.
    <P> S localDirectory​(java.util.function.Function<org.springframework.messaging.Message<P>,​java.lang.String> localDirectoryFunction)
    Specify a Function to evaluate directory path where remote files will be transferred to.
    S localDirectoryExpression​(java.lang.String localDirectoryExpression)
    Specify a SpEL expression to evaluate directory path where remote files will be transferred to.
    S localDirectoryExpression​(org.springframework.expression.Expression localDirectoryExpression)
    Specify a SpEL expression to evaluate directory path where remote files will be transferred to.
    S localFilenameExpression​(java.lang.String localFilenameExpression)
    Specify a SpEL expression for local files renaming after downloading.
    S localFilenameExpression​(org.springframework.expression.Expression localFilenameExpression)
    Specify a SpEL expression for local files renaming after downloading.
    <P> S localFilenameFunction​(java.util.function.Function<org.springframework.messaging.Message<P>,​java.lang.String> localFilenameFunction)
    Specify a Function for local files renaming after downloading.
    S mputFilter​(FileListFilter<java.io.File> filter)
    A FileListFilter that runs against the local file system view when using MPUT command.
    S mputFilterExpression​(java.lang.String expression)
    Configure the ExpressionFileListFilter.
    S mputFilterFunction​(java.util.function.Function<java.io.File,​java.lang.Boolean> filterFunction)
    Configure the ExpressionFileListFilter.
    S options​(java.lang.String options)
    Specify the array of options for various gateway commands.
    S options​(AbstractRemoteFileOutboundGateway.Option... options)
    Specify the array of AbstractRemoteFileOutboundGateway.Option for various gateway commands.
    abstract S patternFileNameFilter​(java.lang.String pattern)
    Specify a simple pattern to match remote files (e.g.
    S patternMputFilter​(java.lang.String pattern)
    A SimplePatternFileListFilter that runs against the local file system view when using MPUT command.
    abstract S regexFileNameFilter​(java.lang.String regex)
    Specify a simple pattern to match remote files (e.g.
    S regexMputFilter​(java.lang.String regex)
    A SimplePatternFileListFilter that runs against the local file system view when using MPUT command.
    S remoteDirectoryExpression​(java.lang.String remoteDirectoryExpression)
    Set the remote directory expression used to determine the remote directory to which files will be sent.
    S remoteDirectoryExpression​(org.springframework.expression.Expression remoteDirectoryExpression)
    Set the remote directory expression used to determine the remote directory to which files will be sent.
    <P> S remoteDirectoryFunction​(java.util.function.Function<org.springframework.messaging.Message<P>,​java.lang.String> remoteDirectoryFunction)
    Specify a Function for remote directory.
    S remoteFileSeparator​(java.lang.String remoteFileSeparator)
    Set the file separator when dealing with remote files; default '/'.
    S renameExpression​(java.lang.String expression)
    Specify a SpEL expression for files renaming during transfer.
    S renameExpression​(org.springframework.expression.Expression expression)
    Specify a SpEL expression for files renaming during transfer.
    <P> S renameFunction​(java.util.function.Function<org.springframework.messaging.Message<P>,​java.lang.String> renameFunction)
    Specify a Function for files renaming during transfer.
    S temporaryFileSuffix​(java.lang.String temporaryFileSuffix)
    Set the temporary suffix to use when transferring files to the remote system.
    S temporaryRemoteDirectoryExpression​(java.lang.String temporaryRemoteDirectoryExpression)
    Set a temporary remote directory expression; used when transferring files to the remote system.
    S temporaryRemoteDirectoryExpression​(org.springframework.expression.Expression temporaryRemoteDirectoryExpression)
    Set a temporary remote directory expression; used when transferring files to the remote system.
    <P> S temporaryRemoteDirectoryFunction​(java.util.function.Function<org.springframework.messaging.Message<P>,​java.lang.String> temporaryRemoteDirectoryFunction)
    Set a temporary remote directory function; used when transferring files to the remote system.
    S useTemporaryFileName​(boolean useTemporaryFileName)
    Set whether a temporary file name is used when sending files to the remote system.

    Methods inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

    _this, createInstance, destroyInstance, doGet, get, getId, getObjectType, getPhase, id, isAutoStartup, isRunning, start, stop, stop

    Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

    afterPropertiesSet, destroy, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

    Methods inherited from class java.lang.Object

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