Class TailAdapterSpec
java.lang.Object
org.springframework.integration.dsl.IntegrationComponentSpec<S,P>
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 -
Method Summary
Modifier and TypeMethodDescriptionautoStartup
(boolean autoStartup) delay
(long delay) The delay between checks of the file for new content in milliseconds.protected FileTailingMessageProducerSupport
doGet()
enableStatusReader
(boolean enableStatusReader) This field control the stderr events.end
(boolean end) Iftrue
, tail from the end of the file, otherwise include all lines from the beginning.errorChannel
(String errorChannel) Configure the bean name of theMessageChannel
to which error messages will be sent.errorChannel
(MessageChannel errorChannel) Configure theMessageChannel
to which error messages will be sent.errorMessageStrategy
(ErrorMessageStrategy errorMessageStrategy) Set anErrorMessageStrategy
to use to build an error message when a exception occurs.protected 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.Configure the component identifier.idleEventInterval
(long idleEventInterval) Specify the idle interval before start sending idle events.nativeOptions
(String nativeOptions) Specify the options string for nativetail
command.outputChannel
(String outputChannel) Specify the bean name of theoutputChannel
for theMessageProducer
.outputChannel
(MessageChannel outputChannel) Specify theoutputChannel
for theMessageProducer
.phase
(int phase) reopen
(boolean reopen) Iftrue
, close and reopen the file between reading chunks.sendTimeout
(long sendTimeout) Configure the default timeout value to use for send operations.shouldTrack
(boolean shouldTrack) Whether component should be tracked or not by message history.taskExecutor
(TaskExecutor taskExecutor) Configure a task executor.taskScheduler
(TaskScheduler taskScheduler) Set a task scheduler - defaults to the integration 'taskScheduler'.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
-
nativeOptions
Specify the options string for nativetail
command.- Parameters:
nativeOptions
- the nativeOptions.- Returns:
- the spec.
- See Also:
-
enableStatusReader
This field control the stderr events.- Parameters:
enableStatusReader
- boolean to enable or disable events from stderr.- Returns:
- the spec
-
idleEventInterval
Specify the idle interval before start sending idle events.- Parameters:
idleEventInterval
- interval in ms for the event idle time.- Returns:
- the spec.
-
taskExecutor
Configure a task executor. Defaults to aSimpleAsyncTaskExecutor
.- Parameters:
taskExecutor
- the taskExecutor.- Returns:
- the spec.
-
taskScheduler
Set a task scheduler - defaults to the integration 'taskScheduler'.- Parameters:
taskScheduler
- the taskScheduler.- Returns:
- the spec.
-
delay
The delay between checks of the file for new content in milliseconds.- Parameters:
delay
- the delay.- Returns:
- the spec.
- See Also:
-
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:
-
end
Iftrue
, tail from the end of the file, otherwise include all lines from the beginning. Defaulttrue
.- Parameters:
end
- the end.- Returns:
- the spec.
- See Also:
-
reopen
Iftrue
, close and reopen the file between reading chunks. Defaultfalse
.- Parameters:
reopen
- the 'reopen' option.- Returns:
- the spec.
- See Also:
-
id
Description copied from class:MessageProducerSpec
Configure the component identifier. Used as thebeanName
to register the bean in the application context for this component. Configure the message producer's bean name.- Overrides:
id
in classMessageProducerSpec<TailAdapterSpec,
FileTailingMessageProducerSupport> - Parameters:
id
- the id.- Returns:
- the spec.
-
phase
- Overrides:
phase
in classMessageProducerSpec<TailAdapterSpec,
FileTailingMessageProducerSupport> - Parameters:
phase
- the phase.- Returns:
- the spec.
- See Also:
-
autoStartup
- Overrides:
autoStartup
in classMessageProducerSpec<TailAdapterSpec,
FileTailingMessageProducerSupport> - Parameters:
autoStartup
- the autoStartup.- Returns:
- the spec.
- See Also:
-
outputChannel
Description copied from class:MessageProducerSpec
Specify theoutputChannel
for theMessageProducer
.- Overrides:
outputChannel
in classMessageProducerSpec<TailAdapterSpec,
FileTailingMessageProducerSupport> - Parameters:
outputChannel
- the outputChannel.- Returns:
- the spec.
- See Also:
-
errorChannel
Description copied from class:MessageProducerSpec
Configure theMessageChannel
to which error messages will be sent.- Overrides:
errorChannel
in classMessageProducerSpec<TailAdapterSpec,
FileTailingMessageProducerSupport> - Parameters:
errorChannel
- the errorChannel.- Returns:
- the spec.
- See Also:
-
outputChannel
Description copied from class:MessageProducerSpec
Specify the bean name of theoutputChannel
for theMessageProducer
.- Overrides:
outputChannel
in classMessageProducerSpec<TailAdapterSpec,
FileTailingMessageProducerSupport> - Parameters:
outputChannel
- the outputChannel bean name.- Returns:
- the spec.
- See Also:
-
errorChannel
Description copied from class:MessageProducerSpec
Configure the bean name of theMessageChannel
to which error messages will be sent.- Overrides:
errorChannel
in classMessageProducerSpec<TailAdapterSpec,
FileTailingMessageProducerSupport> - Parameters:
errorChannel
- the errorChannel bean name.- Returns:
- the spec.
- See Also:
-
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 classMessageProducerSpec<TailAdapterSpec,
FileTailingMessageProducerSupport> - Parameters:
sendTimeout
- the send timeout in milliseconds- Returns:
- the spec.
- See Also:
-
shouldTrack
Description copied from class:MessageProducerSpec
Whether component should be tracked or not by message history.- Overrides:
shouldTrack
in classMessageProducerSpec<TailAdapterSpec,
FileTailingMessageProducerSupport> - Parameters:
shouldTrack
- the tracking flag- Returns:
- the spec.
- See Also:
-
errorMessageStrategy
Description copied from class:MessageProducerSpec
Set anErrorMessageStrategy
to use to build an error message when a exception occurs.- Overrides:
errorMessageStrategy
in classMessageProducerSpec<TailAdapterSpec,
FileTailingMessageProducerSupport> - Parameters:
errorMessageStrategy
- theErrorMessageStrategy
.- Returns:
- the spec.
- See Also:
-
doGet
- Overrides:
doGet
in classIntegrationComponentSpec<TailAdapterSpec,
FileTailingMessageProducerSupport>
-