org.springframework.integration.file.remote.synchronizer

Class AbstractInboundFileSynchronizer<F>

java.lang.Object

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

All Implemented Interfaces:

InitializingBean, IntegrationEvaluationContextAware, InboundFileSynchronizer

Direct Known Subclasses:

FtpInboundFileSynchronizer, SftpInboundFileSynchronizer

public abstract class AbstractInboundFileSynchronizer<F>
extends Object
implements InboundFileSynchronizer, InitializingBean, IntegrationEvaluationContextAware

Base class charged with knowing how to connect to a remote file system, scan it for new files and then download the files.

The implementation should run through any configured FileListFilters to ensure the file entry is acceptable.

Since:

2.0

Author:

Josh Long, Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	logger

Constructor Summary

Constructors

Constructor and Description
AbstractInboundFileSynchronizer(SessionFactory<F> sessionFactory) Create a synchronizer with the SessionFactory used to acquire Session instances.

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected List<F>	filterFiles(F[] files)
protected abstract String	getFilename(F file)
protected abstract long	getModified(F file)
protected String	getTemporaryFileSuffix()
protected abstract boolean	isFile(F file)
void	setDeleteRemoteFiles(boolean deleteRemoteFiles)
void	setFilter(FileListFilter<F> filter)
void	setIntegrationEvaluationContext(EvaluationContext evaluationContext)
void	setLocalFilenameGeneratorExpression(Expression localFilenameGeneratorExpression)
void	setPreserveTimestamp(boolean preserveTimestamp)
void	setRemoteDirectory(String remoteDirectory) Specify the full path to the remote directory.
void	setRemoteFileSeparator(String remoteFileSeparator)
void	setTemporaryFileSuffix(String temporaryFileSuffix)
void	synchronizeToLocalDirectory(File localDirectory)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

AbstractInboundFileSynchronizer

public AbstractInboundFileSynchronizer(SessionFactory<F> sessionFactory)

Create a synchronizer with the SessionFactory used to acquire Session instances.

Parameters:

sessionFactory - The session factory.

Method Detail

setRemoteFileSeparator

public void setRemoteFileSeparator(String remoteFileSeparator)

setLocalFilenameGeneratorExpression

public void setLocalFilenameGeneratorExpression(Expression localFilenameGeneratorExpression)

setTemporaryFileSuffix

public void setTemporaryFileSuffix(String temporaryFileSuffix)

setRemoteDirectory

public void setRemoteDirectory(String remoteDirectory)

Specify the full path to the remote directory.

Parameters:

remoteDirectory - The remote directory.

setFilter

public void setFilter(FileListFilter<F> filter)

setDeleteRemoteFiles

public void setDeleteRemoteFiles(boolean deleteRemoteFiles)

setPreserveTimestamp

public void setPreserveTimestamp(boolean preserveTimestamp)

setIntegrationEvaluationContext

public void setIntegrationEvaluationContext(EvaluationContext evaluationContext)

Specified by:

setIntegrationEvaluationContext in interface IntegrationEvaluationContextAware

afterPropertiesSet

public final void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

filterFiles

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

getTemporaryFileSuffix

protected String getTemporaryFileSuffix()

synchronizeToLocalDirectory

public void synchronizeToLocalDirectory(File localDirectory)

Specified by:

synchronizeToLocalDirectory in interface InboundFileSynchronizer

isFile

protected abstract boolean isFile(F file)

getFilename

protected abstract String getFilename(F file)

getModified

protected abstract long getModified(F file)