org.springframework.integration.handler.AbstractMessageProducingHandler

All Implemented Interfaces:: org.reactivestreams.Subscriber<Message<?>>, Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Ordered, ExpressionCapable, Orderable, MessageProducer, HeaderPropagationAware, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>

Direct Known Subclasses:: AbstractCorrelatingMessageHandler, AbstractReplyProducingMessageHandler, FluxAggregatorMessageHandler, MessageHandlerChain, MockMessageHandler

public abstract class AbstractMessageProducingHandler
extends AbstractMessageHandler
implements MessageProducer, HeaderPropagationAware

The base AbstractMessageHandler implementation for the MessageProducer.

Author:: David Liu, Artem Bilan, Gary Russell, Marius Bogoevici since 4.1

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement
IntegrationManagement.ManagementOverrides
Field Summary

Fields

Modifier and Type Field Description

protected MessagingTemplate messagingTemplate

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport
EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement
METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
Constructor Summary

Constructors

Constructor Description

AbstractMessageProducingHandler()

Method Summary

Modifier and Type	Method	Description
`void`	`addNotPropagatedHeaders(String... headers)`	Add header patterns ("xxx", "xxx", "xxx" or "xxx*yyy") that will NOT be copied from the inbound message if `shouldCopyRequestHeaders()` is true, instead of overwriting the existing set.
`protected Message<?>`	`createOutputMessage(Object output, MessageHeaders requestHeaders)`
`Collection<String>`	`getNotPropagatedHeaders()`	Get the header patterns this handler doesn't propagate.
`MessageChannel`	`getOutputChannel()`	Return the the output channel.
`protected boolean`	`isAsync()`
`protected AbstractIntegrationMessageBuilder<?>`	`messageBuilderForReply(Object reply)`
`protected void`	`onInit()`	Subclasses may implement this for initialization logic.
`protected void`	`produceOutput(Object replyArg, Message<?> requestMessage)`
`protected Object`	`resolveErrorChannel(MessageHeaders requestHeaders)`
`protected void`	`sendErrorMessage(Message<?> requestMessage, Throwable ex)`
`protected void`	`sendOutput(Object output, Object replyChannelArg, boolean useArgChannel)`	Send an output Message.
`protected void`	`sendOutputs(Object result, Message<?> requestMessage)`
`void`	`setAsync(boolean async)`	Allow async replies.
`void`	`setNotPropagatedHeaders(String... headers)`	Set header patterns ("xxx", "xxx", "xxx" or "xxx*yyy") that will NOT be copied from the inbound message if `shouldCopyRequestHeaaders` is true.
`void`	`setOutputChannel(MessageChannel outputChannel)`	Specify the `MessageChannel` to which produced Messages should be sent.
`void`	`setOutputChannelName(String outputChannelName)`	Specify the bean name of the `MessageChannel` to which produced Messages should be sent.
`void`	`setSendTimeout(long sendTimeout)`	Set the timeout for sending reply Messages.
`protected boolean`	`shouldCopyRequestHeaders()`	Subclasses may override this.
`protected boolean`	`shouldSplitOutput(Iterable<?> reply)`
`protected void`	`updateNotPropagatedHeaders(String[] headers, boolean merge)`	Set or replace not propagated headers.

Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler

handleMessage, handleMessageInternal, onComplete, onError, onNext, onSubscribe

Methods inherited from class org.springframework.integration.handler.MessageHandlerSupport

buildSendTimer, destroy, getComponentType, getIntegrationPatternType, getManagedName, getManagedType, getMetricsCaptor, getOrder, getOverrides, isLoggingEnabled, registerMetricsCaptor, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrack

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

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface reactor.core.CoreSubscriber

currentContext

Methods inherited from interface org.springframework.integration.support.management.IntegrationManagement

getThisAs

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getBeanName, getComponentName

Field Details
- messagingTemplate
  
  protected final MessagingTemplate messagingTemplate
Constructor Details
- AbstractMessageProducingHandler
  
  public AbstractMessageProducingHandler()
Method Details
- setSendTimeout
  
  public void setSendTimeout(long sendTimeout)
  
  Set the timeout for sending reply Messages.
  
  Parameters:
  
  sendTimeout - The send timeout.
- setOutputChannel
  
  public void setOutputChannel(MessageChannel outputChannel)
  
  Description copied from interface: MessageProducer
  
  Specify the MessageChannel to which produced Messages should be sent.
  
  Specified by:
  
  setOutputChannel in interface MessageProducer
  
  Parameters:
  
  outputChannel - The output channel.
- setOutputChannelName
  
  public void setOutputChannelName(String outputChannelName)
  
  Description copied from interface: MessageProducer
  
  Specify the bean name of the MessageChannel to which produced Messages should be sent.
  
  Specified by:
  
  setOutputChannelName in interface MessageProducer
  
  Parameters:
  
  outputChannelName - The output channel bean name.
