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, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.SmartInitializingSingleton, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationEventPublisherAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, org.springframework.integration.context.ExpressionCapable, org.springframework.integration.core.MessageProducer, org.springframework.integration.IntegrationPattern, org.springframework.integration.support.context.NamedComponent, org.springframework.integration.support.management.ManageableLifecycle, org.springframework.integration.support.management.ManageableSmartLifecycle, org.springframework.integration.support.management.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

  • Nested Class Summary

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

    FileTailingMessageProducerSupport.FileTailingEvent, FileTailingMessageProducerSupport.FileTailingIdleEvent

  • 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.context.SmartLifecycle

    DEFAULT_PHASE

  • Constructor Summary

    Constructors 
    Constructor Description
    ApacheCommonsFileTailingMessageProducer()  

  • Method Summary

    Modifier and Type Method Description
    protected void doStart()  
    protected void doStop()  
    void fileNotFound()  
    void fileRotated()  
    java.lang.String getComponentType()  
    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, setIdleEventInterval, setTailAttemptsDelay, setTaskExecutor

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

    afterSingletonsInstantiated, buildErrorMessage, getErrorChannel, getErrorMessageAttributes, getIntegrationPatternType, getMessagingTemplate, getOutputChannel, onInit, sendErrorMessageIfNecessary, sendMessage, setErrorChannel, setErrorChannelName, setErrorMessageStrategy, 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, getIntegrationProperty, 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.context.NamedComponent

    getBeanName, getComponentName

  • Constructor Details

  • Method Details

    • 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()
      Specified by:
      getComponentType in interface org.springframework.integration.support.context.NamedComponent
      Overrides:
      getComponentType in class FileTailingMessageProducerSupport

    • doStart

      protected void doStart()
      Overrides:
      doStart in class FileTailingMessageProducerSupport

    • doStop

      protected void doStop()
      Overrides:
      doStop in class FileTailingMessageProducerSupport

    • 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