Class Ftp
java.lang.Object
org.springframework.integration.ftp.dsl.Ftp
public final class Ftp
extends java.lang.Object
The factory for FTP components.
- Since:
- 5.0
-
Method Summary
Modifier and Type Method Description static FtpInboundChannelAdapterSpec
inboundAdapter(org.springframework.integration.file.remote.session.SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory)
AFtpInboundChannelAdapterSpec
factory for an inbound channel adapter spec.static FtpInboundChannelAdapterSpec
inboundAdapter(org.springframework.integration.file.remote.session.SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory, java.util.Comparator<java.io.File> receptionOrderComparator)
AFtpInboundChannelAdapterSpec
factory for an inbound channel adapter spec.static FtpStreamingInboundChannelAdapterSpec
inboundStreamingAdapter(org.springframework.integration.file.remote.RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate)
AFtpStreamingInboundChannelAdapterSpec
factory for an inbound channel adapter spec.static FtpStreamingInboundChannelAdapterSpec
inboundStreamingAdapter(org.springframework.integration.file.remote.RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate, java.util.Comparator<org.apache.commons.net.ftp.FTPFile> receptionOrderComparator)
AFtpStreamingInboundChannelAdapterSpec
factory for an inbound channel adapter spec.static FtpMessageHandlerSpec
outboundAdapter(org.springframework.integration.file.remote.RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate)
Deprecated.in favor ofoutboundAdapter(FtpRemoteFileTemplate)
static FtpMessageHandlerSpec
outboundAdapter(org.springframework.integration.file.remote.RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate, org.springframework.integration.file.support.FileExistsMode fileExistsMode)
Deprecated.static FtpMessageHandlerSpec
outboundAdapter(org.springframework.integration.file.remote.session.SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory)
AFtpMessageHandlerSpec
factory for an outbound channel adapter spec.static FtpMessageHandlerSpec
outboundAdapter(org.springframework.integration.file.remote.session.SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory, org.springframework.integration.file.support.FileExistsMode fileExistsMode)
AFtpMessageHandlerSpec
factory for an outbound channel adapter spec.static FtpMessageHandlerSpec
outboundAdapter(FtpRemoteFileTemplate ftpRemoteFileTemplate)
AFtpMessageHandlerSpec
factory for an outbound channel adapter spec.static FtpMessageHandlerSpec
outboundAdapter(FtpRemoteFileTemplate ftpRemoteFileTemplate, org.springframework.integration.file.support.FileExistsMode fileExistsMode)
AFtpMessageHandlerSpec
factory for an outbound channel adapter spec.static FtpOutboundGatewaySpec
outboundGateway(org.springframework.integration.file.remote.RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate, java.lang.String command, java.lang.String expression)
Produce aFtpOutboundGatewaySpec
based on theRemoteFileTemplate
,AbstractRemoteFileOutboundGateway.Command
andexpression
for the remoteFilePath.static FtpOutboundGatewaySpec
outboundGateway(org.springframework.integration.file.remote.RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate, org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway.Command command, java.lang.String expression)
Produce aFtpOutboundGatewaySpec
based on theRemoteFileTemplate
,AbstractRemoteFileOutboundGateway.Command
andexpression
for the remoteFilePath.static FtpOutboundGatewaySpec
outboundGateway(org.springframework.integration.file.remote.session.SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory, java.lang.String command, java.lang.String expression)
Produce aFtpOutboundGatewaySpec
based on theSessionFactory
,AbstractRemoteFileOutboundGateway.Command
andexpression
for the remoteFilePath.static FtpOutboundGatewaySpec
outboundGateway(org.springframework.integration.file.remote.session.SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory, org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway.Command command, java.lang.String expression)
Produce aFtpOutboundGatewaySpec
based on theSessionFactory
,AbstractRemoteFileOutboundGateway.Command
andexpression
for the remoteFilePath.static FtpOutboundGatewaySpec
outboundGateway(org.springframework.integration.file.remote.session.SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory, org.springframework.integration.file.remote.MessageSessionCallback<org.apache.commons.net.ftp.FTPFile,?> messageSessionCallback)
Produce aFtpOutboundGatewaySpec
based on theMessageSessionCallback
.
-
Method Details
-
inboundAdapter
public static FtpInboundChannelAdapterSpec inboundAdapter(org.springframework.integration.file.remote.session.SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory)AFtpInboundChannelAdapterSpec
factory for an inbound channel adapter spec.- Parameters:
sessionFactory
- the session factory.- Returns:
- the spec.
-
inboundAdapter
public static FtpInboundChannelAdapterSpec inboundAdapter(org.springframework.integration.file.remote.session.SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory, java.util.Comparator<java.io.File> receptionOrderComparator)AFtpInboundChannelAdapterSpec
factory for an inbound channel adapter spec.- Parameters:
sessionFactory
- the session factory.receptionOrderComparator
- the comparator.- Returns:
- the spec.
-
inboundStreamingAdapter
public static FtpStreamingInboundChannelAdapterSpec inboundStreamingAdapter(org.springframework.integration.file.remote.RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate)AFtpStreamingInboundChannelAdapterSpec
factory for an inbound channel adapter spec.- Parameters:
remoteFileTemplate
- the remote file template.- Returns:
- the spec.
-
inboundStreamingAdapter
public static FtpStreamingInboundChannelAdapterSpec inboundStreamingAdapter(org.springframework.integration.file.remote.RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate, java.util.Comparator<org.apache.commons.net.ftp.FTPFile> receptionOrderComparator)AFtpStreamingInboundChannelAdapterSpec
factory for an inbound channel adapter spec.- Parameters:
remoteFileTemplate
- the remote file template.receptionOrderComparator
- the comparator.- Returns:
- the spec.
-
outboundAdapter
public static FtpMessageHandlerSpec outboundAdapter(org.springframework.integration.file.remote.session.SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory)AFtpMessageHandlerSpec
factory for an outbound channel adapter spec.- Parameters:
sessionFactory
- the session factory.- Returns:
- the spec.
-
outboundAdapter
public static FtpMessageHandlerSpec outboundAdapter(org.springframework.integration.file.remote.session.SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory, org.springframework.integration.file.support.FileExistsMode fileExistsMode)AFtpMessageHandlerSpec
factory for an outbound channel adapter spec.- Parameters:
sessionFactory
- the session factory.fileExistsMode
- the file exists mode.- Returns:
- the spec.
-
outboundAdapter
@Deprecated public static FtpMessageHandlerSpec outboundAdapter(org.springframework.integration.file.remote.RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate)Deprecated.in favor ofoutboundAdapter(FtpRemoteFileTemplate)
AFtpMessageHandlerSpec
factory for an outbound channel adapter spec.- Parameters:
remoteFileTemplate
- the remote file template.- Returns:
- the spec.
-
outboundAdapter
@Deprecated public static FtpMessageHandlerSpec outboundAdapter(org.springframework.integration.file.remote.RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate, org.springframework.integration.file.support.FileExistsMode fileExistsMode)Deprecated.AFtpMessageHandlerSpec
factory for an outbound channel adapter spec.- Parameters:
remoteFileTemplate
- the remote file template.fileExistsMode
- the file exists mode.- Returns:
- the spec.
-
outboundAdapter
AFtpMessageHandlerSpec
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, org.springframework.integration.file.support.FileExistsMode fileExistsMode)AFtpMessageHandlerSpec
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(org.springframework.integration.file.remote.session.SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory, org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway.Command command, java.lang.String expression)Produce aFtpOutboundGatewaySpec
based on theSessionFactory
,AbstractRemoteFileOutboundGateway.Command
andexpression
for the remoteFilePath.- Parameters:
sessionFactory
- theSessionFactory
.command
- the command to perform on the FTP.expression
- the remoteFilePath SpEL expression.- Returns:
- the
FtpOutboundGatewaySpec
-
outboundGateway
public static FtpOutboundGatewaySpec outboundGateway(org.springframework.integration.file.remote.session.SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory, java.lang.String command, java.lang.String expression)Produce aFtpOutboundGatewaySpec
based on theSessionFactory
,AbstractRemoteFileOutboundGateway.Command
andexpression
for the remoteFilePath.- Parameters:
sessionFactory
- theSessionFactory
.command
- the command to perform on the FTP.expression
- the remoteFilePath SpEL expression.- Returns:
- the
FtpOutboundGatewaySpec
- See Also:
RemoteFileTemplate
-
outboundGateway
public static FtpOutboundGatewaySpec outboundGateway(org.springframework.integration.file.remote.RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate, org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway.Command command, java.lang.String expression)Produce aFtpOutboundGatewaySpec
based on theRemoteFileTemplate
,AbstractRemoteFileOutboundGateway.Command
andexpression
for the remoteFilePath.- Parameters:
remoteFileTemplate
- theRemoteFileTemplate
.command
- the command to perform on the FTP.expression
- the remoteFilePath SpEL expression.- Returns:
- the
FtpOutboundGatewaySpec
- See Also:
RemoteFileTemplate
-
outboundGateway
public static FtpOutboundGatewaySpec outboundGateway(org.springframework.integration.file.remote.RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate, java.lang.String command, java.lang.String expression)Produce aFtpOutboundGatewaySpec
based on theRemoteFileTemplate
,AbstractRemoteFileOutboundGateway.Command
andexpression
for the remoteFilePath.- Parameters:
remoteFileTemplate
- theRemoteFileTemplate
.command
- the command to perform on the FTP.expression
- the remoteFilePath SpEL expression.- Returns:
- the
FtpOutboundGatewaySpec
- See Also:
RemoteFileTemplate
-
outboundGateway
public static FtpOutboundGatewaySpec outboundGateway(org.springframework.integration.file.remote.session.SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory, org.springframework.integration.file.remote.MessageSessionCallback<org.apache.commons.net.ftp.FTPFile,?> messageSessionCallback)Produce aFtpOutboundGatewaySpec
based on theMessageSessionCallback
.- Parameters:
sessionFactory
- theSessionFactory
to connect to.messageSessionCallback
- theMessageSessionCallback
to perform SFTP operation(s) with theMessage
context.- Returns:
- the
FtpOutboundGatewaySpec
- See Also:
MessageSessionCallback
-