Class Smb

java.lang.Object

org.springframework.integration.smb.dsl.Smb

public final class Smb
extends Object

The factory for SMB components.

Since:

6.0

Author:

Gregory Bragg, Artem Bilan

Method Summary

Modifier and Type	Method	Description
static SmbInboundChannelAdapterSpec	inboundAdapter(SessionFactory<jcifs.smb.SmbFile> sessionFactory)	A SmbInboundChannelAdapterSpec factory for an inbound channel adapter spec.
static SmbInboundChannelAdapterSpec	inboundAdapter(SessionFactory<jcifs.smb.SmbFile> sessionFactory, Comparator<File> receptionOrderComparator)	A SmbInboundChannelAdapterSpec factory for an inbound channel adapter spec.
static SmbStreamingInboundChannelAdapterSpec	inboundStreamingAdapter(RemoteFileTemplate<jcifs.smb.SmbFile> remoteFileTemplate)	A SmbStreamingInboundChannelAdapterSpec factory for an inbound channel adapter spec.
static SmbStreamingInboundChannelAdapterSpec	inboundStreamingAdapter(RemoteFileTemplate<jcifs.smb.SmbFile> remoteFileTemplate, Comparator<jcifs.smb.SmbFile> receptionOrderComparator)	A SmbStreamingInboundChannelAdapterSpec factory for an inbound channel adapter spec.
static SmbMessageHandlerSpec	outboundAdapter(SessionFactory<jcifs.smb.SmbFile> sessionFactory)	A SmbMessageHandlerSpec factory for an outbound channel adapter spec.
static SmbMessageHandlerSpec	outboundAdapter(SessionFactory<jcifs.smb.SmbFile> sessionFactory, FileExistsMode fileExistsMode)	A SmbMessageHandlerSpec factory for an outbound channel adapter spec.
static SmbMessageHandlerSpec	outboundAdapter(SmbRemoteFileTemplate smbRemoteFileTemplate)	A SmbMessageHandlerSpec factory for an outbound channel adapter spec.
static SmbMessageHandlerSpec	outboundAdapter(SmbRemoteFileTemplate smbRemoteFileTemplate, FileExistsMode fileExistsMode)	A SmbMessageHandlerSpec factory for an outbound channel adapter spec.
static SmbOutboundGatewaySpec	outboundGateway(RemoteFileTemplate<jcifs.smb.SmbFile> remoteFileTemplate, String command, String expression)	Produce a SmbOutboundGatewaySpec based on the RemoteFileTemplate, AbstractRemoteFileOutboundGateway.Command and expression for the remoteFilePath.
static SmbOutboundGatewaySpec	outboundGateway(RemoteFileTemplate<jcifs.smb.SmbFile> remoteFileTemplate, AbstractRemoteFileOutboundGateway.Command command, String expression)	Produce a SmbOutboundGatewaySpec based on the RemoteFileTemplate, AbstractRemoteFileOutboundGateway.Command and expression for the remoteFilePath.
static SmbOutboundGatewaySpec	outboundGateway(SessionFactory<jcifs.smb.SmbFile> sessionFactory, String command, String expression)	Produce a SmbOutboundGatewaySpec based on the SessionFactory, AbstractRemoteFileOutboundGateway.Command and expression for the remoteFilePath.
static SmbOutboundGatewaySpec	outboundGateway(SessionFactory<jcifs.smb.SmbFile> sessionFactory, AbstractRemoteFileOutboundGateway.Command command, String expression)	Produce a SmbOutboundGatewaySpec based on the SessionFactory, AbstractRemoteFileOutboundGateway.Command and expression for the remoteFilePath.
static SmbOutboundGatewaySpec	outboundGateway(SessionFactory<jcifs.smb.SmbFile> sessionFactory, MessageSessionCallback<jcifs.smb.SmbFile,?> messageSessionCallback)	Produce a SmbOutboundGatewaySpec 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 SmbInboundChannelAdapterSpec inboundAdapter(SessionFactory<jcifs.smb.SmbFile> sessionFactory)

A SmbInboundChannelAdapterSpec factory for an inbound channel adapter spec.

Parameters:

sessionFactory - the session factory.

Returns:

the spec.

inboundAdapter

public static SmbInboundChannelAdapterSpec inboundAdapter(SessionFactory<jcifs.smb.SmbFile> sessionFactory,
 @Nullable
 Comparator<File> receptionOrderComparator)

A SmbInboundChannelAdapterSpec factory for an inbound channel adapter spec.

Parameters:

sessionFactory - the session factory.

receptionOrderComparator - the comparator.

