org.springframework.integration.sftp.inbound

Class SftpStreamingMessageSource

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<com.jcraft.jsch.ChannelSftp.LsEntry>

org.springframework.integration.sftp.inbound.SftpStreamingMessageSource

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>, MessageSourceManagement, NamedComponent, IntegrationManagement, MessageSourceMetrics

public class SftpStreamingMessageSource
extends AbstractRemoteFileStreamingMessageSource<com.jcraft.jsch.ChannelSftp.LsEntry>

Message source for streaming SFTP remote file contents.

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

Constructor and Description
SftpStreamingMessageSource(RemoteFileTemplate<com.jcraft.jsch.ChannelSftp.LsEntry> template) Construct an instance with the supplied template.
SftpStreamingMessageSource(RemoteFileTemplate<com.jcraft.jsch.ChannelSftp.LsEntry> template, java.util.Comparator<AbstractFileInfo<com.jcraft.jsch.ChannelSftp.LsEntry>> comparator) Construct an instance with the supplied template and comparator.

Method Summary

Modifier and Type	Method and Description
protected java.util.List<AbstractFileInfo<com.jcraft.jsch.ChannelSftp.LsEntry>>	asFileInfoList(java.util.Collection<com.jcraft.jsch.ChannelSftp.LsEntry> files)
java.lang.String	getComponentType()

Methods inherited from class org.springframework.integration.file.remote.AbstractRemoteFileStreamingMessageSource

afterPropertiesSet, doInit, doReceive, doReceive, doSetFilter, getRemoteFileTemplate, poll, remotePath, rollbackFromFileToListEnd, setFileInfoJson, setFilter, setRemoteDirectory, setRemoteDirectoryExpression, setRemoteFileSeparator

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

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.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

Constructor Detail

SftpStreamingMessageSource

public SftpStreamingMessageSource(RemoteFileTemplate<com.jcraft.jsch.ChannelSftp.LsEntry> template)

Construct an instance with the supplied template.

Parameters:

template - the template.

SftpStreamingMessageSource

public SftpStreamingMessageSource(RemoteFileTemplate<com.jcraft.jsch.ChannelSftp.LsEntry> template,
                                  java.util.Comparator<AbstractFileInfo<com.jcraft.jsch.ChannelSftp.LsEntry>> comparator)

Construct an instance with the supplied template and comparator. Note: the comparator is applied each time the remote directory is listed which only occurs when the previous list is exhausted.

Parameters:

template - the template.

comparator - the comparator.

Method Detail

getComponentType

public java.lang.String getComponentType()

asFileInfoList

protected java.util.List<AbstractFileInfo<com.jcraft.jsch.ChannelSftp.LsEntry>> asFileInfoList(java.util.Collection<com.jcraft.jsch.ChannelSftp.LsEntry> files)

Specified by:

asFileInfoList in class AbstractRemoteFileStreamingMessageSource<com.jcraft.jsch.ChannelSftp.LsEntry>