Class Ftp

java.lang.Object

org.springframework.integration.ftp.dsl.Ftp

public final class Ftp
extends Object

The factory for FTP components.

Since:

5.0

Author:

Artem Bilan, Gary Russell, Deepak Gunasekaran

Method Summary

Modifier and Type	Method	Description
static FtpInboundChannelAdapterSpec	inboundAdapter(SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory)	A FtpInboundChannelAdapterSpec factory for an inbound channel adapter spec.
static FtpInboundChannelAdapterSpec	inboundAdapter(SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory, Comparator<File> receptionOrderComparator)	A FtpInboundChannelAdapterSpec factory for an inbound channel adapter spec.
static FtpStreamingInboundChannelAdapterSpec	inboundStreamingAdapter(RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate)	A FtpStreamingInboundChannelAdapterSpec factory for an inbound channel adapter spec.
static FtpStreamingInboundChannelAdapterSpec	inboundStreamingAdapter(RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate, Comparator<org.apache.commons.net.ftp.FTPFile> receptionOrderComparator)	A FtpStreamingInboundChannelAdapterSpec factory for an inbound channel adapter spec.
static FtpMessageHandlerSpec	outboundAdapter(SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory)	A FtpMessageHandlerSpec factory for an outbound channel adapter spec.
static FtpMessageHandlerSpec	outboundAdapter(SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory, FileExistsMode fileExistsMode)	A FtpMessageHandlerSpec factory for an outbound channel adapter spec.
static FtpMessageHandlerSpec	outboundAdapter(FtpRemoteFileTemplate ftpRemoteFileTemplate)	A FtpMessageHandlerSpec factory for an outbound channel adapter spec.
static FtpMessageHandlerSpec	outboundAdapter(FtpRemoteFileTemplate ftpRemoteFileTemplate, FileExistsMode fileExistsMode)	A FtpMessageHandlerSpec factory for an outbound channel adapter spec.
static FtpOutboundGatewaySpec	outboundGateway(RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate, String command, String expression)	Produce a FtpOutboundGatewaySpec based on the RemoteFileTemplate, AbstractRemoteFileOutboundGateway.Command and expression for the remoteFilePath.
static FtpOutboundGatewaySpec	outboundGateway(RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate, AbstractRemoteFileOutboundGateway.Command command, String expression)	Produce a FtpOutboundGatewaySpec based on the RemoteFileTemplate, AbstractRemoteFileOutboundGateway.Command and expression for the remoteFilePath.
static FtpOutboundGatewaySpec	outboundGateway(SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory, String command, String expression)	Produce a FtpOutboundGatewaySpec based on the SessionFactory, AbstractRemoteFileOutboundGateway.Command and expression for the remoteFilePath.
static FtpOutboundGatewaySpec	outboundGateway(SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory, AbstractRemoteFileOutboundGateway.Command command, String expression)	Produce a FtpOutboundGatewaySpec based on the SessionFactory, AbstractRemoteFileOutboundGateway.Command and expression for the remoteFilePath.
static FtpOutboundGatewaySpec	outboundGateway(SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory, MessageSessionCallback<org.apache.commons.net.ftp.FTPFile,?> messageSessionCallback)	Produce a FtpOutboundGatewaySpec based on the MessageSessionCallback.

Methods inherited from class java.lang.Object

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

Method Details

inboundAdapter

public static FtpInboundChannelAdapterSpec inboundAdapter(SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory)

A FtpInboundChannelAdapterSpec factory for an inbound channel adapter spec.

Parameters:

sessionFactory - the session factory.

Returns:

the spec.

inboundAdapter

public static FtpInboundChannelAdapterSpec inboundAdapter(SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory,
 @Nullable
 Comparator<File> receptionOrderComparator)

A FtpInboundChannelAdapterSpec factory for an inbound channel adapter spec.

Parameters:

sessionFactory - the session factory.

receptionOrderComparator - the comparator.

Returns:

the spec.

inboundStreamingAdapter

public static FtpStreamingInboundChannelAdapterSpec inboundStreamingAdapter(RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate)

A FtpStreamingInboundChannelAdapterSpec factory for an inbound channel adapter spec.

Parameters:

remoteFileTemplate - the remote file template.

Returns:

the spec.

inboundStreamingAdapter

