org.springframework.integration.file.remote.synchronizer

Class AbstractInboundFileSynchronizer<F>

java.lang.Object

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

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.InitializingBean, InboundFileSynchronizer

Direct Known Subclasses:

FtpInboundFileSynchronizer, SftpInboundFileSynchronizer

public abstract class AbstractInboundFileSynchronizer<F>
extends java.lang.Object
implements InboundFileSynchronizer, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.InitializingBean, java.io.Closeable

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

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	close()
protected void	copyFileToLocalDirectory(java.lang.String remoteDirectoryPath, F remoteFile, java.io.File localDirectory, Session<F> session)
protected java.util.List<F>	filterFiles(F[] files)
protected abstract java.lang.String	getFilename(F file)
protected abstract long	getModified(F file)
protected java.lang.String	getTemporaryFileSuffix()
protected abstract boolean	isFile(F file)
void	setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
void	setDeleteRemoteFiles(boolean deleteRemoteFiles) Set to true to enable deletion of remote files after successful transfer.
void	setFilter(FileListFilter<F> filter) Set the filter to be applied to the remote files before transferring.
void	setIntegrationEvaluationContext(org.springframework.expression.EvaluationContext evaluationContext)
void	setLocalFilenameGeneratorExpression(org.springframework.expression.Expression localFilenameGeneratorExpression) Set an expression used to determine the local file name.
void	setPreserveTimestamp(boolean preserveTimestamp) Set to true to enable the preservation of the remote file timestamp when transferring.
void	setRemoteDirectory(java.lang.String remoteDirectory) Specify the full path to the remote directory.
void	setRemoteDirectoryExpression(org.springframework.expression.Expression remoteDirectoryExpression) Specify an expression that evaluates to the full path to the remote directory.
void	setRemoteFileSeparator(java.lang.String remoteFileSeparator)
void	setTemporaryFileSuffix(java.lang.String temporaryFileSuffix) Set a temporary file suffix to be used while transferring files.
void	synchronizeToLocalDirectory(java.io.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(java.lang.String remoteFileSeparator)

Parameters:

remoteFileSeparator - the remote file separator.

See Also:

RemoteFileTemplate.setRemoteFileSeparator(String)

setLocalFilenameGeneratorExpression

public void setLocalFilenameGeneratorExpression(org.springframework.expression.Expression localFilenameGeneratorExpression)

Set an expression used to determine the local file name.

Parameters:

localFilenameGeneratorExpression - the expression.

setTemporaryFileSuffix

public void setTemporaryFileSuffix(java.lang.String temporaryFileSuffix)

Set a temporary file suffix to be used while transferring files. Default ".writing".

Parameters:

temporaryFileSuffix - the file suffix.

setRemoteDirectory

public void setRemoteDirectory(java.lang.String remoteDirectory)

Specify the full path to the remote directory.

Parameters:

remoteDirectory - The remote directory.

setRemoteDirectoryExpression

public void setRemoteDirectoryExpression(org.springframework.expression.Expression remoteDirectoryExpression)

Specify an expression that evaluates to the full path to the remote directory.

Parameters:

remoteDirectoryExpression - The remote directory expression.

Since:

4.2

setFilter

public void setFilter(FileListFilter<F> filter)

Set the filter to be applied to the remote files before transferring.

Parameters:

filter - the file list filter.

setDeleteRemoteFiles

public void setDeleteRemoteFiles(boolean deleteRemoteFiles)

Set to true to enable deletion of remote files after successful transfer.

Parameters:

deleteRemoteFiles - true to delete.

setPreserveTimestamp

public void setPreserveTimestamp(boolean preserveTimestamp)

Set to true to enable the preservation of the remote file timestamp when transferring.

Parameters:

preserveTimestamp - true to preserve.

setIntegrationEvaluationContext

public void setIntegrationEvaluationContext(org.springframework.expression.EvaluationContext evaluationContext)

setBeanFactory

public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
                    throws org.springframework.beans.BeansException

Specified by:

setBeanFactory in interface org.springframework.beans.factory.BeanFactoryAware

Throws:

org.springframework.beans.BeansException

afterPropertiesSet

public final void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

filterFiles

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

getTemporaryFileSuffix

protected java.lang.String getTemporaryFileSuffix()

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

synchronizeToLocalDirectory

public void synchronizeToLocalDirectory(java.io.File localDirectory)

Specified by:

synchronizeToLocalDirectory in interface InboundFileSynchronizer

copyFileToLocalDirectory

protected void copyFileToLocalDirectory(java.lang.String remoteDirectoryPath,
                                        F remoteFile,
                                        java.io.File localDirectory,
                                        Session<F> session)
                                 throws java.io.IOException

Throws:

java.io.IOException

isFile

protected abstract boolean isFile(F file)

getFilename

protected abstract java.lang.String getFilename(F file)

getModified

protected abstract long getModified(F file)