Package org.springframework.integration.file.tail

Class ApacheCommonsFileTailingMessageProducer

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.endpoint.AbstractEndpoint

org.springframework.integration.endpoint.MessageProducerSupport

org.springframework.integration.file.tail.FileTailingMessageProducerSupport

org.springframework.integration.file.tail.ApacheCommonsFileTailingMessageProducer

All Implemented Interfaces:

org.apache.commons.io.input.TailerListener, Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, SmartInitializingSingleton, ApplicationContextAware, ApplicationEventPublisherAware, Lifecycle, Phased, SmartLifecycle, ExpressionCapable, MessageProducer, IntegrationPattern, NamedComponent, IntegrationInboundManagement, IntegrationManagement, ManageableLifecycle, ManageableSmartLifecycle, TrackableComponent

public class ApacheCommonsFileTailingMessageProducer
extends FileTailingMessageProducerSupport
implements org.apache.commons.io.input.TailerListener

File tailer that delegates to the Apache Commons Tailer.

Since:

3.0

Author:

Gary Russell, Artem Bilan

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.file.tail.FileTailingMessageProducerSupport

FileTailingMessageProducerSupport.FileTailingEvent, FileTailingMessageProducerSupport.FileTailingIdleEvent

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

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.file.tail.FileTailingMessageProducerSupport

DEFAULT_TAIL_ATTEMPTS_DELAY

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

lifecycleCondition, lifecycleLock

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

EXPRESSION_PARSER, logger

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

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
ApacheCommonsFileTailingMessageProducer()

Method Summary

Modifier and Type	Method	Description
protected void	doStart()	Take no action by default.
protected void	doStop()	Take no action by default.
void	fileNotFound()	Deprecated, for removal: This API element is subject to removal in a future version.
void	fileRotated()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getComponentType()	Subclasses may implement this method to provide component type information.
void	handle(Exception ex)	Deprecated, for removal: This API element is subject to removal in a future version.
void	handle(String line)	Deprecated, for removal: This API element is subject to removal in a future version.
void	init(org.apache.commons.io.input.Tailer tailer)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setEnd(boolean end)	If true, tail from the end of the file, otherwise include all lines from the beginning.
void	setPollingDelay(long pollingDelay)	The delay between checks of the file for new content in milliseconds.
void	setPollingDelayDuration(Duration pollingDelay)	The delay between checks of the file for new content in Duration.
void	setReopen(boolean reopen)	If true, close and reopen the file between reading chunks; default false.

Methods inherited from class org.springframework.integration.file.tail.FileTailingMessageProducerSupport

getFile, getMissingFileDelay, getTaskExecutor, publish, send, setApplicationEventPublisher, setFile, setIdleEventInterval, setTailAttemptsDelay, setTaskExecutor

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

afterSingletonsInstantiated, buildErrorMessage, getErrorChannel, getErrorMessageAttributes, getErrorMessageStrategy, getIntegrationPatternType, getMessagingTemplate, getOutputChannel, isObserved, onInit, registerObservationRegistry, sendErrorMessageIfNecessary, sendMessage, setErrorChannel, setErrorChannelName, setErrorMessageStrategy, setObservationConvention, setOutputChannel, setOutputChannelName, setSendTimeout, setShouldTrack, subscribeToPublisher

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

destroy, doStop, getPhase, getRole, isActive, isAutoStartup, isRunning, setAutoStartup, setPhase, setRole, start, stop, stop

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

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, 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.management.IntegrationManagement

destroy, getManagedName, getManagedType, getOverrides, getThisAs, isLoggingEnabled, registerMetricsCaptor, setLoggingEnabled, setManagedName, setManagedType

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

getBeanName, getComponentName

Constructor Details

ApacheCommonsFileTailingMessageProducer

public ApacheCommonsFileTailingMessageProducer()

Method Details

setPollingDelay

public void setPollingDelay(long pollingDelay)

The delay between checks of the file for new content in milliseconds.

Parameters:

pollingDelay - The delay.

setPollingDelayDuration

public void setPollingDelayDuration(Duration pollingDelay)

The delay between checks of the file for new content in Duration.

Parameters:

pollingDelay - The delay duration.

Since:

6.2

setEnd

public void setEnd(boolean end)

If true, tail from the end of the file, otherwise include all lines from the beginning. Default true.

Parameters:

end - true or false

setReopen

public void setReopen(boolean reopen)

If true, close and reopen the file between reading chunks; default false.

Parameters:

reopen - true or false.

getComponentType

public String getComponentType()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this method to provide component type information.

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class FileTailingMessageProducerSupport

doStart

protected void doStart()

Description copied from class: MessageProducerSupport

Take no action by default. Subclasses may override this if they need lifecycle-managed behavior. Protected by 'lifecycleLock'.

Overrides:

doStart in class FileTailingMessageProducerSupport

doStop

protected void doStop()

Description copied from class: MessageProducerSupport

Take no action by default. Subclasses may override this if they need lifecycle-managed behavior.

Overrides:

doStop in class FileTailingMessageProducerSupport

init

@Deprecated(since="6.2",
            forRemoval=true)
public void init(org.apache.commons.io.input.Tailer tailer)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

init in interface org.apache.commons.io.input.TailerListener

fileNotFound

@Deprecated(since="6.2",
            forRemoval=true)
public void fileNotFound()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

fileNotFound in interface org.apache.commons.io.input.TailerListener

fileRotated

@Deprecated(since="6.2",
            forRemoval=true)
public void fileRotated()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

fileRotated in interface org.apache.commons.io.input.TailerListener

handle

@Deprecated(since="6.2",
            forRemoval=true)
public void handle(String line)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

handle in interface org.apache.commons.io.input.TailerListener

handle

@Deprecated(since="6.2",
            forRemoval=true)
public void handle(Exception ex)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

handle in interface org.apache.commons.io.input.TailerListener