Package org.springframework.integration.dsl

Class MessageProducerSpec<S extends MessageProducerSpec<S,P>,P extends MessageProducerSupport>

java.lang.Object

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

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

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

Type Parameters:

S - the target MessageProducerSpec implementation type.

P - the target MessageProducerSupport implementation type.

All Implemented Interfaces:

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

Direct Known Subclasses:

AmqpBaseInboundChannelAdapterSpec, ImapIdleChannelAdapterSpec, JmsMessageDrivenChannelAdapterSpec, KafkaMessageDrivenChannelAdapterSpec, MongoDbChangeStreamMessageProducerSpec, TailAdapterSpec, TcpInboundChannelAdapterSpec, UdpInboundChannelAdapterSpec, ZeroMqMessageProducerSpec

public abstract class MessageProducerSpec<S extends MessageProducerSpec<S,P>,P extends MessageProducerSupport>
extends IntegrationComponentSpec<S,P>

An IntegrationComponentSpec for MessageProducers.

Since:

5.0

Author:

Artem Bilan

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.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
MessageProducerSpec(P producer)

Method Summary

Modifier and Type	Method	Description
S	autoStartup(boolean autoStartup)
S	errorChannel(String errorChannel)	Configure the bean name of the MessageChannel to which error messages will be sent.
S	errorChannel(MessageChannel errorChannel)	Configure the MessageChannel to which error messages will be sent.
S	errorMessageStrategy(ErrorMessageStrategy errorMessageStrategy)	Set an ErrorMessageStrategy to use to build an error message when a exception occurs.
S	id(String id)	Configure the component identifier.
S	outputChannel(String outputChannel)	Specify the bean name of the outputChannel for the MessageProducer.
S	outputChannel(MessageChannel outputChannel)	Specify the outputChannel for the MessageProducer.
S	phase(int phase)
S	sendTimeout(long sendTimeout)	Configure the default timeout value to use for send operations.
S	shouldTrack(boolean shouldTrack)	Whether component should be tracked or not by message history.

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

_this, createInstance, destroyInstance, doGet, 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

Constructor Details

MessageProducerSpec

public MessageProducerSpec(P producer)

Method Details

id

public S id(String id)

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 IntegrationComponentSpec<S extends MessageProducerSpec<S,P>,P extends MessageProducerSupport>

Parameters:

id - the id.

Returns:

the spec.

phase

public S phase(int phase)

Parameters:

phase - the phase.

Returns:

the spec.

See Also:

• SmartLifecycle

autoStartup

public S autoStartup(boolean autoStartup)

Parameters:

autoStartup - the autoStartup.

Returns:

the spec.

See Also:

• SmartLifecycle

outputChannel

public S outputChannel(MessageChannel outputChannel)

Specify the outputChannel for the MessageProducer.

Parameters:

outputChannel - the outputChannel.

Returns:

the spec.

See Also:

• MessageProducerSupport.setOutputChannel(MessageChannel)

outputChannel

public S outputChannel(String outputChannel)

Specify the bean name of the outputChannel for the MessageProducer.

Parameters:

outputChannel - the outputChannel bean name.

Returns:

the spec.

See Also:

• MessageProducerSupport.setOutputChannelName(String)

errorChannel

public S errorChannel(MessageChannel errorChannel)

Configure the MessageChannel to which error messages will be sent.

Parameters:

errorChannel - the errorChannel.

Returns:

the spec.

See Also:

• MessageProducerSupport.setErrorChannel(MessageChannel)

errorChannel

public S errorChannel(String errorChannel)

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

Parameters:

errorChannel - the errorChannel bean name.

Returns:

the spec.

See Also:

• MessageProducerSupport.setErrorChannelName(String)

sendTimeout

public S sendTimeout(long sendTimeout)

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

Parameters:

sendTimeout - the send timeout in milliseconds

Returns:

the spec.

Since:

5.0.2

See Also:

• MessageProducerSupport.setSendTimeout(long)

shouldTrack

public S shouldTrack(boolean shouldTrack)

Whether component should be tracked or not by message history.

Parameters:

shouldTrack - the tracking flag

Returns:

the spec.

Since:

5.0.2

See Also:

• MessageProducerSupport.setShouldTrack(boolean)

errorMessageStrategy

public S errorMessageStrategy(ErrorMessageStrategy errorMessageStrategy)

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

Parameters:

errorMessageStrategy - the ErrorMessageStrategy.

Returns:

the spec.

Since:

5.0.2

See Also:

• MessageProducerSupport.setErrorMessageStrategy(ErrorMessageStrategy)