Returns:

the spec.

inboundStreamingAdapter

public static SmbStreamingInboundChannelAdapterSpec inboundStreamingAdapter(RemoteFileTemplate<jcifs.smb.SmbFile> remoteFileTemplate)

A SmbStreamingInboundChannelAdapterSpec factory for an inbound channel adapter spec.

Parameters:

remoteFileTemplate - the remote file template.

Returns:

the spec.

inboundStreamingAdapter

public static SmbStreamingInboundChannelAdapterSpec inboundStreamingAdapter(RemoteFileTemplate<jcifs.smb.SmbFile> remoteFileTemplate,
 @Nullable
 Comparator<jcifs.smb.SmbFile> receptionOrderComparator)

A SmbStreamingInboundChannelAdapterSpec factory for an inbound channel adapter spec.

Parameters:

remoteFileTemplate - the remote file template.

receptionOrderComparator - the comparator.

Returns:

the spec.

outboundAdapter

public static SmbMessageHandlerSpec outboundAdapter(SessionFactory<jcifs.smb.SmbFile> sessionFactory)

A SmbMessageHandlerSpec factory for an outbound channel adapter spec.

Parameters:

sessionFactory - the session factory.

Returns:

the spec.

outboundAdapter

public static SmbMessageHandlerSpec outboundAdapter(SessionFactory<jcifs.smb.SmbFile> sessionFactory,
 FileExistsMode fileExistsMode)

A SmbMessageHandlerSpec factory for an outbound channel adapter spec.

Parameters:

sessionFactory - the session factory.

fileExistsMode - the file exists mode.

Returns:

the spec.

outboundAdapter

public static SmbMessageHandlerSpec outboundAdapter(SmbRemoteFileTemplate smbRemoteFileTemplate)

A SmbMessageHandlerSpec factory for an outbound channel adapter spec.

Parameters:

smbRemoteFileTemplate - the remote file template.

Returns:

the spec.

outboundAdapter

public static SmbMessageHandlerSpec outboundAdapter(SmbRemoteFileTemplate smbRemoteFileTemplate,
 FileExistsMode fileExistsMode)

A SmbMessageHandlerSpec factory for an outbound channel adapter spec.

Parameters:

smbRemoteFileTemplate - the remote file template.

fileExistsMode - the file exists mode.

Returns:

the spec.

outboundGateway

public static SmbOutboundGatewaySpec outboundGateway(SessionFactory<jcifs.smb.SmbFile> sessionFactory,
 AbstractRemoteFileOutboundGateway.Command command,
 String expression)

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

Parameters:

sessionFactory - the SessionFactory.

command - the command to perform on the SMB.

expression - the remoteFilePath SpEL expression.

Returns:

the SmbOutboundGatewaySpec

outboundGateway

public static SmbOutboundGatewaySpec outboundGateway(SessionFactory<jcifs.smb.SmbFile> sessionFactory,
 String command,
 String expression)

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

Parameters:

sessionFactory - the SessionFactory.

command - the command to perform on the SMB.

expression - the remoteFilePath SpEL expression.

Returns:

the SmbOutboundGatewaySpec

See Also:

• RemoteFileTemplate

outboundGateway

public static SmbOutboundGatewaySpec outboundGateway(RemoteFileTemplate<jcifs.smb.SmbFile> remoteFileTemplate,
 AbstractRemoteFileOutboundGateway.Command command,
 String expression)

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

Parameters:

remoteFileTemplate - the RemoteFileTemplate.

command - the command to perform on the SMB.

expression - the remoteFilePath SpEL expression.

Returns:

the SmbOutboundGatewaySpec

See Also:

• RemoteFileTemplate

outboundGateway

public static SmbOutboundGatewaySpec outboundGateway(RemoteFileTemplate<jcifs.smb.SmbFile> remoteFileTemplate,
 String command,
 String expression)

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

Parameters:

remoteFileTemplate - the RemoteFileTemplate.

command - the command to perform on the SMB.

expression - the remoteFilePath SpEL expression.

Returns:

the SmbOutboundGatewaySpec

See Also:

• RemoteFileTemplate

outboundGateway

public static SmbOutboundGatewaySpec outboundGateway(SessionFactory<jcifs.smb.SmbFile> sessionFactory,
 MessageSessionCallback<jcifs.smb.SmbFile,?> messageSessionCallback)

Produce a SmbOutboundGatewaySpec based on the MessageSessionCallback.

Parameters:

sessionFactory - the SessionFactory to connect to.

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

Returns:

the SmbOutboundGatewaySpec

See Also:

• MessageSessionCallback