Package org.springframework.integration.jmx

Class NotificationPublishingMessageHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.MessageHandlerSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.jmx.NotificationPublishingMessageHandler

All Implemented Interfaces:

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

public class NotificationPublishingMessageHandler
extends AbstractMessageHandler

An AbstractMessageHandler implementation to publish an incoming message as a JMX Notification. The OutboundMessageMapper is used to convert a Message to the Notification.

Since:

2.0

Author:

Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan, Trung Pham, Ngoc Nhan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NotificationPublishingMessageHandler.PublisherDelegate	Simple class used for the actual MBean instances to be registered.

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
NotificationPublishingMessageHandler(String objectName)	Construct an instance based on the provided object name.
NotificationPublishingMessageHandler(ObjectName objectName)	Construct an instance based on the provided object name.

Method Summary

Modifier and Type	Method	Description
String	getComponentType()	Subclasses may implement this method to provide component type information.
protected void	handleMessageInternal(Message<?> message)
final void	onInit()	Subclasses may implement this for initialization logic.
void	setDefaultNotificationType(String defaultNotificationType)	Specify a dot-delimited String representing the Notification type to use by default when no explicit Notification mapper has been configured.
void	setNotificationMapper(OutboundMessageMapper<Notification> notificationMapper)	Set a mapper for creating Notifications from a Message.

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, 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, 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

NotificationPublishingMessageHandler

public NotificationPublishingMessageHandler(ObjectName objectName)

Construct an instance based on the provided object name.

Parameters:

objectName - the ObjectName to use for notification.

NotificationPublishingMessageHandler

public NotificationPublishingMessageHandler(String objectName)

Construct an instance based on the provided object name.

Parameters:

objectName - the object name to use for notification.

Method Details

setNotificationMapper

public void setNotificationMapper(@Nullable
 OutboundMessageMapper<Notification> notificationMapper)

Set a mapper for creating Notifications from a Message. If not provided, a default implementation will be used such that String-typed payloads will be passed as the 'message' of the Notification and all other payload types will be passed as the 'userData' of the Notification.

Parameters:

notificationMapper - The notification mapper.

setDefaultNotificationType

public void setDefaultNotificationType(String defaultNotificationType)

Specify a dot-delimited String representing the Notification type to use by default when no explicit Notification mapper has been configured. If not provided, then a notification type header will be required for each message being mapped into a Notification.

Parameters:

defaultNotificationType - The default notification type.

getComponentType

public String getComponentType()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this method to provide component type information.

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class MessageHandlerSupport

onInit

public final void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class IntegrationObjectSupport

handleMessageInternal

protected void handleMessageInternal(Message<?> message)

Specified by:

handleMessageInternal in class AbstractMessageHandler