org.springframework.integration.dsl.file

Class RemoteFileOutboundGatewaySpec<F,S extends RemoteFileOutboundGatewaySpec<F,S>>

java.lang.Object

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

org.springframework.integration.dsl.core.MessageHandlerSpec<S,org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway<F>>

org.springframework.integration.dsl.file.RemoteFileOutboundGatewaySpec<F,S>

Type Parameters:

F - the target file type.

S - the target RemoteFileOutboundGatewaySpec implementation type.

All Implemented Interfaces:

org.springframework.beans.factory.FactoryBean<org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway<F>>

Direct Known Subclasses:

FtpOutboundGatewaySpec, SftpOutboundGatewaySpec

public abstract class RemoteFileOutboundGatewaySpec<F,S extends RemoteFileOutboundGatewaySpec<F,S>>
extends MessageHandlerSpec<S,org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway<F>>

Author:

Artem Bilan

Field Summary

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

logger, PARSER, target

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RemoteFileOutboundGatewaySpec(org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway<F> outboundGateway)

Method Summary

Modifier and Type	Method and Description
S	autoCreateLocalDirectory(boolean autoCreateLocalDirectory)
S	filter(org.springframework.integration.file.filters.FileListFilter<F> filter)
S	localDirectory(java.io.File localDirectory)
<P> S	localDirectory(Function<org.springframework.messaging.Message<P>,java.lang.String> localDirectoryFunction)
S	localDirectoryExpression(org.springframework.expression.Expression localDirectoryExpression)
S	localDirectoryExpression(java.lang.String localDirectoryExpression)
<P> S	localFilename(Function<org.springframework.messaging.Message<P>,java.lang.String> localFilenameFunction)
S	localFilenameExpression(org.springframework.expression.Expression localFilenameExpression)
S	localFilenameExpression(java.lang.String localFilenameExpression)
S	mputFilter(org.springframework.integration.file.filters.FileListFilter<java.io.File> filter)
S	options(org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway.Option... options)
S	options(java.lang.String options)
abstract S	patternFileNameFilter(java.lang.String pattern)
S	patternMputFilter(java.lang.String pattern)
abstract S	regexFileNameFilter(java.lang.String regex)
S	regexMpuFilter(java.lang.String regex)
S	remoteFileSeparator(java.lang.String remoteFileSeparator)
S	renameExpression(java.lang.String expression)
S	temporaryFileSuffix(java.lang.String temporaryFileSuffix)

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

_this, doGet, get, getId, getObject, getObjectType, id, isSingleton

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteFileOutboundGatewaySpec

protected RemoteFileOutboundGatewaySpec(org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway<F> outboundGateway)

Method Detail

options

public S options(java.lang.String options)

options

public S options(org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway.Option... options)

remoteFileSeparator

public S remoteFileSeparator(java.lang.String remoteFileSeparator)

localDirectory

public S localDirectory(java.io.File localDirectory)

localDirectoryExpression

public S localDirectoryExpression(java.lang.String localDirectoryExpression)

localDirectory

public <P> S localDirectory(Function<org.springframework.messaging.Message<P>,java.lang.String> localDirectoryFunction)

localDirectoryExpression

public S localDirectoryExpression(org.springframework.expression.Expression localDirectoryExpression)

Parameters:

localDirectoryExpression - a SpEL expression to evaluate the local directory.

Returns:

the Spec.

Since:

1.1.1

autoCreateLocalDirectory

public S autoCreateLocalDirectory(boolean autoCreateLocalDirectory)

temporaryFileSuffix

public S temporaryFileSuffix(java.lang.String temporaryFileSuffix)

filter

public S filter(org.springframework.integration.file.filters.FileListFilter<F> filter)

patternFileNameFilter

public abstract S patternFileNameFilter(java.lang.String pattern)

regexFileNameFilter

public abstract S regexFileNameFilter(java.lang.String regex)

mputFilter

public S mputFilter(org.springframework.integration.file.filters.FileListFilter<java.io.File> filter)

patternMputFilter

public S patternMputFilter(java.lang.String pattern)

regexMpuFilter

public S regexMpuFilter(java.lang.String regex)

renameExpression

public S renameExpression(java.lang.String expression)

localFilenameExpression

public S localFilenameExpression(java.lang.String localFilenameExpression)

localFilename

public <P> S localFilename(Function<org.springframework.messaging.Message<P>,java.lang.String> localFilenameFunction)

localFilenameExpression

public S localFilenameExpression(org.springframework.expression.Expression localFilenameExpression)

Parameters:

localFilenameExpression - a SpEL expression to evaluate the local file name.

Returns:

the Spec.

Since:

1.1.1