org.springframework.integration.file.remote.synchronizer

Class AbstractInboundFileSynchronizingMessageSource<F>

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.endpoint.AbstractEndpoint

org.springframework.integration.endpoint.MessageProducerSupport

org.springframework.integration.file.remote.synchronizer.AbstractInboundFileSynchronizingMessageSource<F>

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, MessageProducer, MessageSource<File>, TrackableComponent, NamedComponent

Direct Known Subclasses:

FtpInboundFileSynchronizingMessageSource, SftpInboundFileSynchronizingMessageSource

public abstract class AbstractInboundFileSynchronizingMessageSource<F>
extends MessageProducerSupport
implements MessageSource<File>

Factors out the common logic between the FTP and SFTP adapters. Designed to be extensible to handle adapters whose task it is to synchronize a remote file system with a local file system (NB: this does *NOT* handle pushing files TO the remote file system that exist uniquely in the local file system. It only handles pulling from the remote file system - as you would expect from an 'inbound' adapter).

The base class supports configuration of whether the remote file system and local file system's directories should be created on start (what 'creating a directory' means to the specific adapter is of course implementation specific).

This class is to be used as a pair with an implementation of AbstractInboundFileSynchronizer. The synchronizer must handle the work of actually connecting to the remote file system and delivering new Files.

Author:

Josh Long, Oleg Zhurakousky, Gary Russell

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
AbstractInboundFileSynchronizingMessageSource(AbstractInboundFileSynchronizer<F> synchronizer)
AbstractInboundFileSynchronizingMessageSource(AbstractInboundFileSynchronizer<F> synchronizer, Comparator<File> comparator)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	onInit() Subclasses may implement this for initialization logic.
Message<File>	receive() Polls from the file source.
void	setAutoCreateLocalDirectory(boolean autoCreateLocalDirectory)
void	setLocalDirectory(File localDirectory)
void	setLocalFilter(FileListFilter<File> localFileListFilter) A FileListFilter used to determine which files will generate messages after they have been synchronized.

Methods inherited from class org.springframework.integration.endpoint.MessageProducerSupport

doStart, doStop, sendMessage, setErrorChannel, setOutputChannel, setSendTimeout, setShouldTrack

Methods inherited from class org.springframework.integration.endpoint.AbstractEndpoint

getPhase, isAutoStartup, isRunning, setAutoStartup, setPhase, setTaskScheduler, start, stop, stop

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

afterPropertiesSet, getApplicationContextId, getBeanFactory, getComponentName, getComponentType, getConversionService, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setComponentName, setConversionService, setMessageBuilderFactory, 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, getComponentType

Constructor Detail

AbstractInboundFileSynchronizingMessageSource

public AbstractInboundFileSynchronizingMessageSource(AbstractInboundFileSynchronizer<F> synchronizer)

AbstractInboundFileSynchronizingMessageSource

public AbstractInboundFileSynchronizingMessageSource(AbstractInboundFileSynchronizer<F> synchronizer,
                                             Comparator<File> comparator)

Method Detail

setAutoCreateLocalDirectory

public void setAutoCreateLocalDirectory(boolean autoCreateLocalDirectory)

setLocalDirectory

public void setLocalDirectory(File localDirectory)

setLocalFilter

public void setLocalFilter(FileListFilter<File> localFileListFilter)

A FileListFilter used to determine which files will generate messages after they have been synchronized. It will be combined with a filter that will prevent accessing files that are in the process of being synchronized (files having the AbstractInboundFileSynchronizer.getTemporaryFileSuffix()).

The default is an AcceptOnceFileListFilter which filters duplicate file names (processed during the current execution).

Parameters:

localFileListFilter - The local file list filter.

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class MessageProducerSupport

receive

public final Message<File> receive()

Polls from the file source. If the result is not null, it will be returned. If the result is null, it attempts to sync up with the remote directory to populate the file source. Then, it polls the file source again and returns the result, whether or not it is null.

Specified by:

receive in interface MessageSource<File>

Returns:

The messasge or null.