Class AbstractRemoteFileOutboundGateway<F>
java.lang.Object
org.springframework.integration.context.IntegrationObjectSupport
org.springframework.integration.handler.MessageHandlerSupport
org.springframework.integration.handler.AbstractMessageHandler
org.springframework.integration.handler.AbstractMessageProducingHandler
org.springframework.integration.handler.AbstractReplyProducingMessageHandler
org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway<F>
- Type Parameters:
F
- the file type.
- All Implemented Interfaces:
org.reactivestreams.Subscriber<Message<?>>
,Aware
,BeanClassLoaderAware
,BeanFactoryAware
,BeanNameAware
,DisposableBean
,InitializingBean
,ApplicationContextAware
,Ordered
,ExpressionCapable
,Orderable
,MessageProducer
,HeaderPropagationAware
,IntegrationPattern
,NamedComponent
,IntegrationManagement
,TrackableComponent
,MessageHandler
,reactor.core.CoreSubscriber<Message<?>>
- Direct Known Subclasses:
FtpOutboundGateway
,SftpOutboundGateway
,SmbOutboundGateway
public abstract class AbstractRemoteFileOutboundGateway<F>
extends AbstractReplyProducingMessageHandler
Base class for Outbound Gateways that perform remote file operations.
- Since:
- 2.1
- Author:
- Gary Russell, Artem Bilan, Mauro Molinari
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Enumeration of commands supported by the gateways.static enum
Enumeration of options supported by various commands.Nested classes/interfaces inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler
AbstractReplyProducingMessageHandler.RequestHandler
Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement
IntegrationManagement.ManagementOverrides
-
Field Summary
Fields inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler
messagingTemplate
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
ConstructorDescriptionAbstractRemoteFileOutboundGateway
(RemoteFileTemplate<F> remoteFileTemplate, String command, String expression) Construct an instance with the supplied remote file template, a command ('ls', 'get' etc), and an expression to determine the filename.AbstractRemoteFileOutboundGateway
(RemoteFileTemplate<F> remoteFileTemplate, AbstractRemoteFileOutboundGateway.Command command, String expressionArg) Construct an instance with the supplied remote file template, a command ('ls', 'get' etc), and an expression to determine the filename.AbstractRemoteFileOutboundGateway
(RemoteFileTemplate<F> remoteFileTemplate, MessageSessionCallback<F, ?> messageSessionCallback) Construct an instance with the supplied remote file template and callback for performing operations on the session.AbstractRemoteFileOutboundGateway
(SessionFactory<F> sessionFactory, String command, String expression) Construct an instance with the supplied session factory, a command ('ls', 'get' etc), and an expression to determine the filename.AbstractRemoteFileOutboundGateway
(SessionFactory<F> sessionFactory, AbstractRemoteFileOutboundGateway.Command command, String expression) Construct an instance with the supplied session factory, a command ('ls', 'get' etc), and an expression to determine the filename.AbstractRemoteFileOutboundGateway
(SessionFactory<F> sessionFactory, MessageSessionCallback<F, ?> messageSessionCallback) Construct an instance using the provided session factory and callback for performing operations on the session. -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract List<AbstractFileInfo<F>>
asFileInfoList
(Collection<F> files) protected void
assertRemoteFileTemplateMutability
(String propertyName) protected void
doChmod
(RemoteFileOperations<F> remoteFileOperations, String path, int chmodToSet) Set the mode on the remote file after transfer; the default implementation does nothing.protected void
doInit()
protected abstract F
enhanceNameWithSubDirectory
(F file, String directory) protected final F
filterFile
(F file) filterFiles
(F[] files) filterMputFiles
(File[] files) protected File
get
(Message<?> message, Session<F> session, String remoteDir, String remoteFilePath, String remoteFilename, F fileInfoParam) Copy a remote file to the configured local directory.protected abstract String
getFilename
(F file) protected abstract String
getFilename
(AbstractFileInfo<F> file) protected abstract long
getModified
(F file) protected String
getRemoteFilename
(String remoteFilePath) protected final RemoteFileTemplate<F>
protected Object
handleRequestMessage
(Message<?> requestMessage) Subclasses must implement this method to handle the request Message.boolean
protected abstract boolean
isDirectory
(F file) protected abstract boolean
protected List<?>
List remote files to local representation.Put files from the provided directory to the remote server recursively.protected boolean
Move one remote path to another.List remote files names for the provided directory.protected void
protected void
purgeLinks
(List<F> lsFiles) protected String
Put the file based on the message to the remote server.protected final void
remoteFileTemplateExplicitlySet
(boolean remoteFileTemplateExplicitlySet) protected boolean
Perform remote delete for the provided path.void
setAutoCreateDirectory
(boolean autoCreateDirectory) Determine whether the remote directory should automatically be created when sending files to the remote system.void
setAutoCreateLocalDirectory
(boolean autoCreateLocalDirectory) Aboolean
flag to identify if local directory should be created automatically.void
setCharset
(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
(String chmod) String setter for Spring XML convenience.void
setFileExistsMode
(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.void
setFileNameExpression
(Expression fileNameExpression) Set the file name expression to determine the full path to the remote file.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
setFilter
(FileListFilter<F> filter) Set aFileListFilter
to filter remote files.void
setLocalDirectory
(File localDirectory) Specify a directory path where remote files will be transferred to.void
setLocalDirectoryExpression
(Expression localDirectoryExpression) Specify a SpEL expression to evaluate the directory path to which remote files will be transferred.void
setLocalDirectoryExpressionString
(String localDirectoryExpression) Specify a SpEL expression to evaluate the directory path to which remote files will be transferred.void
setLocalFilenameGeneratorExpression
(Expression localFilenameGeneratorExpression) Specify a SpEL expression for local files renaming after downloading.void
setLocalFilenameGeneratorExpressionString
(String localFilenameGeneratorExpression) Specify a SpEL expression for local files renaming after downloading.void
setMputFilter
(FileListFilter<File> filter) AFileListFilter
that runs against the local file system view when usingMPUT
command.void
setOption
(AbstractRemoteFileOutboundGateway.Option... options) Specify the array of options for various gateway commands.void
setOptions
(String options) Specify the options for various gateway commands as a space-delimited string.void
setRemoteDirectoryExpression
(Expression remoteDirectoryExpression) Set the remote directory expression used to determine the remote directory to which files will be sent.void
setRemoteFileSeparator
(String remoteFileSeparator) Set the file separator when dealing with remote files; default '/'.void
setRenameExpression
(Expression renameExpression) Specify a SpEL expression for files renaming during transfer.void
setRenameExpressionString
(String renameExpression) Specify a SpEL expression for files renaming during transfer.void
setTemporaryFileSuffix
(String temporaryFileSuffix) Set the temporary suffix to use when transferring files to the remote system.void
setTemporaryRemoteDirectoryExpression
(Expression temporaryRemoteDirectoryExpression) Set a temporary remote directory expression; used when transferring files to the remote system.void
setUseTemporaryFileName
(boolean useTemporaryFileName) Set whether a temporary file name is used when sending files to the remote system.Methods inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler
doInvokeAdvisedRequestHandler, getBeanClassLoader, getIntegrationPatternType, getRequiresReply, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setRequiresReply
Methods inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler
addNotPropagatedHeaders, createOutputMessage, getNotPropagatedHeaders, getOutputChannel, isAsync, messageBuilderForReply, produceOutput, resolveErrorChannel, sendErrorMessage, sendOutput, sendOutputs, setAsync, setNotPropagatedHeaders, setOutputChannel, setOutputChannelName, setSendTimeout, setupMessageProcessor, shouldCopyRequestHeaders, shouldSplitOutput, updateNotPropagatedHeaders
Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler
handleMessage, onComplete, onError, onNext, onSubscribe, setObservationConvention
Methods inherited from class org.springframework.integration.handler.MessageHandlerSupport
buildSendTimer, destroy, getComponentType, getManagedName, getManagedType, getMetricsCaptor, getObservationRegistry, getOrder, getOverrides, isLoggingEnabled, isObserved, registerMetricsCaptor, registerObservationRegistry, 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
-
Constructor Details
-
AbstractRemoteFileOutboundGateway
public AbstractRemoteFileOutboundGateway(SessionFactory<F> sessionFactory, MessageSessionCallback<F, ?> messageSessionCallback) Construct an instance using the provided session factory and callback for performing operations on the session.- Parameters:
sessionFactory
- the session factory.messageSessionCallback
- the callback.
-
AbstractRemoteFileOutboundGateway
public AbstractRemoteFileOutboundGateway(RemoteFileTemplate<F> remoteFileTemplate, MessageSessionCallback<F, ?> messageSessionCallback) Construct an instance with the supplied remote file template and callback for performing operations on the session.- Parameters:
remoteFileTemplate
- the remote file template.messageSessionCallback
- the callback.
-
AbstractRemoteFileOutboundGateway
public AbstractRemoteFileOutboundGateway(SessionFactory<F> sessionFactory, String command, @Nullable String expression) Construct an instance with the supplied session factory, a command ('ls', 'get' etc), and an expression to determine the filename.- Parameters:
sessionFactory
- the session factory.command
- the command.expression
- the filename expression.
-
AbstractRemoteFileOutboundGateway
public AbstractRemoteFileOutboundGateway(SessionFactory<F> sessionFactory, AbstractRemoteFileOutboundGateway.Command command, @Nullable String expression) Construct an instance with the supplied session factory, a command ('ls', 'get' etc), and an expression to determine the filename.- Parameters:
sessionFactory
- the session factory.command
- the command.expression
- the filename expression.
-
AbstractRemoteFileOutboundGateway
public AbstractRemoteFileOutboundGateway(RemoteFileTemplate<F> remoteFileTemplate, String command, @Nullable String expression) Construct an instance with the supplied remote file template, a command ('ls', 'get' etc), and an expression to determine the filename.- Parameters:
remoteFileTemplate
- the remote file template.command
- the command.expression
- the filename expression.
-
AbstractRemoteFileOutboundGateway
public AbstractRemoteFileOutboundGateway(RemoteFileTemplate<F> remoteFileTemplate, AbstractRemoteFileOutboundGateway.Command command, @Nullable String expressionArg) Construct an instance with the supplied remote file template, a command ('ls', 'get' etc), and an expression to determine the filename.- Parameters:
remoteFileTemplate
- the remote file template.command
- the command.expressionArg
- the filename expression.
-
-
Method Details
-
remoteFileTemplateExplicitlySet
protected final void remoteFileTemplateExplicitlySet(boolean remoteFileTemplateExplicitlySet) -
assertRemoteFileTemplateMutability
-
setOptions
Specify the options for various gateway commands as a space-delimited string.- Parameters:
options
- the options to set- See Also:
-
setOption
Specify the array of options for various gateway commands.- Parameters:
options
- theAbstractRemoteFileOutboundGateway.Option
array to use.- Since:
- 5.0
- See Also:
-
setRemoteFileSeparator
Set the file separator when dealing with remote files; default '/'.- Parameters:
remoteFileSeparator
- the separator.- See Also:
-
setLocalDirectory
Specify a directory path where remote files will be transferred to.- Parameters:
localDirectory
- the localDirectory to set
-
setLocalDirectoryExpression
Specify a SpEL expression to evaluate the directory path to which remote files will be transferred.- Parameters:
localDirectoryExpression
- the SpEL to determine the local directory.
-
setLocalDirectoryExpressionString
Specify a SpEL expression to evaluate the directory path to which remote files will be transferred.- Parameters:
localDirectoryExpression
- the SpEL to determine the local directory.- Since:
- 5.0
-
setAutoCreateLocalDirectory
public void setAutoCreateLocalDirectory(boolean autoCreateLocalDirectory) Aboolean
flag to identify if local directory should be created automatically. Defaults totrue
.- Parameters:
autoCreateLocalDirectory
- the autoCreateLocalDirectory to set
-
setTemporaryFileSuffix
Set the temporary suffix to use when transferring files to the remote system. Default.writing
.- Parameters:
temporaryFileSuffix
- the temporaryFileSuffix to set- See Also:
-
setAutoCreateDirectory
public void setAutoCreateDirectory(boolean autoCreateDirectory) Determine whether the remote directory should automatically be created when sending files to the remote system.- Parameters:
autoCreateDirectory
- true to create the directory.- Since:
- 5.2
- See Also:
-
setRemoteDirectoryExpression
Set the remote directory expression used to determine the remote directory to which files will be sent.- Parameters:
remoteDirectoryExpression
- the remote directory expression.- Since:
- 5.2
- See Also:
-
setTemporaryRemoteDirectoryExpression
Set a temporary remote directory expression; used when transferring files to the remote system. After a successful transfer the file is renamed using theremoteDirectoryExpression
.- Parameters:
temporaryRemoteDirectoryExpression
- the temporary remote directory expression.- Since:
- 5.2
- See Also:
-
setFileNameExpression
Set the file name expression to determine the full path to the remote file.- Parameters:
fileNameExpression
- the file name expression.- Since:
- 5.2
- See Also:
-
setUseTemporaryFileName
public void setUseTemporaryFileName(boolean useTemporaryFileName) Set whether a temporary file name is used when sending files to the remote system.- Parameters:
useTemporaryFileName
- true to use a temporary file name.- Since:
- 5.2
- See Also:
-
setFileNameGenerator
Set the file name generator used to generate the remote filename to be used when transferring files to the remote system.- Parameters:
fileNameGenerator
- the file name generator.- Since:
- 5.2
- See Also:
-
setCharset
Set the charset to use when converting String payloads to bytes as the content of the remote file. DefaultUTF-8
.- Parameters:
charset
- the charset.- Since:
- 5.2
- See Also:
-
setFilter
Set aFileListFilter
to filter remote files.- Parameters:
filter
- the filter to set
-
setMputFilter
AFileListFilter
that runs against the local file system view when usingMPUT
command.- Parameters:
filter
- the filter to set
-
setRenameExpression
Specify a SpEL expression for files renaming during transfer.- Parameters:
renameExpression
- the expression to use.- Since:
- 4.3
-
setRenameExpressionString
Specify a SpEL expression for files renaming during transfer.- Parameters:
renameExpression
- the String in SpEL syntax.- Since:
- 4.3
-
setLocalFilenameGeneratorExpression
Specify a SpEL expression for local files renaming after downloading.- Parameters:
localFilenameGeneratorExpression
- the expression to use.- Since:
- 3.0
-
setLocalFilenameGeneratorExpressionString
Specify a SpEL expression for local files renaming after downloading.- Parameters:
localFilenameGeneratorExpression
- the String in SpEL syntax.- Since:
- 4.3
-
setFileExistsMode
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.- Parameters:
fileExistsMode
- the fileExistsMode to set.- Since:
- 4.2
-
setChmodOctal
String setter for Spring XML convenience.- Parameters:
chmod
- permissions as an octal string e.g "600";- Since:
- 4.3
- See Also:
-
setChmod
public void setChmod(int chmod) Set the file permissions after uploading, e.g. 0600 for owner read/write.- Parameters:
chmod
- the permissions.- Since:
- 4.3
-
isChmodCapable
public boolean isChmodCapable() -
getRemoteFileTemplate
-
doInit
protected void doInit()- Overrides:
doInit
in classAbstractReplyProducingMessageHandler
-
handleRequestMessage
Description copied from class:AbstractReplyProducingMessageHandler
Subclasses must implement this method to handle the request Message. The return value may be a Message, a MessageBuilder, or any plain Object. The base class will handle the final creation of a reply Message from any of those starting points. If the return value is null, the Message flow will end here.- Specified by:
handleRequestMessage
in classAbstractReplyProducingMessageHandler
- Parameters:
requestMessage
- The request message.- Returns:
- The result of handling the message, or
null
.
-
nlst
List remote files names for the provided directory. The message can be consulted for some context related to the current request; isn't used in the default implementation.- Parameters:
message
- the message related to the current requestsession
- the session to perform list file names commanddir
- the remote directory to list file names- Returns:
- the list of file/directory names in the provided dir
- Throws:
IOException
- the IO exception during performing remote command- Since:
- 5.0
-
rm
protected boolean rm(Message<?> message, Session<F> session, String remoteFilePath) throws IOException Perform remote delete for the provided path. The message can be consulted to determine some context; isn't used in the default implementation.- Parameters:
message
- the request message related to the path to removesession
- the remote protocol session to perform remove commandremoteFilePath
- the remote path to remove- Returns:
- true or false as a result of the remote removal
- Throws:
IOException
- the IO exception during performing remote command- Since:
- 5.0
-
mv
protected boolean mv(Message<?> message, Session<F> session, String remoteFilePath, String remoteFileNewPath) throws IOException Move one remote path to another. The message can be consulted to determine some context; isn't used in the default implementation.- Parameters:
message
- the request message related to this move commandsession
- the remote protocol session to perform move commandremoteFilePath
- the source remote pathremoteFileNewPath
- the target remote path- Returns:
- true or false as a result of the operation
- Throws:
IOException
- the IO exception during performing remote command- Since:
- 5.0
-
put
Put the file based on the message to the remote server. The message can be consulted to determine some context. The session argument isn't used in the default implementation.- Parameters:
message
- the request message related to this put commandsession
- the remote protocol session related to this invocation contextsubDirectory
- the target sub directory to put- Returns:
- The remote path, or null if no local file was found.
- Since:
- 5.0
-
doChmod
Set the mode on the remote file after transfer; the default implementation does nothing.- Parameters:
remoteFileOperations
- the remote file template.path
- the path.chmodToSet
- the chmod to set.- Since:
- 4.3
-
mPut
Put files from the provided directory to the remote server recursively. The message can be consulted to determine some context. The session argument isn't used in the default implementation.- Parameters:
message
- the request message related to this mPut commandsession
- the remote protocol session for this invocation contextlocalDir
- the local directory to mput to the server- Returns:
- The list of remote paths for sent files
- Since:
- 5.0
-
ls
List remote files to local representation. The message can be consulted for some context for the current request; isn't used in the default implementation.- Parameters:
message
- the message related to the list requestsession
- the session to perform list commanddir
- the remote directory to list content- Returns:
- the list of remote files
- Throws:
IOException
- the IO exception during performing remote command
-
filterFiles
-
filterFile
-
filterMputFiles
-
purgeLinks
-
purgeDots
-
get
protected File get(Message<?> message, Session<F> session, String remoteDir, String remoteFilePath, String remoteFilename, F fileInfoParam) throws IOException Copy a remote file to the configured local directory.- Parameters:
message
- the message.session
- the session.remoteDir
- the remote directory.remoteFilePath
- the remote file path.remoteFilename
- the remote file name.fileInfoParam
- the remote file info; if null we will execute an 'ls' command first.- Returns:
- The file.
- Throws:
IOException
- Any IOException.
-
mGet
protected List<File> mGet(Message<?> message, Session<F> session, String remoteDirectory, String remoteFilename) throws IOException - Throws:
IOException
-
getRemoteFilename
- Parameters:
remoteFilePath
- The remote file path.- Returns:
- The remote file name.
-
isDirectory
-
isLink
-
getFilename
-
getFilename
-
getModified
-
asFileInfoList
-
enhanceNameWithSubDirectory
-