org.springframework.integration.ftp.outbound

Class FtpMessageHandler

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.commons.net.ftp.FTPFile>

org.springframework.integration.ftp.outbound.FtpMessageHandler

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 FtpMessageHandler
extends FileTransferringMessageHandler<org.apache.commons.net.ftp.FTPFile>

The FTP specific FileTransferringMessageHandler extension. Based on the FtpRemoteFileTemplate.

Since:

4.1.9

Author:

Artem Bilan, Deepak Gunasekaran

See Also:

FtpRemoteFileTemplate

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.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Constructor Summary

Constructors

Constructor and Description
FtpMessageHandler(FtpRemoteFileTemplate remoteFileTemplate)
FtpMessageHandler(FtpRemoteFileTemplate ftpRemoteFileTemplate, FileExistsMode mode) Constructor which sets the FtpRemoteFileTemplate and FileExistsMode.
FtpMessageHandler(RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate, FileExistsMode mode) Deprecated. in favor of FtpMessageHandler(FtpRemoteFileTemplate, FileExistsMode)
FtpMessageHandler(SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory)

Method Summary

Modifier and Type	Method and Description
protected void	doChmod(RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate, String path, int chmod) Set the mode on the remote file after transfer; the default implementation does nothing.
boolean	isChmodCapable()

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

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

buildSendTimer, destroy, getComponentType, getIntegrationPatternType, getManagedName, getManagedType, getMetricsCaptor, getOrder, getOverrides, isLoggingEnabled, registerMetricsCaptor, 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 Detail

FtpMessageHandler

public FtpMessageHandler(SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory)

FtpMessageHandler

public FtpMessageHandler(FtpRemoteFileTemplate remoteFileTemplate)

FtpMessageHandler

@Deprecated
public FtpMessageHandler(RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate,
                                     FileExistsMode mode)

Deprecated. in favor of FtpMessageHandler(FtpRemoteFileTemplate, FileExistsMode)

Constructor which sets the RemoteFileTemplate and FileExistsMode.

Parameters:

remoteFileTemplate - the remote file template.

mode - the file exists mode.

FtpMessageHandler

public FtpMessageHandler(FtpRemoteFileTemplate ftpRemoteFileTemplate,
                         FileExistsMode mode)

Constructor which sets the FtpRemoteFileTemplate and FileExistsMode.

Parameters:

ftpRemoteFileTemplate - the remote file template.

mode - the file exists mode.

Since:

5.4

Method Detail

isChmodCapable

public boolean isChmodCapable()

Overrides:

isChmodCapable in class FileTransferringMessageHandler<org.apache.commons.net.ftp.FTPFile>

doChmod

protected void doChmod(RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> 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 class FileTransferringMessageHandler<org.apache.commons.net.ftp.FTPFile>

Parameters:

remoteFileTemplate - the remote file template.

path - the path.

chmod - the chmod to set.