Class ApplicationEventPublishingMessageHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.MessageHandlerSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.event.outbound.ApplicationEventPublishingMessageHandler

All Implemented Interfaces:

org.reactivestreams.Subscriber<Message<?>>, Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, ApplicationEventPublisherAware, Ordered, ComponentSourceAware, ExpressionCapable, Orderable, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>

public class ApplicationEventPublishingMessageHandler
extends AbstractMessageHandler
implements ApplicationEventPublisherAware

A MessageHandler that publishes each Message it receives as a MessagingEvent. The MessagingEvent is a subclass of Spring's ApplicationEvent used by this adapter to simply wrap the Message.

However, if the payload is an instance of ApplicationEvent, or if the publishPayload flag is specified to true, the payload will be published as is without wrapping to any ApplicationEvent.

Author:

Mark Fisher, Artem Bilan

Nested Class Summary

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

IntegrationManagement.ManagementOverrides

Field Summary

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
ApplicationEventPublishingMessageHandler()

Method Summary

Modifier and Type	Method	Description
protected void	handleMessageInternal(Message<?> message)
void	setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
void	setPublishPayload(boolean publishPayload)	Specify if payload should be published as is or the whole message must be wrapped to the MessagingEvent.

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

handleMessage, onComplete, onError, onNext, onSubscribe, setObservationConvention

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

buildSendTimer, destroy, getComponentType, getIntegrationPatternType, getManagedName, getManagedType, getMetricsCaptor, getObservationRegistry, getOrder, getOverrides, isLoggingEnabled, isObserved, registerMetricsCaptor, registerObservationRegistry, 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, getComponentDescription, getComponentName, getComponentSource, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, onInit, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, 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

Constructor Details

ApplicationEventPublishingMessageHandler

public ApplicationEventPublishingMessageHandler()

Method Details

setPublishPayload

public void setPublishPayload(boolean publishPayload)

Specify if payload should be published as is or the whole message must be wrapped to the MessagingEvent.

Parameters:

publishPayload - the boolean flag to wrap the message to the MessagingEvent or publish payload as is. Defaults to false.

Since:

4.2

See Also:

• ApplicationEventPublisher.publishEvent(Object)

setApplicationEventPublisher

public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface ApplicationEventPublisherAware

handleMessageInternal

protected void handleMessageInternal(Message<?> message)

Specified by:

handleMessageInternal in class AbstractMessageHandler