org.springframework.integration.file.remote

Class AbstractRemoteFileStreamingMessageSource<F>

java.lang.Object

org.springframework.integration.util.AbstractExpressionEvaluator

org.springframework.integration.endpoint.AbstractMessageSource<T>

org.springframework.integration.endpoint.AbstractFetchLimitingMessageSource<java.io.InputStream>

org.springframework.integration.file.remote.AbstractRemoteFileStreamingMessageSource<F>

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, MessageSource<java.io.InputStream>, NamedComponent, IntegrationManagement, MessageSourceManagement, MessageSourceMetrics

Direct Known Subclasses:

FtpStreamingMessageSource, SftpStreamingMessageSource

public abstract class AbstractRemoteFileStreamingMessageSource<F>
extends AbstractFetchLimitingMessageSource<java.io.InputStream>
implements org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.InitializingBean

A message source that produces a message with an InputStream payload referencing a remote file.

Since:

4.3

Author:

Gary Russell, Artem Bilan

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.util.AbstractExpressionEvaluator

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRemoteFileStreamingMessageSource(RemoteFileTemplate<F> template, java.util.Comparator<F> comparator)

Method Summary

Modifier and Type	Method and Description
protected abstract java.util.List<AbstractFileInfo<F>>	asFileInfoList(java.util.Collection<F> files)
protected void	doInit() Subclasses can override to perform initialization - called from InitializingBean.afterPropertiesSet().
protected java.lang.Object	doReceive() Subclasses must implement this method.
protected java.lang.Object	doReceive(int maxFetchSize) Subclasses must implement this method.
protected void	doSetFilter(FileListFilter<F> filter)
protected RemoteFileTemplate<F>	getRemoteFileTemplate()
protected abstract boolean	isDirectory(F file)
void	onInit()
protected AbstractFileInfo<F>	poll()
protected java.lang.String	remotePath(AbstractFileInfo<F> file)
protected void	rollbackFromFileToListEnd(java.util.List<F> filteredFiles, F file)
void	setFileInfoJson(boolean fileInfoJson) Set to false to add the FileHeaders.REMOTE_FILE_INFO header to the raw FileInfo.
void	setFilter(FileListFilter<F> filter) Set the filter to be applied to the remote files before 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) Set the remote file separator; default '/'

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

getMaxFetchSize, setMaxFetchSize

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

buildMessage, getComponentName, getManagedName, getManagedType, getMessageCount, getMessageCountLong, getOverrides, isCountsEnabled, isLoggingEnabled, receive, registerMetricsCaptor, reset, setBeanName, setCountsEnabled, setHeaderExpressions, setLoggingEnabled, setManagedName, setManagedType

Methods inherited from class org.springframework.integration.util.AbstractExpressionEvaluator

afterPropertiesSet, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, getBeanFactory, getEvaluationContext, getEvaluationContext, getMessageBuilderFactory, setBeanFactory, setConversionService

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.beans.factory.BeanFactoryAware

setBeanFactory

Methods inherited from interface org.springframework.beans.factory.InitializingBean

afterPropertiesSet

Methods inherited from interface org.springframework.integration.support.management.MessageSourceMetrics

getManagedName, getManagedType, getMessageCount, getMessageCountLong, setCounter, setManagedName, setManagedType

Methods inherited from interface org.springframework.integration.support.management.IntegrationManagement

getOverrides, isCountsEnabled, isLoggingEnabled, registerMetricsCaptor, reset, setCountsEnabled, setLoggingEnabled

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

getComponentType

Constructor Detail

AbstractRemoteFileStreamingMessageSource

protected AbstractRemoteFileStreamingMessageSource(RemoteFileTemplate<F> template,
                                                   java.util.Comparator<F> comparator)

Method Detail

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.

setRemoteFileSeparator

public void setRemoteFileSeparator(java.lang.String remoteFileSeparator)

Set the remote file separator; default '/'

Parameters:

remoteFileSeparator - the remote file separator.

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.

doSetFilter

protected final void doSetFilter(FileListFilter<F> filter)

setFileInfoJson

public void setFileInfoJson(boolean fileInfoJson)

Set to false to add the FileHeaders.REMOTE_FILE_INFO header to the raw FileInfo. Default is true meaning that common file information properties are provided in that header as JSON.

Parameters:

fileInfoJson - false to set the raw object.

Since:

5.0

getRemoteFileTemplate

protected RemoteFileTemplate<F> getRemoteFileTemplate()

onInit

public final void onInit()

Overrides:

onInit in class AbstractExpressionEvaluator

doInit

protected void doInit()

Subclasses can override to perform initialization - called from InitializingBean.afterPropertiesSet().

doReceive

protected java.lang.Object doReceive()

Description copied from class: AbstractMessageSource

Subclasses must implement this method. Typically the returned value will be the payload of type T, but the returned value may also be a Message instance whose payload is of type T; also can be AbstractIntegrationMessageBuilder which is used for additional headers population.

Overrides:

doReceive in class AbstractFetchLimitingMessageSource<java.io.InputStream>

Returns:

The value returned.

doReceive

protected java.lang.Object doReceive(int maxFetchSize)

Description copied from class: AbstractFetchLimitingMessageSource

Subclasses must implement this method. Typically the returned value will be the payload of type T, but the returned value may also be a Message instance whose payload is of type T.

Specified by:

doReceive in class AbstractFetchLimitingMessageSource<java.io.InputStream>

Parameters:

maxFetchSize - the maximum number of messages to fetch if a fetch is necessary.

Returns:

The value returned.

poll

protected AbstractFileInfo<F> poll()

remotePath

protected java.lang.String remotePath(AbstractFileInfo<F> file)

rollbackFromFileToListEnd

protected void rollbackFromFileToListEnd(java.util.List<F> filteredFiles,
                                         F file)

asFileInfoList

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

isDirectory

protected abstract boolean isDirectory(F file)