public static FtpStreamingInboundChannelAdapterSpec inboundStreamingAdapter(RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate,
 @Nullable
 Comparator<org.apache.commons.net.ftp.FTPFile> receptionOrderComparator)

A FtpStreamingInboundChannelAdapterSpec factory for an inbound channel adapter spec.

Parameters:

remoteFileTemplate - the remote file template.

receptionOrderComparator - the comparator.

Returns:

the spec.

outboundAdapter

public static FtpMessageHandlerSpec outboundAdapter(SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory)

A FtpMessageHandlerSpec factory for an outbound channel adapter spec.

Parameters:

sessionFactory - the session factory.

Returns:

the spec.

outboundAdapter

public static FtpMessageHandlerSpec outboundAdapter(SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory,
 FileExistsMode fileExistsMode)

A FtpMessageHandlerSpec factory for an outbound channel adapter spec.

Parameters:

sessionFactory - the session factory.

fileExistsMode - the file exists mode.

Returns:

the spec.

outboundAdapter

public static FtpMessageHandlerSpec outboundAdapter(FtpRemoteFileTemplate ftpRemoteFileTemplate)

A FtpMessageHandlerSpec factory for an outbound channel adapter spec.

Parameters:

ftpRemoteFileTemplate - the remote file template.

Returns:

the spec.

Since:

5.4

outboundAdapter

public static FtpMessageHandlerSpec outboundAdapter(FtpRemoteFileTemplate ftpRemoteFileTemplate,
 FileExistsMode fileExistsMode)

A FtpMessageHandlerSpec factory for an outbound channel adapter spec.

Parameters:

ftpRemoteFileTemplate - the remote file template.

fileExistsMode - the file exists mode.

Returns:

the spec.

Since:

5.4

outboundGateway

public static FtpOutboundGatewaySpec outboundGateway(SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory,
 AbstractRemoteFileOutboundGateway.Command command,
 String expression)

Produce a FtpOutboundGatewaySpec based on the SessionFactory, AbstractRemoteFileOutboundGateway.Command and expression for the remoteFilePath.

Parameters:

sessionFactory - the SessionFactory.

command - the command to perform on the FTP.

expression - the remoteFilePath SpEL expression.

Returns:

the FtpOutboundGatewaySpec

outboundGateway

public static FtpOutboundGatewaySpec outboundGateway(SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory,
 String command,
 String expression)

Produce a FtpOutboundGatewaySpec based on the SessionFactory, AbstractRemoteFileOutboundGateway.Command and expression for the remoteFilePath.

Parameters:

sessionFactory - the SessionFactory.

command - the command to perform on the FTP.

expression - the remoteFilePath SpEL expression.

Returns:

the FtpOutboundGatewaySpec

See Also:

• RemoteFileTemplate

outboundGateway

public static FtpOutboundGatewaySpec outboundGateway(RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate,
 AbstractRemoteFileOutboundGateway.Command command,
 String expression)

Produce a FtpOutboundGatewaySpec based on the RemoteFileTemplate, AbstractRemoteFileOutboundGateway.Command and expression for the remoteFilePath.

Parameters:

remoteFileTemplate - the RemoteFileTemplate.

command - the command to perform on the FTP.

expression - the remoteFilePath SpEL expression.

Returns:

the FtpOutboundGatewaySpec

See Also:

• RemoteFileTemplate

outboundGateway

public static FtpOutboundGatewaySpec outboundGateway(RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate,
 String command,
 String expression)

Produce a FtpOutboundGatewaySpec based on the RemoteFileTemplate, AbstractRemoteFileOutboundGateway.Command and expression for the remoteFilePath.

Parameters:

remoteFileTemplate - the RemoteFileTemplate.

command - the command to perform on the FTP.

expression - the remoteFilePath SpEL expression.

Returns:

the FtpOutboundGatewaySpec

See Also:

• RemoteFileTemplate

outboundGateway

public static FtpOutboundGatewaySpec outboundGateway(SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory,
 MessageSessionCallback<org.apache.commons.net.ftp.FTPFile,?> messageSessionCallback)

Produce a FtpOutboundGatewaySpec based on the MessageSessionCallback.

Parameters:

sessionFactory - the SessionFactory to connect to.

messageSessionCallback - the MessageSessionCallback to perform SFTP operation(s) with the Message context.

Returns:

the FtpOutboundGatewaySpec

See Also:

• MessageSessionCallback