Package org.springframework.integration.ftp.dsl

Class FtpOutboundGatewaySpec

java.lang.Object

org.springframework.integration.dsl.IntegrationComponentSpec<S,H>

org.springframework.integration.dsl.MessageHandlerSpec<S,AbstractRemoteFileOutboundGateway<F>>

org.springframework.integration.file.dsl.RemoteFileOutboundGatewaySpec<org.apache.commons.net.ftp.FTPFile,FtpOutboundGatewaySpec>

org.springframework.integration.ftp.dsl.FtpOutboundGatewaySpec

All Implemented Interfaces:

DisposableBean, FactoryBean<AbstractRemoteFileOutboundGateway<org.apache.commons.net.ftp.FTPFile>>, InitializingBean, Lifecycle, Phased, SmartLifecycle, ComponentsRegistration

public class FtpOutboundGatewaySpec
extends RemoteFileOutboundGatewaySpec<org.apache.commons.net.ftp.FTPFile,FtpOutboundGatewaySpec>

A RemoteFileOutboundGatewaySpec for FTP.

Since:

5.0

Author:

Artem Bilan

Field Summary

Fields inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

logger, PARSER, target

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FtpOutboundGatewaySpec(FtpOutboundGateway outboundGateway)

Method Summary

Modifier and Type	Method	Description
FtpOutboundGatewaySpec	patternFileNameFilter(String pattern)	Specify a simple pattern to match remote files (e.g.
FtpOutboundGatewaySpec	regexFileNameFilter(String regex)	Specify a simple pattern to match remote files (e.g.
FtpOutboundGatewaySpec	workingDirExpression(String workingDirExpression)	Specify a SpEL Expression to evaluate FTP client working directory against request message.
FtpOutboundGatewaySpec	workingDirExpression(Expression workingDirExpression)	Specify a SpEL Expression to evaluate FTP client working directory against request message.
FtpOutboundGatewaySpec	workingDirFunction(Function<Message<?>,String> workingDirFunction)	Specify a Function to evaluate FTP client working directory against request message.

Methods inherited from class org.springframework.integration.file.dsl.RemoteFileOutboundGatewaySpec

autoCreateDirectory, autoCreateLocalDirectory, charset, chmod, fileExistsMode, fileNameExpression, fileNameExpression, fileNameFunction, fileNameGenerator, filter, filterExpression, filterFunction, getComponentsToRegister, localDirectory, localDirectory, localDirectoryExpression, localDirectoryExpression, localFilenameExpression, localFilenameExpression, localFilenameFunction, mputFilter, mputFilterExpression, mputFilterFunction, options, options, patternMputFilter, regexMputFilter, remoteDirectoryExpression, remoteDirectoryExpression, remoteDirectoryFunction, remoteFileSeparator, renameExpression, renameExpression, renameFunction, temporaryFileSuffix, temporaryRemoteDirectoryExpression, temporaryRemoteDirectoryExpression, temporaryRemoteDirectoryFunction, useTemporaryFileName

Methods inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

_this, afterPropertiesSet, destroy, doGet, get, getId, getObject, getObjectType, getPhase, id, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.beans.factory.FactoryBean

isSingleton

Constructor Details

FtpOutboundGatewaySpec

protected FtpOutboundGatewaySpec(FtpOutboundGateway outboundGateway)

Method Details

patternFileNameFilter

public FtpOutboundGatewaySpec patternFileNameFilter(String pattern)

Description copied from class: RemoteFileOutboundGatewaySpec

Specify a simple pattern to match remote files (e.g. '*.txt').

Specified by:

patternFileNameFilter in class RemoteFileOutboundGatewaySpec<org.apache.commons.net.ftp.FTPFile,FtpOutboundGatewaySpec>

Parameters:

pattern - the pattern.

Returns:

the spec.

See Also:

• FtpSimplePatternFileListFilter

regexFileNameFilter

public FtpOutboundGatewaySpec regexFileNameFilter(String regex)

Description copied from class: RemoteFileOutboundGatewaySpec

Specify a simple pattern to match remote files (e.g. '[0-9].*.txt').

Specified by:

regexFileNameFilter in class RemoteFileOutboundGatewaySpec<org.apache.commons.net.ftp.FTPFile,FtpOutboundGatewaySpec>

Parameters:

regex - the regex pattern.

Returns:

the spec.

See Also:

• FtpRegexPatternFileListFilter

workingDirExpression

public FtpOutboundGatewaySpec workingDirExpression(String workingDirExpression)

Specify a SpEL Expression to evaluate FTP client working directory against request message.

Parameters:

workingDirExpression - the SpEL expression to evaluate working directory

Returns:

the spec

See Also:

• FtpOutboundGateway.setWorkingDirExpression(Expression)

workingDirExpression

public FtpOutboundGatewaySpec workingDirExpression(Expression workingDirExpression)

Specify a SpEL Expression to evaluate FTP client working directory against request message.

Parameters:

workingDirExpression - the SpEL expression to evaluate working directory

Returns:

the spec

See Also:

• FtpOutboundGateway.setWorkingDirExpression(Expression)

workingDirFunction

public FtpOutboundGatewaySpec workingDirFunction(Function<Message<?>,String> workingDirFunction)

Specify a Function to evaluate FTP client working directory against request message.

Parameters:

workingDirFunction - the function to evaluate working directory

Returns:

the spec

See Also:

• FtpOutboundGateway.setWorkingDirExpression(Expression)