- setAsync
  
  public final void setAsync(boolean async)
  
  Allow async replies. If the handler reply is a ListenableFuture, send the output when it is satisfied rather than sending the future as the result. Ignored for return types other than ListenableFuture.
  
  Parameters:
  
  async - true to allow.
  
  Since:
  
  4.3
- isAsync
  
  protected boolean isAsync()
  
  Returns:
  
  true if this handler supports async replies.
  
  Since:
  
  4.3
  
  See Also:
  
  setAsync(boolean)
- setNotPropagatedHeaders
  
  public void setNotPropagatedHeaders(String... headers)
  
  Set header patterns ("xxx*", "*xxx", "*xxx*" or "xxx*yyy") that will NOT be copied from the inbound message if shouldCopyRequestHeaaders is true. At least one pattern as "*" means do not copy headers at all.
  
  Specified by:
  
  setNotPropagatedHeaders in interface HeaderPropagationAware
  
  Parameters:
  
  headers - the headers to not propagate from the inbound message.
  
  Since:
  
  4.3.10
  
  See Also:
  
  PatternMatchUtils
- updateNotPropagatedHeaders
  
  protected final void updateNotPropagatedHeaders(String[] headers, boolean merge)
  
  Set or replace not propagated headers. Exposed so that subclasses can set specific headers in a constructor, since setNotPropagatedHeaders(String...) is not final.
  
  Parameters:
  
  headers - Header patterns to not propagate.
  
  merge - true to merge with existing patterns; false to replace.
  
  Since:
  
  5.0.2
- getNotPropagatedHeaders
  
  public Collection<String> getNotPropagatedHeaders()
  
  Get the header patterns this handler doesn't propagate.
  
  Specified by:
  
  getNotPropagatedHeaders in interface HeaderPropagationAware
  
  Returns:
  
  an immutable Collection of headers that will not be copied from the inbound message if shouldCopyRequestHeaders() is true.
  
  Since:
  
  4.3.10
  
  See Also:
  
  setNotPropagatedHeaders(String...), PatternMatchUtils
- addNotPropagatedHeaders
  
  public void addNotPropagatedHeaders(String... headers)
  
  Add header patterns ("xxx*", "*xxx", "*xxx*" or "xxx*yyy") that will NOT be copied from the inbound message if shouldCopyRequestHeaders() is true, instead of overwriting the existing set.
  
  Specified by:
  
  addNotPropagatedHeaders in interface HeaderPropagationAware
  
  Parameters:
  
  headers - the headers to not propagate from the inbound message.
  
  Since:
  
  4.3.10
  
  See Also:
  
  setNotPropagatedHeaders(String...)
- onInit
  
  protected void onInit()
  
  Description copied from class: IntegrationObjectSupport
  
  Subclasses may implement this for initialization logic.
  
  Overrides:
  
  onInit in class IntegrationObjectSupport
- getOutputChannel
  
  @Nullable public MessageChannel getOutputChannel()
  
  Description copied from interface: MessageProducer
  
  Return the the output channel.
  
  Specified by:
  
  getOutputChannel in interface MessageProducer
  
  Returns:
  
  the channel.
- sendOutputs
  
  protected void sendOutputs(Object result, Message<?> requestMessage)
- shouldSplitOutput
  
  protected boolean shouldSplitOutput(Iterable<?> reply)
- produceOutput
  
  protected void produceOutput(Object replyArg, Message<?> requestMessage)
- messageBuilderForReply
  
  protected AbstractIntegrationMessageBuilder<?> messageBuilderForReply(Object reply)
- createOutputMessage
  
  protected Message<?> createOutputMessage(Object output, MessageHeaders requestHeaders)
- sendOutput
  
  protected void sendOutput(Object output, @Nullable Object replyChannelArg, boolean useArgChannel)
  
  Send an output Message. The 'replyChannel' will be considered only if this handler's 'outputChannel' is null. In that case, the 'replyChannel' value must not also be null, and it must be an instance of either String or MessageChannel.
  
  Parameters:
  
  output - the output object to send
  
  replyChannelArg - the 'replyChannel' value from the original request
  
  useArgChannel - - use the replyChannel argument (must not be null), not the configured output channel.
- shouldCopyRequestHeaders
  
  protected boolean shouldCopyRequestHeaders()
  
  Subclasses may override this. True by default.
  
  Returns:
  
  true if the request headers should be copied.
- sendErrorMessage
  
  protected void sendErrorMessage(Message<?> requestMessage, Throwable ex)
- resolveErrorChannel
  
  protected Object resolveErrorChannel(MessageHeaders requestHeaders)

Class AbstractMessageProducingHandler

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

Field Summary

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

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

Fields inherited from interface org.springframework.core.Ordered

Constructor Summary