org.springframework.integration.file.remote.gateway

Class AbstractRemoteFileOutboundGateway<F>

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractReplyProducingMessageHandler

org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway<F>

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, Ordered, Orderable, MessageProducer, TrackableComponent, NamedComponent, MessageHandler

Direct Known Subclasses:

FtpOutboundGateway, SftpOutboundGateway

public abstract class AbstractRemoteFileOutboundGateway<F>
extends AbstractReplyProducingMessageHandler

Base class for Outbound Gateways that perform remote file operations.

Since:

2.1

Author:

Gary Russell, Artem Bilan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractRemoteFileOutboundGateway.Command Enumeration of commands supported by the gateways.
static class	AbstractRemoteFileOutboundGateway.Option Enumeration of options supported by various commands.

Nested classes/interfaces inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

AbstractReplyProducingMessageHandler.RequestHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractRemoteFileOutboundGateway.Command	command
protected Set<AbstractRemoteFileOutboundGateway.Option>	options

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractRemoteFileOutboundGateway(RemoteFileTemplate<F> remoteFileTemplate, AbstractRemoteFileOutboundGateway.Command command, String expression)
AbstractRemoteFileOutboundGateway(RemoteFileTemplate<F> remoteFileTemplate, String command, String expression)
AbstractRemoteFileOutboundGateway(SessionFactory<F> sessionFactory, AbstractRemoteFileOutboundGateway.Command command, String expression)
AbstractRemoteFileOutboundGateway(SessionFactory<F> sessionFactory, String command, String expression)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract List<AbstractFileInfo<F>>	asFileInfoList(Collection<F> files)
protected void	doInit()
protected abstract F	enhanceNameWithSubDirectory(F file, String directory)
protected List<F>	filterFiles(F[] files)
protected List<File>	filterMputFiles(File[] files)
protected File	get(Message<?> message, Session<F> session, String remoteDir, String remoteFilePath, String remoteFilename, boolean lsFirst) Copy a remote file to the configured local directory.
protected abstract String	getFilename(AbstractFileInfo<F> file)
protected abstract String	getFilename(F file)
protected abstract long	getModified(F file)
protected String	getRemoteFilename(String remoteFilePath)
protected Object	handleRequestMessage(Message<?> requestMessage) Subclasses must implement this method to handle the request Message.
protected abstract boolean	isDirectory(F file)
protected abstract boolean	isLink(F file)
protected List<?>	ls(Session<F> session, String dir)
protected List<File>	mGet(Message<?> message, Session<F> session, String remoteDirectory, String remoteFilename)
protected void	purgeDots(List<F> lsFiles)
protected void	purgeLinks(List<F> lsFiles)
void	setAutoCreateLocalDirectory(boolean autoCreateLocalDirectory)
void	setFilter(FileListFilter<F> filter)
void	setLocalDirectory(File localDirectory)
void	setLocalDirectoryExpression(Expression localDirectoryExpression)
void	setLocalFilenameGeneratorExpression(Expression localFilenameGeneratorExpression)
void	setMputFilter(FileListFilter<File> filter)
void	setOptions(String options)
void	setRemoteFileSeparator(String remoteFileSeparator)
void	setRenameExpression(String expression)
void	setTemporaryFileSuffix(String temporaryFileSuffix)

Methods inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

doInvokeAdvisedRequestHandler, getMessagingTemplate, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setChannelResolver, setOutputChannel, setOutputChannelName, setRequiresReply, setSendTimeout, shouldCopyRequestHeaders

Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler

getComponentType, getOrder, handleMessage, setOrder, setShouldTrack

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, getApplicationContextId, getBeanFactory, getComponentName, getConversionService, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setComponentName, setConversionService, setMessageBuilderFactory, setTaskScheduler, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getComponentName

Field Detail

command

protected final AbstractRemoteFileOutboundGateway.Command command

options

protected volatile Set<AbstractRemoteFileOutboundGateway.Option> options

Constructor Detail

AbstractRemoteFileOutboundGateway

public AbstractRemoteFileOutboundGateway(SessionFactory<F> sessionFactory,
                                 String command,
                                 String expression)

AbstractRemoteFileOutboundGateway

