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.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationEventPublisherAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, NamedComponent, MessageProducer, TrackableComponent

Direct Known Subclasses:

ApacheCommonsFileTailingMessageProducer, OSDelegatingFileTailingMessageProducer

public abstract class FileTailingMessageProducerSupport
extends MessageProducerSupport
implements org.springframework.context.ApplicationEventPublisherAware

Base class for file tailing inbound adapters.

Since:

3.0

Author:

Gary Russell

Nested Class Summary

static class

FileTailingMessageProducerSupport.FileTailingEvent

Field Summary

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

logger

Constructor Summary

FileTailingMessageProducerSupport()

Method Summary

java.lang.String	getComponentType() Subclasses may implement this method to provide component type information.
protected java.io.File	getFile()
protected long	getMissingFileDelay()
protected org.springframework.core.task.TaskExecutor	getTaskExecutor()
protected void	publish(java.lang.String message)
protected void	send(java.lang.String line)
void	setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)
void	setFile(java.io.File file) The name of the file you wish to tail.
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

doStart, doStop, 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

FileTailingMessageProducerSupport

public FileTailingMessageProducerSupport()

Method Detail

setApplicationEventPublisher

public void setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface org.springframework.context.ApplicationEventPublisherAware

setFile

public void setFile(java.io.File file)

The name of the file you wish to tail.

Parameters:

file - The absolute path of the file.

getFile

protected java.io.File getFile()

setTaskExecutor

public void setTaskExecutor(org.springframework.core.task.TaskExecutor taskExecutor)

A task executor; default is a SimpleAsyncTaskExecutor.

Parameters:

taskExecutor -

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.

getMissingFileDelay

protected long getMissingFileDelay()

getTaskExecutor

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

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 IntegrationObjectSupport

send

protected void send(java.lang.String line)

publish

protected void publish(java.lang.String message)