Package org.springframework.integration.sftp.dsl

Class Sftp

java.lang.Object

org.springframework.integration.sftp.dsl.Sftp

public final class Sftp
extends Object

The factory for SFTP components.

Since:

5.0

Author:

Artem Bilan, Gary Russell, Deepak Gunasekaran

Method Summary

Modifier and Type	Method	Description
static SftpInboundChannelAdapterSpec	inboundAdapter(SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> sessionFactory)	An SftpInboundChannelAdapterSpec factory for an inbound channel adapter spec.
static SftpInboundChannelAdapterSpec	inboundAdapter(SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> sessionFactory, Comparator<File> receptionOrderComparator)	An SftpInboundChannelAdapterSpec factory for an inbound channel adapter spec.
static SftpStreamingInboundChannelAdapterSpec	inboundStreamingAdapter(RemoteFileTemplate<org.apache.sshd.sftp.client.SftpClient.DirEntry> remoteFileTemplate)	An SftpStreamingInboundChannelAdapterSpec factory for an inbound channel adapter spec.
static SftpStreamingInboundChannelAdapterSpec	inboundStreamingAdapter(RemoteFileTemplate<org.apache.sshd.sftp.client.SftpClient.DirEntry> remoteFileTemplate, Comparator<org.apache.sshd.sftp.client.SftpClient.DirEntry> receptionOrderComparator)	An SftpStreamingInboundChannelAdapterSpec factory for an inbound channel adapter spec.
static SftpMessageHandlerSpec	outboundAdapter(SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> sessionFactory)	An SftpMessageHandlerSpec factory for an outbound channel adapter spec.
static SftpMessageHandlerSpec	outboundAdapter(SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> sessionFactory, FileExistsMode fileExistsMode)	An SftpMessageHandlerSpec factory for an outbound channel adapter spec.
static SftpMessageHandlerSpec	outboundAdapter(SftpRemoteFileTemplate sftpRemoteFileTemplate)	An SftpMessageHandlerSpec factory for an outbound channel adapter spec.
static SftpMessageHandlerSpec	outboundAdapter(SftpRemoteFileTemplate sftpRemoteFileTemplate, FileExistsMode fileExistsMode)	An SftpMessageHandlerSpec factory for an outbound channel adapter spec.
static SftpOutboundGatewaySpec	outboundGateway(RemoteFileTemplate<org.apache.sshd.sftp.client.SftpClient.DirEntry> remoteFileTemplate, String command, String expression)	Produce a SftpOutboundGatewaySpec based on the RemoteFileTemplate, AbstractRemoteFileOutboundGateway.Command and expression for the remoteFilePath.
static SftpOutboundGatewaySpec	outboundGateway(RemoteFileTemplate<org.apache.sshd.sftp.client.SftpClient.DirEntry> remoteFileTemplate, AbstractRemoteFileOutboundGateway.Command command, String expression)	Produce a SftpOutboundGatewaySpec based on the RemoteFileTemplate, AbstractRemoteFileOutboundGateway.Command and expression for the remoteFilePath.
static SftpOutboundGatewaySpec	outboundGateway(SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> sessionFactory, String command, String expression)	Produce a SftpOutboundGatewaySpec based on the SessionFactory, AbstractRemoteFileOutboundGateway.Command and expression for the remoteFilePath.
static SftpOutboundGatewaySpec	outboundGateway(SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> sessionFactory, AbstractRemoteFileOutboundGateway.Command command, String expression)	Produce a SftpOutboundGatewaySpec based on the SessionFactory, AbstractRemoteFileOutboundGateway.Command and expression for the remoteFilePath.
static SftpOutboundGatewaySpec	outboundGateway(SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> sessionFactory, MessageSessionCallback<org.apache.sshd.sftp.client.SftpClient.DirEntry,?> messageSessionCallback)	Produce a SftpOutboundGatewaySpec 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 SftpInboundChannelAdapterSpec inboundAdapter(SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> sessionFactory)

An SftpInboundChannelAdapterSpec factory for an inbound channel adapter spec.

Parameters:

sessionFactory - the session factory.

Returns:

the spec.

inboundAdapter

public static SftpInboundChannelAdapterSpec inboundAdapter(SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> sessionFactory,
 @Nullable
 Comparator<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(RemoteFileTemplate<org.apache.sshd.sftp.client.SftpClient.DirEntry> remoteFileTemplate)

An SftpStreamingInboundChannelAdapterSpec factory for an inbound channel adapter spec.

Parameters:

remoteFileTemplate - the remote file template.

Returns:

the spec.

inboundStreamingAdapter

public static SftpStreamingInboundChannelAdapterSpec inboundStreamingAdapter(RemoteFileTemplate<org.apache.sshd.sftp.client.SftpClient.DirEntry> remoteFileTemplate,
 @Nullable
 Comparator<org.apache.sshd.sftp.client.SftpClient.DirEntry> 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(SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> sessionFactory)

An SftpMessageHandlerSpec factory for an outbound channel adapter spec.

Parameters:

sessionFactory - the session factory.

Returns:

the spec.

outboundAdapter

public static SftpMessageHandlerSpec outboundAdapter(SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> sessionFactory,
 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

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,
 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(SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> sessionFactory,
 AbstractRemoteFileOutboundGateway.Command command,
 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(SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> sessionFactory,
 String command,
 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(RemoteFileTemplate<org.apache.sshd.sftp.client.SftpClient.DirEntry> remoteFileTemplate,
 AbstractRemoteFileOutboundGateway.Command command,
 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(RemoteFileTemplate<org.apache.sshd.sftp.client.SftpClient.DirEntry> remoteFileTemplate,
 String command,
 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(SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> sessionFactory,
 MessageSessionCallback<org.apache.sshd.sftp.client.SftpClient.DirEntry,?> 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