Class SftpMessageHandler
java.lang.Object
org.springframework.integration.context.IntegrationObjectSupport
org.springframework.integration.handler.MessageHandlerSupport
org.springframework.integration.handler.AbstractMessageHandler
org.springframework.integration.file.remote.handler.FileTransferringMessageHandler<org.apache.sshd.sftp.client.SftpClient.DirEntry>
org.springframework.integration.sftp.outbound.SftpMessageHandler
- All Implemented Interfaces:
org.reactivestreams.Subscriber<Message<?>>
,Aware
,BeanFactoryAware
,BeanNameAware
,DisposableBean
,InitializingBean
,ApplicationContextAware
,Ordered
,ExpressionCapable
,Orderable
,IntegrationPattern
,NamedComponent
,IntegrationManagement
,TrackableComponent
,MessageHandler
,reactor.core.CoreSubscriber<Message<?>>
public class SftpMessageHandler
extends FileTransferringMessageHandler<org.apache.sshd.sftp.client.SftpClient.DirEntry>
Subclass of
FileTransferringMessageHandler
for SFTP.- Since:
- 4.3
- Author:
- Gary Russell, Artme Bilan
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement
IntegrationManagement.ManagementOverrides
-
Field Summary
Fields inherited from class org.springframework.integration.file.remote.handler.FileTransferringMessageHandler
remoteFileTemplate
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
ConstructorDescriptionSftpMessageHandler
(SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> sessionFactory) SftpMessageHandler
(SftpRemoteFileTemplate remoteFileTemplate) SftpMessageHandler
(SftpRemoteFileTemplate remoteFileTemplate, FileExistsMode mode) -
Method Summary
Modifier and TypeMethodDescriptionprotected void
doChmod
(RemoteFileTemplate<org.apache.sshd.sftp.client.SftpClient.DirEntry> remoteFileTemplate, String path, int chmod) Set the mode on the remote file after transfer; the default implementation does nothing.boolean
Methods inherited from class org.springframework.integration.file.remote.handler.FileTransferringMessageHandler
getTemporaryFileSuffix, handleMessageInternal, isUseTemporaryFileName, onInit, setAutoCreateDirectory, setCharset, setChmod, setChmodOctal, setFileNameGenerator, setRemoteDirectoryExpression, setRemoteDirectoryExpressionString, setRemoteFileSeparator, setTemporaryFileSuffix, setTemporaryRemoteDirectoryExpression, setTemporaryRemoteDirectoryExpressionString, setUseTemporaryFileName
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, getIntegrationPatternType, 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
-
SftpMessageHandler
- Parameters:
remoteFileTemplate
- the template.- See Also:
-
SftpMessageHandler
- Parameters:
remoteFileTemplate
- the template.mode
- the file exists mode.- See Also:
-
SftpMessageHandler
public SftpMessageHandler(SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> sessionFactory) - Parameters:
sessionFactory
- the session factory.- See Also:
-
-
Method Details
-
isChmodCapable
public boolean isChmodCapable()- Overrides:
isChmodCapable
in classFileTransferringMessageHandler<org.apache.sshd.sftp.client.SftpClient.DirEntry>
-
doChmod
protected void doChmod(RemoteFileTemplate<org.apache.sshd.sftp.client.SftpClient.DirEntry> remoteFileTemplate, String path, int chmod) Description copied from class:FileTransferringMessageHandler
Set the mode on the remote file after transfer; the default implementation does nothing.- Overrides:
doChmod
in classFileTransferringMessageHandler<org.apache.sshd.sftp.client.SftpClient.DirEntry>
- Parameters:
remoteFileTemplate
- the remote file template.path
- the path.chmod
- the chmod to set.
-