Class Sftp
java.lang.Object
org.springframework.integration.sftp.dsl.Sftp
public final class Sftp
extends java.lang.Object
The factory for SFTP components.
- Since:
- 5.0
-
Method Summary
Modifier and Type Method Description static SftpInboundChannelAdapterSpecinboundAdapter(org.springframework.integration.file.remote.session.SessionFactory<com.jcraft.jsch.ChannelSftp.LsEntry> sessionFactory)AnSftpInboundChannelAdapterSpecfactory for an inbound channel adapter spec.static SftpInboundChannelAdapterSpecinboundAdapter(org.springframework.integration.file.remote.session.SessionFactory<com.jcraft.jsch.ChannelSftp.LsEntry> sessionFactory, java.util.Comparator<java.io.File> receptionOrderComparator)AnSftpInboundChannelAdapterSpecfactory for an inbound channel adapter spec.static SftpStreamingInboundChannelAdapterSpecinboundStreamingAdapter(org.springframework.integration.file.remote.RemoteFileTemplate<com.jcraft.jsch.ChannelSftp.LsEntry> remoteFileTemplate)AnSftpStreamingInboundChannelAdapterSpecfactory for an inbound channel adapter spec.static SftpStreamingInboundChannelAdapterSpecinboundStreamingAdapter(org.springframework.integration.file.remote.RemoteFileTemplate<com.jcraft.jsch.ChannelSftp.LsEntry> remoteFileTemplate, java.util.Comparator<com.jcraft.jsch.ChannelSftp.LsEntry> receptionOrderComparator)AnSftpStreamingInboundChannelAdapterSpecfactory for an inbound channel adapter spec.static SftpMessageHandlerSpecoutboundAdapter(org.springframework.integration.file.remote.RemoteFileTemplate<com.jcraft.jsch.ChannelSftp.LsEntry> remoteFileTemplate)Deprecated.in favor ofoutboundAdapter(SftpRemoteFileTemplate)static SftpMessageHandlerSpecoutboundAdapter(org.springframework.integration.file.remote.RemoteFileTemplate<com.jcraft.jsch.ChannelSftp.LsEntry> remoteFileTemplate, org.springframework.integration.file.support.FileExistsMode fileExistsMode)Deprecated.static SftpMessageHandlerSpecoutboundAdapter(org.springframework.integration.file.remote.session.SessionFactory<com.jcraft.jsch.ChannelSftp.LsEntry> sessionFactory)AnSftpMessageHandlerSpecfactory for an outbound channel adapter spec.static SftpMessageHandlerSpecoutboundAdapter(org.springframework.integration.file.remote.session.SessionFactory<com.jcraft.jsch.ChannelSftp.LsEntry> sessionFactory, org.springframework.integration.file.support.FileExistsMode fileExistsMode)AnSftpMessageHandlerSpecfactory for an outbound channel adapter spec.static SftpMessageHandlerSpecoutboundAdapter(SftpRemoteFileTemplate sftpRemoteFileTemplate)AnSftpMessageHandlerSpecfactory for an outbound channel adapter spec.static SftpMessageHandlerSpecoutboundAdapter(SftpRemoteFileTemplate sftpRemoteFileTemplate, org.springframework.integration.file.support.FileExistsMode fileExistsMode)AnSftpMessageHandlerSpecfactory for an outbound channel adapter spec.static SftpOutboundGatewaySpecoutboundGateway(org.springframework.integration.file.remote.RemoteFileTemplate<com.jcraft.jsch.ChannelSftp.LsEntry> remoteFileTemplate, java.lang.String command, java.lang.String expression)Produce aSftpOutboundGatewaySpecbased on theRemoteFileTemplate,AbstractRemoteFileOutboundGateway.Commandandexpressionfor the remoteFilePath.static SftpOutboundGatewaySpecoutboundGateway(org.springframework.integration.file.remote.RemoteFileTemplate<com.jcraft.jsch.ChannelSftp.LsEntry> remoteFileTemplate, org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway.Command command, java.lang.String expression)Produce aSftpOutboundGatewaySpecbased on theRemoteFileTemplate,AbstractRemoteFileOutboundGateway.Commandandexpressionfor the remoteFilePath.static SftpOutboundGatewaySpecoutboundGateway(org.springframework.integration.file.remote.session.SessionFactory<com.jcraft.jsch.ChannelSftp.LsEntry> sessionFactory, java.lang.String command, java.lang.String expression)Produce aSftpOutboundGatewaySpecbased on theSessionFactory,AbstractRemoteFileOutboundGateway.Commandandexpressionfor the remoteFilePath.static SftpOutboundGatewaySpecoutboundGateway(org.springframework.integration.file.remote.session.SessionFactory<com.jcraft.jsch.ChannelSftp.LsEntry> sessionFactory, org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway.Command command, java.lang.String expression)Produce aSftpOutboundGatewaySpecbased on theSessionFactory,AbstractRemoteFileOutboundGateway.Commandandexpressionfor the remoteFilePath.static SftpOutboundGatewaySpecoutboundGateway(org.springframework.integration.file.remote.session.SessionFactory<com.jcraft.jsch.ChannelSftp.LsEntry> sessionFactory, org.springframework.integration.file.remote.MessageSessionCallback<com.jcraft.jsch.ChannelSftp.LsEntry,?> messageSessionCallback)Produce aSftpOutboundGatewaySpecbased on theMessageSessionCallback.
-
Method Details
-
inboundAdapter
public static SftpInboundChannelAdapterSpec inboundAdapter(org.springframework.integration.file.remote.session.SessionFactory<com.jcraft.jsch.ChannelSftp.LsEntry> sessionFactory)AnSftpInboundChannelAdapterSpecfactory for an inbound channel adapter spec.- Parameters:
sessionFactory- the session factory.- Returns:
- the spec.
-
inboundAdapter
public static SftpInboundChannelAdapterSpec inboundAdapter(org.springframework.integration.file.remote.session.SessionFactory<com.jcraft.jsch.ChannelSftp.LsEntry> sessionFactory, java.util.Comparator<java.io.File> receptionOrderComparator)AnSftpInboundChannelAdapterSpecfactory for an inbound channel adapter spec.- Parameters:
sessionFactory- the session factory.receptionOrderComparator- the comparator.- Returns:
- the spec.
-
inboundStreamingAdapter
public static SftpStreamingInboundChannelAdapterSpec inboundStreamingAdapter(org.springframework.integration.file.remote.RemoteFileTemplate<com.jcraft.jsch.ChannelSftp.LsEntry> remoteFileTemplate)AnSftpStreamingInboundChannelAdapterSpecfactory for an inbound channel adapter spec.- Parameters:
remoteFileTemplate- the remote file template.- Returns:
- the spec.
-
inboundStreamingAdapter
public static SftpStreamingInboundChannelAdapterSpec inboundStreamingAdapter(org.springframework.integration.file.remote.RemoteFileTemplate<com.jcraft.jsch.ChannelSftp.LsEntry> remoteFileTemplate, java.util.Comparator<com.jcraft.jsch.ChannelSftp.LsEntry> receptionOrderComparator)AnSftpStreamingInboundChannelAdapterSpecfactory for an inbound channel adapter spec.- Parameters:
remoteFileTemplate- the remote file template.receptionOrderComparator- the comparator.- Returns:
- the spec.
-
outboundAdapter
public static SftpMessageHandlerSpec outboundAdapter(org.springframework.integration.file.remote.session.SessionFactory<com.jcraft.jsch.ChannelSftp.LsEntry> sessionFactory)AnSftpMessageHandlerSpecfactory for an outbound channel adapter spec.- Parameters:
sessionFactory- the session factory.- Returns:
- the spec.
-
outboundAdapter
public static SftpMessageHandlerSpec outboundAdapter(org.springframework.integration.file.remote.session.SessionFactory<com.jcraft.jsch.ChannelSftp.LsEntry> sessionFactory, org.springframework.integration.file.support.FileExistsMode fileExistsMode)AnSftpMessageHandlerSpecfactory for an outbound channel adapter spec.- Parameters:
sessionFactory- the session factory.fileExistsMode- the file exists mode.- Returns:
- the spec.
-
outboundAdapter
@Deprecated public static SftpMessageHandlerSpec outboundAdapter(org.springframework.integration.file.remote.RemoteFileTemplate<com.jcraft.jsch.ChannelSftp.LsEntry> remoteFileTemplate)Deprecated.in favor ofoutboundAdapter(SftpRemoteFileTemplate)AnSftpMessageHandlerSpecfactory for an outbound channel adapter spec.- Parameters:
remoteFileTemplate- the remote file template.- Returns:
- the spec.
-
outboundAdapter
@Deprecated public static SftpMessageHandlerSpec outboundAdapter(org.springframework.integration.file.remote.RemoteFileTemplate<com.jcraft.jsch.ChannelSftp.LsEntry> remoteFileTemplate, org.springframework.integration.file.support.FileExistsMode fileExistsMode)Deprecated.AnSftpMessageHandlerSpecfactory for an outbound channel adapter spec.- Parameters:
remoteFileTemplate- the remote file template.fileExistsMode- the file exists mode.- Returns:
- the spec.
-
outboundAdapter
public static SftpMessageHandlerSpec outboundAdapter(SftpRemoteFileTemplate sftpRemoteFileTemplate)AnSftpMessageHandlerSpecfactory for an outbound channel adapter spec.- Parameters:
sftpRemoteFileTemplate- the remote file template.- Returns:
- the spec.
- Since:
- 5.4
-
outboundAdapter
public static SftpMessageHandlerSpec outboundAdapter(SftpRemoteFileTemplate sftpRemoteFileTemplate, org.springframework.integration.file.support.FileExistsMode fileExistsMode)AnSftpMessageHandlerSpecfactory for an outbound channel adapter spec.- Parameters:
sftpRemoteFileTemplate- the remote file template.fileExistsMode- the file exists mode.- Returns:
- the spec.
- Since:
- 5.4
-
outboundGateway
public static SftpOutboundGatewaySpec outboundGateway(org.springframework.integration.file.remote.session.SessionFactory<com.jcraft.jsch.ChannelSftp.LsEntry> sessionFactory, org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway.Command command, java.lang.String expression)Produce aSftpOutboundGatewaySpecbased on theSessionFactory,AbstractRemoteFileOutboundGateway.Commandandexpressionfor the remoteFilePath.- Parameters:
sessionFactory- theSessionFactory.command- the command to perform on the FTP.expression- the remoteFilePath SpEL expression.- Returns:
- the
SftpOutboundGatewaySpec
-
outboundGateway
public static SftpOutboundGatewaySpec outboundGateway(org.springframework.integration.file.remote.session.SessionFactory<com.jcraft.jsch.ChannelSftp.LsEntry> sessionFactory, java.lang.String command, java.lang.String expression)Produce aSftpOutboundGatewaySpecbased on theSessionFactory,AbstractRemoteFileOutboundGateway.Commandandexpressionfor the remoteFilePath.- Parameters:
sessionFactory- theSessionFactory.command- the command to perform on the FTP.expression- the remoteFilePath SpEL expression.- Returns:
- the
SftpOutboundGatewaySpec - See Also:
RemoteFileTemplate
-
outboundGateway
public static SftpOutboundGatewaySpec outboundGateway(org.springframework.integration.file.remote.RemoteFileTemplate<com.jcraft.jsch.ChannelSftp.LsEntry> remoteFileTemplate, org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway.Command command, java.lang.String expression)Produce aSftpOutboundGatewaySpecbased on theRemoteFileTemplate,AbstractRemoteFileOutboundGateway.Commandandexpressionfor the remoteFilePath.- Parameters:
remoteFileTemplate- theRemoteFileTemplateto be based on.command- the command to perform on the SFTP.expression- the remoteFilePath SpEL expression.- Returns:
- the
SftpOutboundGatewaySpec - See Also:
RemoteFileTemplate
-
outboundGateway
public static SftpOutboundGatewaySpec outboundGateway(org.springframework.integration.file.remote.RemoteFileTemplate<com.jcraft.jsch.ChannelSftp.LsEntry> remoteFileTemplate, java.lang.String command, java.lang.String expression)Produce aSftpOutboundGatewaySpecbased on theRemoteFileTemplate,AbstractRemoteFileOutboundGateway.Commandandexpressionfor the remoteFilePath.- Parameters:
remoteFileTemplate- theRemoteFileTemplateto be based on.command- the command to perform on the SFTP.expression- the remoteFilePath SpEL expression.- Returns:
- the
SftpOutboundGatewaySpec - See Also:
RemoteFileTemplate
-
outboundGateway
public static SftpOutboundGatewaySpec outboundGateway(org.springframework.integration.file.remote.session.SessionFactory<com.jcraft.jsch.ChannelSftp.LsEntry> sessionFactory, org.springframework.integration.file.remote.MessageSessionCallback<com.jcraft.jsch.ChannelSftp.LsEntry,?> messageSessionCallback)Produce aSftpOutboundGatewaySpecbased on theMessageSessionCallback.- Parameters:
sessionFactory- theSessionFactoryto connect to.messageSessionCallback- theMessageSessionCallbackto perform SFTP operation(s) with theMessagecontext.- Returns:
- the
SftpOutboundGatewaySpec - See Also:
MessageSessionCallback
-