Package org.springframework.integration.sftp.dsl

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 Details

    • inboundAdapter

      public static SftpInboundChannelAdapterSpec inboundAdapter​(org.springframework.integration.file.remote.session.SessionFactory<com.jcraft.jsch.ChannelSftp.LsEntry> sessionFactory)
      An SftpInboundChannelAdapterSpec factory 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)
      An SftpInboundChannelAdapterSpec factory 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)
      An SftpStreamingInboundChannelAdapterSpec factory 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)
      An SftpStreamingInboundChannelAdapterSpec factory 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)
      An SftpMessageHandlerSpec factory 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)
      An SftpMessageHandlerSpec factory 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 of outboundAdapter(SftpRemoteFileTemplate)
      An SftpMessageHandlerSpec factory 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.
      in favor of outboundAdapter(SftpRemoteFileTemplate,FileExistsMode)
      An SftpMessageHandlerSpec factory 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)
      An SftpMessageHandlerSpec factory 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)
      An SftpMessageHandlerSpec factory 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 a SftpOutboundGatewaySpec 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 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 a SftpOutboundGatewaySpec 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 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 a SftpOutboundGatewaySpec based on the RemoteFileTemplate, AbstractRemoteFileOutboundGateway.Command and expression for the remoteFilePath.
      Parameters:
      remoteFileTemplate - the RemoteFileTemplate to 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 a SftpOutboundGatewaySpec based on the RemoteFileTemplate, AbstractRemoteFileOutboundGateway.Command and expression for the remoteFilePath.
      Parameters:
      remoteFileTemplate - the RemoteFileTemplate to 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 a SftpOutboundGatewaySpec 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 SftpOutboundGatewaySpec
      See Also:
      MessageSessionCallback