Package org.springframework.integration.handler

Class MessageHandlerSupport

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.MessageHandlerSupport

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Ordered, ExpressionCapable, Orderable, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent

Direct Known Subclasses:

AbstractMessageHandler, AbstractReactiveMessageHandler

@IntegrationManagedResource
public abstract class MessageHandlerSupport
extends IntegrationObjectSupport
implements TrackableComponent, Orderable, IntegrationManagement, IntegrationPattern

Base class for Message handling components that provides basic validation and error handling capabilities. Asserts that the incoming Message is not null and that it does not contain a null payload. Converts checked exceptions into runtime MessagingExceptions.

Since:

5.3

Author:

Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan, Amit Sadafule, David Turanski

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

Method Summary

Modifier and Type	Method	Description
protected TimerFacade	buildSendTimer(boolean success, String exception)
void	destroy()
String	getComponentType()	Subclasses may implement this method to provide component type information.
IntegrationPatternType	getIntegrationPatternType()	Return a pattern type this component implements.
String	getManagedName()
String	getManagedType()
protected MetricsCaptor	getMetricsCaptor()
protected io.micrometer.observation.ObservationRegistry	getObservationRegistry()
int	getOrder()
IntegrationManagement.ManagementOverrides	getOverrides()	Return the overrides.
boolean	isLoggingEnabled()	Return whether logging is enabled.
boolean	isObserved()	True if this implementation is going to deal with a registry other than the ObservationRegistry.NOOP instance.
void	registerMetricsCaptor(MetricsCaptor metricsCaptorToRegister)	Inject a MetricsCaptor.
void	registerObservationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)	Inject an ObservationRegistry.
protected TimerFacade	sendTimer()
void	setLoggingEnabled(boolean loggingEnabled)	Enable logging or not.
void	setManagedName(String managedName)
void	setManagedType(String managedType)
void	setOrder(int order)	Set the order for this component.
void	setShouldTrack(boolean shouldTrack)
protected boolean	shouldTrack()

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

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, onInit, 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 org.springframework.integration.support.management.IntegrationManagement

getThisAs

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

getBeanName, getComponentName

Constructor Details

MessageHandlerSupport

public MessageHandlerSupport()

Method Details

isLoggingEnabled

public boolean isLoggingEnabled()

Description copied from interface: IntegrationManagement

Return whether logging is enabled.

Specified by:

isLoggingEnabled in interface IntegrationManagement

Returns:

true if enabled.

setLoggingEnabled

public void setLoggingEnabled(boolean loggingEnabled)

Description copied from interface: IntegrationManagement

Enable logging or not.

Specified by:

setLoggingEnabled in interface IntegrationManagement

Parameters:

loggingEnabled - false to disable.

registerMetricsCaptor

public void registerMetricsCaptor(MetricsCaptor metricsCaptorToRegister)

Description copied from interface: IntegrationManagement

Inject a MetricsCaptor. Ignored if ObservationRegistry is provided.

Specified by:

registerMetricsCaptor in interface IntegrationManagement

Parameters:

metricsCaptorToRegister - the captor.

See Also:

• IntegrationManagement.registerObservationRegistry(ObservationRegistry)

getMetricsCaptor

protected MetricsCaptor getMetricsCaptor()

registerObservationRegistry

public void registerObservationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)

Description copied from interface: IntegrationManagement

Inject an ObservationRegistry. If provided, the MetricsCaptor is ignored. The meters capturing has to be configured as an ObservationHandler on the provided ObservationRegistry.

Specified by:

registerObservationRegistry in interface IntegrationManagement

Parameters:

observationRegistry - the ObservationRegistry to expose observations from the component.

See Also:

• IntegrationManagement.registerMetricsCaptor(MetricsCaptor)

isObserved

public boolean isObserved()

Description copied from interface: IntegrationManagement

True if this implementation is going to deal with a registry other than the ObservationRegistry.NOOP instance.

Specified by:

isObserved in interface IntegrationManagement

Returns:

true if this implementation is going to deal with a registry other than the ObservationRegistry.NOOP instance.

getObservationRegistry

protected io.micrometer.observation.ObservationRegistry getObservationRegistry()

setOrder

public void setOrder(int order)

Description copied from interface: Orderable

Set the order for this component.

Specified by:

setOrder in interface Orderable

Parameters:

order - the order.

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

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 IntegrationObjectSupport

setShouldTrack

public void setShouldTrack(boolean shouldTrack)

Specified by:

setShouldTrack in interface TrackableComponent

shouldTrack

protected boolean shouldTrack()

getOverrides

public IntegrationManagement.ManagementOverrides getOverrides()

Description copied from interface: IntegrationManagement

Return the overrides.

Specified by:

getOverrides in interface IntegrationManagement

Returns:

the overrides.

getIntegrationPatternType

public IntegrationPatternType getIntegrationPatternType()

Description copied from interface: IntegrationPattern

Return a pattern type this component implements.

Specified by:

getIntegrationPatternType in interface IntegrationPattern

Returns:

the IntegrationPatternType this component implements.

sendTimer

protected TimerFacade sendTimer()

buildSendTimer

protected TimerFacade buildSendTimer(boolean success,
 String exception)

setManagedName

public void setManagedName(String managedName)

Specified by:

setManagedName in interface IntegrationManagement

getManagedName

public String getManagedName()

Specified by:

getManagedName in interface IntegrationManagement

setManagedType

public void setManagedType(String managedType)

Specified by:

setManagedType in interface IntegrationManagement

getManagedType

public String getManagedType()

Specified by:

getManagedType in interface IntegrationManagement

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

Specified by:

destroy in interface IntegrationManagement