Package org.springframework.integration.sftp.gateway

Class SftpOutboundGateway

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<org.apache.sshd.sftp.client.SftpClient.DirEntry>

org.springframework.integration.sftp.gateway.SftpOutboundGateway

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<?>>

public class SftpOutboundGateway
extends AbstractRemoteFileOutboundGateway<org.apache.sshd.sftp.client.SftpClient.DirEntry>

Outbound Gateway for performing remote file operations via SFTP.

Since:

2.1

Author:

Gary Russell, Artem Bilan

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway

AbstractRemoteFileOutboundGateway.Command, AbstractRemoteFileOutboundGateway.Option

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

Constructors

Constructor	Description
SftpOutboundGateway(RemoteFileTemplate<org.apache.sshd.sftp.client.SftpClient.DirEntry> 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.
SftpOutboundGateway(RemoteFileTemplate<org.apache.sshd.sftp.client.SftpClient.DirEntry> remoteFileTemplate, MessageSessionCallback<org.apache.sshd.sftp.client.SftpClient.DirEntry,?> messageSessionCallback)	Construct an instance with the supplied remote file template and callback for performing operations on the session.
SftpOutboundGateway(SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> 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.
SftpOutboundGateway(SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> sessionFactory, MessageSessionCallback<org.apache.sshd.sftp.client.SftpClient.DirEntry,?> messageSessionCallback)	Construct an instance using the provided session factory and callback for performing operations on the session.

Method Summary

Modifier and Type	Method	Description
protected List<AbstractFileInfo<org.apache.sshd.sftp.client.SftpClient.DirEntry>>	asFileInfoList(Collection<org.apache.sshd.sftp.client.SftpClient.DirEntry> files)
protected void	doChmod(RemoteFileOperations<org.apache.sshd.sftp.client.SftpClient.DirEntry> remoteFileOperations, String path, int chmod)	Set the mode on the remote file after transfer; the default implementation does nothing.
protected org.apache.sshd.sftp.client.SftpClient.DirEntry	enhanceNameWithSubDirectory(org.apache.sshd.sftp.client.SftpClient.DirEntry file, String directory)
String	getComponentType()	Subclasses may implement this method to provide component type information.
protected String	getFilename(org.apache.sshd.sftp.client.SftpClient.DirEntry file)
protected String	getFilename(AbstractFileInfo<org.apache.sshd.sftp.client.SftpClient.DirEntry> file)
protected long	getModified(org.apache.sshd.sftp.client.SftpClient.DirEntry file)
boolean	isChmodCapable()
protected boolean	isDirectory(org.apache.sshd.sftp.client.SftpClient.DirEntry file)
protected boolean	isLink(org.apache.sshd.sftp.client.SftpClient.DirEntry file)

Methods inherited from class org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway

assertRemoteFileTemplateMutability, doInit, filterFile, filterFiles, filterMputFiles, get, getFullFileName, getRemoteFilename, getRemoteFileTemplate, handleRequestMessage, ls, mGet, mPut, mv, nlst, purgeDots, purgeLinks, put, remoteFileTemplateExplicitlySet, rm, setAutoCreateDirectory, setAutoCreateLocalDirectory, setCharset, setChmod, setChmodOctal, setFileExistsMode, setFileNameExpression, setFileNameGenerator, setFilter, setLocalDirectory, setLocalDirectoryExpression, setLocalDirectoryExpressionString, setLocalFilenameGeneratorExpression, setLocalFilenameGeneratorExpressionString, setMputFilter, setOption, setOptions, setRemoteDirectoryExpression, setRemoteFileSeparator, setRenameExpression, setRenameExpressionString, setTemporaryFileSuffix, setTemporaryRemoteDirectoryExpression, setUseTemporaryFileName

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, 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, 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

SftpOutboundGateway

public SftpOutboundGateway(SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> sessionFactory,
 MessageSessionCallback<org.apache.sshd.sftp.client.SftpClient.DirEntry,?> 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.

SftpOutboundGateway

public SftpOutboundGateway(RemoteFileTemplate<org.apache.sshd.sftp.client.SftpClient.DirEntry> remoteFileTemplate,
 MessageSessionCallback<org.apache.sshd.sftp.client.SftpClient.DirEntry,?> 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.

SftpOutboundGateway

public SftpOutboundGateway(SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> 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.

Parameters:

sessionFactory - the session factory.

command - the command.

expression - the filename expression.

SftpOutboundGateway

public SftpOutboundGateway(RemoteFileTemplate<org.apache.sshd.sftp.client.SftpClient.DirEntry> 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.

Parameters:

remoteFileTemplate - the remote file template.

command - the command.

expression - the filename expression.

Method Details

isDirectory

protected boolean isDirectory(org.apache.sshd.sftp.client.SftpClient.DirEntry file)

Specified by:

isDirectory in class AbstractRemoteFileOutboundGateway<org.apache.sshd.sftp.client.SftpClient.DirEntry>

isLink

protected boolean isLink(org.apache.sshd.sftp.client.SftpClient.DirEntry file)

Specified by:

isLink in class AbstractRemoteFileOutboundGateway<org.apache.sshd.sftp.client.SftpClient.DirEntry>

getFilename

protected String getFilename(org.apache.sshd.sftp.client.SftpClient.DirEntry file)

Specified by:

getFilename in class AbstractRemoteFileOutboundGateway<org.apache.sshd.sftp.client.SftpClient.DirEntry>

getFilename

protected String getFilename(AbstractFileInfo<org.apache.sshd.sftp.client.SftpClient.DirEntry> file)

Specified by:

getFilename in class AbstractRemoteFileOutboundGateway<org.apache.sshd.sftp.client.SftpClient.DirEntry>

asFileInfoList

protected List<AbstractFileInfo<org.apache.sshd.sftp.client.SftpClient.DirEntry>> asFileInfoList(Collection<org.apache.sshd.sftp.client.SftpClient.DirEntry> files)

Specified by:

asFileInfoList in class AbstractRemoteFileOutboundGateway<org.apache.sshd.sftp.client.SftpClient.DirEntry>

getModified

protected long getModified(org.apache.sshd.sftp.client.SftpClient.DirEntry file)

Specified by:

getModified in class AbstractRemoteFileOutboundGateway<org.apache.sshd.sftp.client.SftpClient.DirEntry>

enhanceNameWithSubDirectory

protected org.apache.sshd.sftp.client.SftpClient.DirEntry enhanceNameWithSubDirectory(org.apache.sshd.sftp.client.SftpClient.DirEntry file,
 String directory)

Specified by:

enhanceNameWithSubDirectory in class AbstractRemoteFileOutboundGateway<org.apache.sshd.sftp.client.SftpClient.DirEntry>

getComponentType

public String getComponentType()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this method to provide component type information.

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class MessageHandlerSupport

isChmodCapable

public boolean isChmodCapable()

Overrides:

isChmodCapable in class AbstractRemoteFileOutboundGateway<org.apache.sshd.sftp.client.SftpClient.DirEntry>

doChmod

protected void doChmod(RemoteFileOperations<org.apache.sshd.sftp.client.SftpClient.DirEntry> remoteFileOperations,
 String path,
 int chmod)

Description copied from class: AbstractRemoteFileOutboundGateway

Set the mode on the remote file after transfer; the default implementation does nothing.

Overrides:

doChmod in class AbstractRemoteFileOutboundGateway<org.apache.sshd.sftp.client.SftpClient.DirEntry>

Parameters:

remoteFileOperations - the remote file template.

path - the path.

chmod - the chmod to set.