public AbstractRemoteFileOutboundGateway(SessionFactory<F> sessionFactory,
                                 AbstractRemoteFileOutboundGateway.Command command,
                                 String expression)

AbstractRemoteFileOutboundGateway

public AbstractRemoteFileOutboundGateway(RemoteFileTemplate<F> remoteFileTemplate,
                                 String command,
                                 String expression)

AbstractRemoteFileOutboundGateway

public AbstractRemoteFileOutboundGateway(RemoteFileTemplate<F> remoteFileTemplate,
                                 AbstractRemoteFileOutboundGateway.Command command,
                                 String expression)

Method Detail

setOptions

public void setOptions(String options)

Parameters:

options - the options to set

setRemoteFileSeparator

public void setRemoteFileSeparator(String remoteFileSeparator)

Parameters:

remoteFileSeparator - the remoteFileSeparator to set

setLocalDirectory

public void setLocalDirectory(File localDirectory)

Parameters:

localDirectory - the localDirectory to set

setLocalDirectoryExpression

public void setLocalDirectoryExpression(Expression localDirectoryExpression)

setAutoCreateLocalDirectory

public void setAutoCreateLocalDirectory(boolean autoCreateLocalDirectory)

Parameters:

autoCreateLocalDirectory - the autoCreateLocalDirectory to set

setTemporaryFileSuffix

public void setTemporaryFileSuffix(String temporaryFileSuffix)

Parameters:

temporaryFileSuffix - the temporaryFileSuffix to set

setFilter

public void setFilter(FileListFilter<F> filter)

Parameters:

filter - the filter to set

setMputFilter

public void setMputFilter(FileListFilter<File> filter)

Parameters:

filter - the filter to set

setRenameExpression

public void setRenameExpression(String expression)

setLocalFilenameGeneratorExpression

public void setLocalFilenameGeneratorExpression(Expression localFilenameGeneratorExpression)

doInit

protected void doInit()

Overrides:

doInit in class AbstractReplyProducingMessageHandler

handleRequestMessage

protected Object handleRequestMessage(Message<?> requestMessage)

Description copied from class: AbstractReplyProducingMessageHandler

Subclasses must implement this method to handle the request Message. The return value may be a Message, a MessageBuilder, or any plain Object. The base class will handle the final creation of a reply Message from any of those starting points. If the return value is null, the Message flow will end here.

Specified by:

handleRequestMessage in class AbstractReplyProducingMessageHandler

Parameters:

requestMessage - The request message.

Returns:

The result of handling the message, or null.

ls

protected List<?> ls(Session<F> session,
         String dir)
              throws IOException

Throws:

IOException

filterFiles

protected final List<F> filterFiles(F[] files)

filterMputFiles

protected final List<File> filterMputFiles(File[] files)

purgeLinks

protected void purgeLinks(List<F> lsFiles)

purgeDots

protected void purgeDots(List<F> lsFiles)

get

protected File get(Message<?> message,
       Session<F> session,
       String remoteDir,
       String remoteFilePath,
       String remoteFilename,
       boolean lsFirst)
            throws IOException

Copy a remote file to the configured local directory.

Parameters:

message - The message.

session - The session.

remoteDir - The remote directory.

remoteFilePath - The remote file path.

remoteFilename - The remote file name.

lsFirst - true to execute an 'ls' command first.

Returns:

The file.

Throws:

IOException - Any IOException.

mGet

protected List<File> mGet(Message<?> message,
              Session<F> session,
              String remoteDirectory,
              String remoteFilename)
                   throws IOException

Throws:

IOException

getRemoteFilename

protected String getRemoteFilename(String remoteFilePath)

Parameters:

remoteFilePath - The remote file path.

Returns:

The remote file name.

isDirectory

protected abstract boolean isDirectory(F file)

isLink

protected abstract boolean isLink(F file)

getFilename

protected abstract String getFilename(F file)

getFilename

protected abstract String getFilename(AbstractFileInfo<F> file)

getModified

protected abstract long getModified(F file)

asFileInfoList

protected abstract List<AbstractFileInfo<F>> asFileInfoList(Collection<F> files)

enhanceNameWithSubDirectory

protected abstract F enhanceNameWithSubDirectory(F file,
                            String directory)