org.springframework.integration.file.dsl

Class TailAdapterSpec

java.lang.Object

org.springframework.beans.factory.config.AbstractFactoryBean<T>

org.springframework.integration.dsl.IntegrationComponentSpec<S,P>

org.springframework.integration.dsl.MessageProducerSpec<TailAdapterSpec,FileTailingMessageProducerSupport>

org.springframework.integration.file.dsl.TailAdapterSpec

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, DisposableBean, FactoryBean<FileTailingMessageProducerSupport>, InitializingBean, Lifecycle, Phased, SmartLifecycle

public class TailAdapterSpec
extends MessageProducerSpec<TailAdapterSpec,FileTailingMessageProducerSupport>

A MessageProducerSpec for file tailing adapters.

Since:

5.0

Author:

Artem Bilan, Gary Russell

Field Summary

Fields inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

PARSER, target

Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

logger

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Method Summary

Modifier and Type	Method and Description
TailAdapterSpec	autoStartup(boolean autoStartup)
TailAdapterSpec	delay(long delay) The delay between checks of the file for new content in milliseconds.
protected FileTailingMessageProducerSupport	doGet()
TailAdapterSpec	enableStatusReader(boolean enableStatusReader) This field control the stderr events.
TailAdapterSpec	end(boolean end) If true, tail from the end of the file, otherwise include all lines from the beginning.
TailAdapterSpec	errorChannel(MessageChannel errorChannel) Configure the MessageChannel to which error messages will be sent.
TailAdapterSpec	fileDelay(long fileDelay) 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.
TailAdapterSpec	id(String id) Configure the component identifier.
TailAdapterSpec	idleEventInterval(long idleEventInterval) Specify the idle interval before start sending idle events.
TailAdapterSpec	nativeOptions(String nativeOptions) Specify the options string for native tail command.
TailAdapterSpec	outputChannel(MessageChannel outputChannel) Specify the outputChannel for the MessageProducer
TailAdapterSpec	phase(int phase)
TailAdapterSpec	reopen(boolean reopen) If true, close and reopen the file between reading chunks.
TailAdapterSpec	taskExecutor(TaskExecutor taskExecutor) Configure a task executor.
TailAdapterSpec	taskScheduler(TaskScheduler taskScheduler) Set a task scheduler - defaults to the integration 'taskScheduler'.

Methods inherited from class org.springframework.integration.dsl.MessageProducerSpec

errorChannel, errorMessageStrategy, outputChannel, sendTimeout, shouldTrack

Methods inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

_this, createInstance, destroyInstance, get, getId, getObjectType, getPhase, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

afterPropertiesSet, destroy, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

nativeOptions

public TailAdapterSpec nativeOptions(String nativeOptions)

Specify the options string for native tail command.

Parameters:

nativeOptions - the nativeOptions.

Returns:

the spec.

See Also:

OSDelegatingFileTailingMessageProducer.setOptions(String)

enableStatusReader

public TailAdapterSpec enableStatusReader(boolean enableStatusReader)

This field control the stderr events.

Parameters:

enableStatusReader - boolean to enable or disable events from stderr.

Returns:

the spec

idleEventInterval

public TailAdapterSpec idleEventInterval(long idleEventInterval)

Specify the idle interval before start sending idle events.

Parameters:

idleEventInterval - interval in ms for the event idle time.

Returns:

the spec.

taskExecutor

public TailAdapterSpec taskExecutor(TaskExecutor taskExecutor)

Configure a task executor. Defaults to a SimpleAsyncTaskExecutor.

Parameters:

taskExecutor - the taskExecutor.

Returns:

the spec.

taskScheduler

public TailAdapterSpec taskScheduler(TaskScheduler taskScheduler)

Set a task scheduler - defaults to the integration 'taskScheduler'.

Parameters:

taskScheduler - the taskScheduler.

Returns:

the spec.

delay

public TailAdapterSpec delay(long delay)

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

Parameters:

delay - the delay.

Returns:

the spec.

See Also:

ApacheCommonsFileTailingMessageProducer.setPollingDelay(long)

fileDelay

public TailAdapterSpec fileDelay(long fileDelay)

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:

fileDelay - the fileDelay.

Returns:

the spec.

See Also:

FileTailingMessageProducerSupport.setTailAttemptsDelay(long)

end

public TailAdapterSpec end(boolean end)

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

Parameters:

end - the end.

Returns:

the spec.

See Also:

ApacheCommonsFileTailingMessageProducer.setEnd(boolean)

reopen

public TailAdapterSpec reopen(boolean reopen)

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

Parameters:

reopen - the reopen.

Returns:

the spec.

See Also:

ApacheCommonsFileTailingMessageProducer.setReopen(boolean)

id

public TailAdapterSpec id(String id)

Description copied from class: MessageProducerSpec

Configure the component identifier. Used as the beanName to register the bean in the application context for this component. Configure the message producer's bean name.

Overrides:

id in class MessageProducerSpec<TailAdapterSpec,FileTailingMessageProducerSupport>

Parameters:

id - the id.

Returns:

the spec.

phase

public TailAdapterSpec phase(int phase)

Overrides:

phase in class MessageProducerSpec<TailAdapterSpec,FileTailingMessageProducerSupport>

Parameters:

phase - the phase.

Returns:

the spec.

See Also:

SmartLifecycle

autoStartup

public TailAdapterSpec autoStartup(boolean autoStartup)

Overrides:

autoStartup in class MessageProducerSpec<TailAdapterSpec,FileTailingMessageProducerSupport>

Parameters:

autoStartup - the autoStartup.

Returns:

the spec.

See Also:

SmartLifecycle

outputChannel

public TailAdapterSpec outputChannel(MessageChannel outputChannel)

Description copied from class: MessageProducerSpec

Specify the outputChannel for the MessageProducer

Overrides:

outputChannel in class MessageProducerSpec<TailAdapterSpec,FileTailingMessageProducerSupport>

Parameters:

outputChannel - the outputChannel.

Returns:

the spec.

See Also:

MessageProducerSupport.setOutputChannel(MessageChannel)

errorChannel

public TailAdapterSpec errorChannel(MessageChannel errorChannel)

Description copied from class: MessageProducerSpec

Configure the MessageChannel to which error messages will be sent.

Overrides:

errorChannel in class MessageProducerSpec<TailAdapterSpec,FileTailingMessageProducerSupport>

Parameters:

errorChannel - the errorChannel.

Returns:

the spec.

See Also:

MessageProducerSupport.setErrorChannel(MessageChannel)

doGet

protected FileTailingMessageProducerSupport doGet()

Overrides:

doGet in class IntegrationComponentSpec<TailAdapterSpec,FileTailingMessageProducerSupport>