Spring Integration

org.springframework.integration.file.tail
Class ApacheCommonsFileTailingMessageProducer

java.lang.Object
  extended by org.springframework.integration.context.IntegrationObjectSupport
      extended by org.springframework.integration.endpoint.AbstractEndpoint
          extended by org.springframework.integration.endpoint.MessageProducerSupport
              extended by org.springframework.integration.file.tail.FileTailingMessageProducerSupport
                  extended by org.springframework.integration.file.tail.ApacheCommonsFileTailingMessageProducer
All Implemented Interfaces:
org.apache.commons.io.input.TailerListener, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationEventPublisherAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, NamedComponent, MessageProducer, 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

Nested Class Summary
 
Nested classes/interfaces inherited from class org.springframework.integration.file.tail.FileTailingMessageProducerSupport
FileTailingMessageProducerSupport.FileTailingEvent
 
Field Summary
 
Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport
logger
 
Constructor Summary
ApacheCommonsFileTailingMessageProducer()
           
 
Method Summary
protected  void doStart()
          Takes no action by default.
protected  void doStop()
          Takes no action by default.
 void fileNotFound()
           
 void fileRotated()
           
 java.lang.String getComponentType()
          Subclasses may implement this method to provide component type information.
 void handle(java.lang.Exception ex)
           
 void handle(java.lang.String line)
           
 void init(org.apache.commons.io.input.Tailer tailer)
           
 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 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, setTailAttemptsDelay, setTaskExecutor
 
Methods inherited from class org.springframework.integration.endpoint.MessageProducerSupport
onInit, sendMessage, setErrorChannel, setOutputChannel, setSendTimeout, setShouldTrack
 
Methods inherited from class org.springframework.integration.endpoint.AbstractEndpoint
getPhase, isAutoStartup, isRunning, setAutoStartup, setPhase, setTaskScheduler, start, stop, stop
 
Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport
afterPropertiesSet, getApplicationContextId, getBeanFactory, getComponentName, getConversionService, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setComponentName, setConversionService, 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.context.NamedComponent
getComponentName
 

Constructor Detail

ApacheCommonsFileTailingMessageProducer

public ApacheCommonsFileTailingMessageProducer()
Method Detail

setPollingDelay

public void setPollingDelay(long pollingDelay)
The delay between checks of the file for new content in milliseconds.

Parameters:
pollingDelay - The delay.

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 java.lang.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
Takes no action by default. Subclasses may override this if they need lifecycle-managed behavior.

Overrides:
doStart in class MessageProducerSupport

doStop

protected void doStop()
Description copied from class: MessageProducerSupport
Takes no action by default. Subclasses may override this if they need lifecycle-managed behavior.

Overrides:
doStop in class MessageProducerSupport

init

public void init(org.apache.commons.io.input.Tailer tailer)
Specified by:
init in interface org.apache.commons.io.input.TailerListener

fileNotFound

public void fileNotFound()
Specified by:
fileNotFound in interface org.apache.commons.io.input.TailerListener

fileRotated

public void fileRotated()
Specified by:
fileRotated in interface org.apache.commons.io.input.TailerListener

handle

public void handle(java.lang.String line)
Specified by:
handle in interface org.apache.commons.io.input.TailerListener

handle

public void handle(java.lang.Exception ex)
Specified by:
handle in interface org.apache.commons.io.input.TailerListener

Spring Integration