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.outbound.SftpOutboundGateway

org.springframework.integration.sftp.gateway.SftpOutboundGateway

All Implemented Interfaces:

org.reactivestreams.Subscriber<Message<?>>, Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Ordered, ComponentSourceAware, ExpressionCapable, Orderable, MessageProducer, HeaderPropagationAware, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>

@Deprecated(forRemoval=true,
            since="7.0")
public class SftpOutboundGateway
extends SftpOutboundGateway

Deprecated, for removal: This API element is subject to removal in a future version.

since 7.0 in favor of SftpOutboundGateway

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, @Nullable String expression)	Deprecated, for removal: This API element is subject to removal in a future version. Construct an instance with the supplied remote file template, a command ('ls', 'get' etc.), and an expression to determine the remote path.
SftpOutboundGateway(RemoteFileTemplate<org.apache.sshd.sftp.client.SftpClient.DirEntry> remoteFileTemplate, MessageSessionCallback<org.apache.sshd.sftp.client.SftpClient.DirEntry, ?> messageSessionCallback)	Deprecated, for removal: This API element is subject to removal in a future version. 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, @Nullable String expression)	Deprecated, for removal: This API element is subject to removal in a future version. Construct an instance with the supplied session factory, a command ('ls', 'get' etc.), and an expression to determine the remote path.
SftpOutboundGateway(SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> sessionFactory, MessageSessionCallback<org.apache.sshd.sftp.client.SftpClient.DirEntry, ?> messageSessionCallback)	Deprecated, for removal: This API element is subject to removal in a future version. Construct an instance using the provided session factory and callback for performing operations on the session.

Method Summary

Methods inherited from class org.springframework.integration.sftp.outbound.SftpOutboundGateway

asFileInfoList, doChmod, enhanceNameWithSubDirectory, getComponentType, getFilename, getFilename, getModified, isChmodCapable, isDirectory, isLink

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, setFileExistsModeExpression, setFileExistsModeExpressionString, 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, getComponentDescription, getComponentName, getComponentSource, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, 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)

Deprecated, for removal: This API element is subject to removal in a future version.

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)

Deprecated, for removal: This API element is subject to removal in a future version.

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,
 @Nullable String expression)

Deprecated, for removal: This API element is subject to removal in a future version.

Construct an instance with the supplied session factory, a command ('ls', 'get' etc.), and an expression to determine the remote path.

Parameters:

sessionFactory - the session factory.

command - the command.

expression - the remote path expression.

SftpOutboundGateway

public SftpOutboundGateway(RemoteFileTemplate<org.apache.sshd.sftp.client.SftpClient.DirEntry> remoteFileTemplate,
 String command,
 @Nullable String expression)

Deprecated, for removal: This API element is subject to removal in a future version.

Construct an instance with the supplied remote file template, a command ('ls', 'get' etc.), and an expression to determine the remote path.

Parameters:

remoteFileTemplate - the remote file template.

command - the command.

expression - the remote path expression.