Package org.springframework.integration.file.tail

Class FileTailingMessageProducerSupport

java.lang.Object
org.springframework.integration.context.IntegrationObjectSupport
org.springframework.integration.endpoint.AbstractEndpoint
org.springframework.integration.endpoint.MessageProducerSupport
org.springframework.integration.file.tail.FileTailingMessageProducerSupport
All Implemented Interfaces:
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.IntegrationInboundManagement, org.springframework.integration.support.management.IntegrationManagement, org.springframework.integration.support.management.ManageableLifecycle, org.springframework.integration.support.management.ManageableSmartLifecycle, org.springframework.integration.support.management.TrackableComponent
Direct Known Subclasses:
ApacheCommonsFileTailingMessageProducer, OSDelegatingFileTailingMessageProducer
public abstract class FileTailingMessageProducerSupport extends org.springframework.integration.endpoint.MessageProducerSupport implements org.springframework.context.ApplicationEventPublisherAware
Base class for file tailing inbound adapters.
Since:
3.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    FileTailingMessageProducerSupport.FileTailingEvent
     
    static class 
    FileTailingMessageProducerSupport.FileTailingIdleEvent
     

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

    org.springframework.integration.support.management.IntegrationManagement.ManagementOverrides

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final long
    DEFAULT_TAIL_ATTEMPTS_DELAY
    The default delay between tail attempts in milliseconds.

    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
    FileTailingMessageProducerSupport()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    doStart()
     
    protected void
    doStop()
     
    String
    getComponentType()
     
    protected File
    getFile()
     
    protected long
    getMissingFileDelay()
     
    protected org.springframework.core.task.TaskExecutor
    getTaskExecutor()
     
    protected void
    publish(String message)
     
    protected void
    send(String line)
     
    void
    setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)
     
    void
    setFile(File file)
    The name of the file you wish to tail.
    void
    setIdleEventInterval(long idleEventInterval)
    How often to emit FileTailingMessageProducerSupport.FileTailingIdleEvents in milliseconds.
    void
    setTailAttemptsDelay(long tailAttemptsDelay)
    The delay in milliseconds between attempts to tail a non-existent file, or between attempts to execute a process if it fails for any reason.
    void
    setTaskExecutor(org.springframework.core.task.TaskExecutor taskExecutor)
    A task executor; default is a SimpleAsyncTaskExecutor.

    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

  • Field Details

    • DEFAULT_TAIL_ATTEMPTS_DELAY

      public static final long DEFAULT_TAIL_ATTEMPTS_DELAY
      The default delay between tail attempts in milliseconds.
      See Also:

  • Constructor Details

    • FileTailingMessageProducerSupport

      public FileTailingMessageProducerSupport()

  • Method Details

    • setApplicationEventPublisher

      public void setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)
      Specified by:
      setApplicationEventPublisher in interface org.springframework.context.ApplicationEventPublisherAware

    • setFile

      public void setFile(File file)
      The name of the file you wish to tail.
      Parameters:
      file - The absolute path of the file.

    • getFile

      protected File getFile()

    • setTaskExecutor

      public void setTaskExecutor(org.springframework.core.task.TaskExecutor taskExecutor)
      A task executor; default is a SimpleAsyncTaskExecutor.
      Parameters:
      taskExecutor - The task executor.

    • setTailAttemptsDelay

      public void setTailAttemptsDelay(long tailAttemptsDelay)
      The delay in milliseconds between attempts to tail a non-existent file, or between attempts to execute a process if it fails for any reason.
      Parameters:
      tailAttemptsDelay - the delay.

    • setIdleEventInterval

      public void setIdleEventInterval(long idleEventInterval)
      How often to emit FileTailingMessageProducerSupport.FileTailingIdleEvents in milliseconds.
      Parameters:
      idleEventInterval - the interval.
      Since:
      5.0

    • getMissingFileDelay

      protected long getMissingFileDelay()

    • getTaskExecutor

      protected org.springframework.core.task.TaskExecutor getTaskExecutor()

    • getComponentType

      public String getComponentType()
      Specified by:
      getComponentType in interface org.springframework.integration.support.context.NamedComponent
      Overrides:
      getComponentType in class org.springframework.integration.context.IntegrationObjectSupport

    • send

      protected void send(String line)

    • publish

      protected void publish(String message)

    • doStart

      protected void doStart()
      Overrides:
      doStart in class org.springframework.integration.endpoint.MessageProducerSupport

    • doStop

      protected void doStop()
      Overrides:
      doStop in class org.springframework.integration.endpoint.MessageProducerSupport