Class TailAdapterSpec

java.lang.Object

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

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

org.springframework.integration.file.dsl.TailAdapterSpec

All Implemented Interfaces:

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

logger, PARSER, target

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

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TailAdapterSpec()

Method Summary

Modifier and Type	Method	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(String errorChannel)	Configure the bean name of the MessageChannel to which error messages will be sent.
TailAdapterSpec	errorChannel(MessageChannel errorChannel)	Configure the MessageChannel to which error messages will be sent.
TailAdapterSpec	errorMessageStrategy(ErrorMessageStrategy errorMessageStrategy)	Set an ErrorMessageStrategy to use to build an error message when a exception occurs.
protected TailAdapterSpec	file(File file)
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(String outputChannel)	Specify the bean name of the outputChannel for the MessageProducer.
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	sendTimeout(long sendTimeout)	Configure the default timeout value to use for send operations.
TailAdapterSpec	shouldTrack(boolean shouldTrack)	Whether component should be tracked or not by message history.
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

observationConvention, role

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

_this, afterPropertiesSet, destroy, getId, getObject, getObjectType, getPhase, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class java.lang.Object

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

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

isSingleton

Constructor Details

TailAdapterSpec

protected TailAdapterSpec()

Method Details

file

protected TailAdapterSpec file(File file)

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' option.

Returns:

the spec.

See Also:

• ApacheCommonsFileTailingMessageProducer.setReopen(boolean)

id

public TailAdapterSpec id(@Nullable
 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)

outputChannel

public TailAdapterSpec outputChannel(String outputChannel)

Description copied from class: MessageProducerSpec

Specify the bean name of the outputChannel for the MessageProducer.

Overrides:

outputChannel in class MessageProducerSpec<TailAdapterSpec,FileTailingMessageProducerSupport>

Parameters:

outputChannel - the outputChannel bean name.

Returns:

the spec.

See Also:

• MessageProducerSupport.setOutputChannelName(String)

errorChannel

public TailAdapterSpec errorChannel(String errorChannel)

Description copied from class: MessageProducerSpec

Configure the bean name of the MessageChannel to which error messages will be sent.

Overrides:

errorChannel in class MessageProducerSpec<TailAdapterSpec,FileTailingMessageProducerSupport>

Parameters:

errorChannel - the errorChannel bean name.

Returns:

the spec.

See Also:

• MessageProducerSupport.setErrorChannelName(String)

sendTimeout

public TailAdapterSpec sendTimeout(long sendTimeout)

Description copied from class: MessageProducerSpec

Configure the default timeout value to use for send operations. May be overridden for individual messages.

Overrides:

sendTimeout in class MessageProducerSpec<TailAdapterSpec,FileTailingMessageProducerSupport>

Parameters:

sendTimeout - the send timeout in milliseconds

Returns:

the spec.

See Also:

• MessageProducerSupport.setSendTimeout(long)

shouldTrack

public TailAdapterSpec shouldTrack(boolean shouldTrack)

Description copied from class: MessageProducerSpec

Whether component should be tracked or not by message history.

Overrides:

shouldTrack in class MessageProducerSpec<TailAdapterSpec,FileTailingMessageProducerSupport>

Parameters:

shouldTrack - the tracking flag

Returns:

the spec.

See Also:

• MessageProducerSupport.setShouldTrack(boolean)

errorMessageStrategy

public TailAdapterSpec errorMessageStrategy(ErrorMessageStrategy errorMessageStrategy)

Description copied from class: MessageProducerSpec

Set an ErrorMessageStrategy to use to build an error message when a exception occurs.

Overrides:

errorMessageStrategy in class MessageProducerSpec<TailAdapterSpec,FileTailingMessageProducerSupport>

Parameters:

errorMessageStrategy - the ErrorMessageStrategy.

Returns:

the spec.

See Also:

• MessageProducerSupport.setErrorMessageStrategy(ErrorMessageStrategy)

doGet

protected FileTailingMessageProducerSupport doGet()

Overrides:

doGet in class IntegrationComponentSpec<TailAdapterSpec,FileTailingMessageProducerSupport>