org.springframework.integration.sftp.gateway

Class SftpOutboundGateway

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractMessageProducingHandler

org.springframework.integration.handler.AbstractReplyProducingMessageHandler

org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway<com.jcraft.jsch.ChannelSftp.LsEntry>

org.springframework.integration.sftp.gateway.SftpOutboundGateway

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, Ordered, Orderable, MessageProducer, TrackableComponent, NamedComponent, MessageHandler

public class SftpOutboundGateway
extends AbstractRemoteFileOutboundGateway<com.jcraft.jsch.ChannelSftp.LsEntry>

Outbound Gateway for performing remote file operations via SFTP.

Since:

2.1

Author:

Gary Russell

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

Field Summary

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

command, options

Fields inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler

messagingTemplate

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
SftpOutboundGateway(SessionFactory<com.jcraft.jsch.ChannelSftp.LsEntry> sessionFactory, java.lang.String command, java.lang.String expression)

Method Summary

Modifier and Type	Method and Description
protected java.util.List<AbstractFileInfo<com.jcraft.jsch.ChannelSftp.LsEntry>>	asFileInfoList(java.util.Collection<com.jcraft.jsch.ChannelSftp.LsEntry> files)
protected com.jcraft.jsch.ChannelSftp.LsEntry	enhanceNameWithSubDirectory(com.jcraft.jsch.ChannelSftp.LsEntry file, java.lang.String directory)
java.lang.String	getComponentType() Subclasses may implement this method to provide component type information.
protected java.lang.String	getFilename(AbstractFileInfo<com.jcraft.jsch.ChannelSftp.LsEntry> file)
protected java.lang.String	getFilename(com.jcraft.jsch.ChannelSftp.LsEntry file)
protected long	getModified(com.jcraft.jsch.ChannelSftp.LsEntry file)
protected boolean	isDirectory(com.jcraft.jsch.ChannelSftp.LsEntry file)
protected boolean	isLink(com.jcraft.jsch.ChannelSftp.LsEntry file)

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

doInit, filterFiles, filterMputFiles, get, getRemoteFilename, handleRequestMessage, ls, mGet, purgeDots, purgeLinks, setAutoCreateLocalDirectory, setExpressionRename, setFilter, setLocalDirectory, setLocalDirectoryExpression, setLocalFilenameGeneratorExpression, setMputFilter, setOptions, setRemoteFileSeparator, setRenameExpression, setTemporaryFileSuffix

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

doInvokeAdvisedRequestHandler, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setRequiresReply

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

getOutputChannel, produceOutput, sendOutputs, setChannelResolver, setOutputChannel, setOutputChannelName, setSendTimeout, shouldCopyRequestHeaders, shouldSplitOutput

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

getOrder, handleMessage, setOrder, setShouldTrack

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

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

Constructor Detail

SftpOutboundGateway

public SftpOutboundGateway(SessionFactory<com.jcraft.jsch.ChannelSftp.LsEntry> sessionFactory,
                           java.lang.String command,
                           java.lang.String expression)

Method Detail

isDirectory

protected boolean isDirectory(com.jcraft.jsch.ChannelSftp.LsEntry file)

Specified by:

isDirectory in class AbstractRemoteFileOutboundGateway<com.jcraft.jsch.ChannelSftp.LsEntry>

isLink

protected boolean isLink(com.jcraft.jsch.ChannelSftp.LsEntry file)

Specified by:

isLink in class AbstractRemoteFileOutboundGateway<com.jcraft.jsch.ChannelSftp.LsEntry>

getFilename

protected java.lang.String getFilename(com.jcraft.jsch.ChannelSftp.LsEntry file)

Specified by:

getFilename in class AbstractRemoteFileOutboundGateway<com.jcraft.jsch.ChannelSftp.LsEntry>

getFilename

protected java.lang.String getFilename(AbstractFileInfo<com.jcraft.jsch.ChannelSftp.LsEntry> file)

Specified by:

getFilename in class AbstractRemoteFileOutboundGateway<com.jcraft.jsch.ChannelSftp.LsEntry>

asFileInfoList

protected java.util.List<AbstractFileInfo<com.jcraft.jsch.ChannelSftp.LsEntry>> asFileInfoList(java.util.Collection<com.jcraft.jsch.ChannelSftp.LsEntry> files)

Specified by:

asFileInfoList in class AbstractRemoteFileOutboundGateway<com.jcraft.jsch.ChannelSftp.LsEntry>

getModified

protected long getModified(com.jcraft.jsch.ChannelSftp.LsEntry file)

Specified by:

getModified in class AbstractRemoteFileOutboundGateway<com.jcraft.jsch.ChannelSftp.LsEntry>

enhanceNameWithSubDirectory

protected com.jcraft.jsch.ChannelSftp.LsEntry enhanceNameWithSubDirectory(com.jcraft.jsch.ChannelSftp.LsEntry file,
                                                                          java.lang.String directory)

Specified by:

enhanceNameWithSubDirectory in class AbstractRemoteFileOutboundGateway<com.jcraft.jsch.ChannelSftp.LsEntry>

getComponentType

public java.lang.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 AbstractMessageHandler