org.springframework.integration.handler

Class AbstractMessageHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.AbstractMessageHandler

All Implemented Interfaces:

org.reactivestreams.Subscriber<Message<?>>, Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Ordered, ExpressionCapable, Orderable, NamedComponent, BaseHandlerMetrics, ConfigurableMetricsAware<AbstractMessageHandlerMetrics>, IntegrationManagement, IntegrationStatsManagement, MessageHandlerMetrics, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>

Direct Known Subclasses:

AbstractInternetProtocolSendingMessageHandler, AbstractMessageProducingHandler, AbstractMessageRouter, AbstractMqttMessageHandler, AbstractXmppConnectionAwareMessageHandler, ApplicationEventPublishingMessageHandler, ByteStreamWritingMessageHandler, CacheWritingMessageHandler, CharacterStreamWritingMessageHandler, CorrelatingMessageBarrier, ExpressionEvaluatingMessageHandler, FileTransferringMessageHandler, JdbcMessageHandler, JmsSendingMessageHandler, LoggingHandler, MailSendingMessageHandler, MethodInvokingMessageHandler, MongoDbStoringMessageHandler, NotificationPublishingMessageHandler, RedisPublishingMessageHandler, RedisQueueOutboundChannelAdapter, RedisStoreWritingMessageHandler, StompMessageHandler, StoredProcMessageHandler, TcpSendingMessageHandler, WebSocketOutboundMessageHandler

@IntegrationManagedResource
public abstract class AbstractMessageHandler
extends IntegrationObjectSupport
implements MessageHandler, MessageHandlerMetrics, ConfigurableMetricsAware<AbstractMessageHandlerMetrics>, TrackableComponent, Orderable, reactor.core.CoreSubscriber<Message<?>>

Base class for MessageHandler implementations 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.

Author:

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

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 and Description
AbstractMessageHandler()

Method Summary

Modifier and Type	Method and Description
void	configureMetrics(AbstractMessageHandlerMetrics metrics)
void	destroy()
int	getActiveCount()
long	getActiveCountLong()
String	getComponentType() Subclasses may implement this method to provide component type information.
Statistics	getDuration()
int	getErrorCount()
long	getErrorCountLong()
int	getHandleCount()
long	getHandleCountLong()
String	getManagedName()
String	getManagedType()
double	getMaxDuration()
double	getMeanDuration()
protected MetricsCaptor	getMetricsCaptor()
double	getMinDuration()
int	getOrder()
IntegrationManagement.ManagementOverrides	getOverrides() Return the overrides.
double	getStandardDeviationDuration()
void	handleMessage(Message<?> messageArg)
protected abstract void	handleMessageInternal(Message<?> message)
boolean	isCountsEnabled()
boolean	isLoggingEnabled()
boolean	isStatsEnabled()
void	onComplete()
void	onError(Throwable throwable)
protected void	onInit() Subclasses may implement this for initialization logic.
void	onNext(Message<?> message)
void	onSubscribe(org.reactivestreams.Subscription subscription)
void	registerMetricsCaptor(MetricsCaptor metricsCaptorToRegister) Inject a MetricsCaptor
void	reset()
void	setCountsEnabled(boolean countsEnabled)
void	setLoggingEnabled(boolean loggingEnabled)
void	setManagedName(String managedName)
void	setManagedType(String managedType)
void	setOrder(int order) Set the order for this component.
void	setShouldTrack(boolean shouldTrack)
void	setStatsEnabled(boolean statsEnabled)

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 org.springframework.integration.support.management.MessageHandlerMetrics

errorCount, handleCount

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

getBeanName, getComponentName

Methods inherited from interface reactor.core.CoreSubscriber

currentContext

Constructor Detail

AbstractMessageHandler

public AbstractMessageHandler()

Method Detail

isLoggingEnabled

public boolean isLoggingEnabled()

Specified by:

isLoggingEnabled in interface IntegrationManagement

setLoggingEnabled

public void setLoggingEnabled(boolean loggingEnabled)

Specified by:

setLoggingEnabled in interface IntegrationManagement

registerMetricsCaptor

public void registerMetricsCaptor(MetricsCaptor metricsCaptorToRegister)

Description copied from interface: IntegrationManagement

Inject a MetricsCaptor

Specified by:

registerMetricsCaptor in interface IntegrationManagement

Parameters:

metricsCaptorToRegister - the captor.

getMetricsCaptor

@Nullable
protected MetricsCaptor getMetricsCaptor()

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

configureMetrics

public void configureMetrics(AbstractMessageHandlerMetrics metrics)

Specified by:

configureMetrics in interface ConfigurableMetricsAware<AbstractMessageHandlerMetrics>

getOverrides

public IntegrationManagement.ManagementOverrides getOverrides()

Description copied from interface: IntegrationManagement

Return the overrides.

Specified by:

getOverrides in interface IntegrationManagement

Returns:

the overrides.

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class IntegrationObjectSupport

handleMessage

public void handleMessage(Message<?> messageArg)

Specified by:

handleMessage in interface MessageHandler

onSubscribe

public void onSubscribe(org.reactivestreams.Subscription subscription)

Specified by:

onSubscribe in interface org.reactivestreams.Subscriber<Message<?>>

Specified by:

onSubscribe in interface reactor.core.CoreSubscriber<Message<?>>

onNext

public void onNext(Message<?> message)

Specified by:

onNext in interface org.reactivestreams.Subscriber<Message<?>>

onError

public void onError(Throwable throwable)

Specified by:

onError in interface org.reactivestreams.Subscriber<Message<?>>

onComplete

public void onComplete()

Specified by:

onComplete in interface org.reactivestreams.Subscriber<Message<?>>

handleMessageInternal

protected abstract void handleMessageInternal(Message<?> message)

reset

public void reset()

Specified by:

reset in interface IntegrationManagement

getHandleCountLong

public long getHandleCountLong()

Specified by:

getHandleCountLong in interface MessageHandlerMetrics

Returns:

the number of successful handler calls

getHandleCount

public int getHandleCount()

Specified by:

getHandleCount in interface MessageHandlerMetrics

Returns:

the number of successful handler calls

getErrorCount

public int getErrorCount()

Specified by:

getErrorCount in interface MessageHandlerMetrics

Returns:

the number of failed handler calls

getErrorCountLong

public long getErrorCountLong()

Specified by:

getErrorCountLong in interface MessageHandlerMetrics

Returns:

the number of failed handler calls

getMeanDuration

public double getMeanDuration()

Specified by:

getMeanDuration in interface MessageHandlerMetrics

Returns:

the mean handler duration (milliseconds)

getMinDuration

public double getMinDuration()

Specified by:

getMinDuration in interface MessageHandlerMetrics

Returns:

the minimum handler duration (milliseconds)

getMaxDuration

public double getMaxDuration()

Specified by:

getMaxDuration in interface MessageHandlerMetrics

Returns:

the maximum handler duration (milliseconds)

getStandardDeviationDuration

public double getStandardDeviationDuration()

Specified by:

getStandardDeviationDuration in interface MessageHandlerMetrics

Returns:

the standard deviation handler duration (milliseconds)

getActiveCount

public int getActiveCount()

Specified by:

getActiveCount in interface MessageHandlerMetrics

getActiveCountLong

public long getActiveCountLong()

Specified by:

getActiveCountLong in interface MessageHandlerMetrics

getDuration

public Statistics getDuration()

Specified by:

getDuration in interface MessageHandlerMetrics

Returns:

summary statistics about the handler duration (milliseconds)

setStatsEnabled

public void setStatsEnabled(boolean statsEnabled)

Specified by:

setStatsEnabled in interface IntegrationStatsManagement

isStatsEnabled

public boolean isStatsEnabled()

Specified by:

isStatsEnabled in interface IntegrationStatsManagement

setCountsEnabled

public void setCountsEnabled(boolean countsEnabled)

Specified by:

setCountsEnabled in interface IntegrationManagement

isCountsEnabled

public boolean isCountsEnabled()

Specified by:

isCountsEnabled in interface IntegrationManagement

setManagedName

public void setManagedName(String managedName)

Specified by:

setManagedName in interface MessageHandlerMetrics

getManagedName

public String getManagedName()

Specified by:

getManagedName in interface MessageHandlerMetrics

setManagedType

public void setManagedType(String managedType)

Specified by:

setManagedType in interface MessageHandlerMetrics

getManagedType

public String getManagedType()

Specified by:

getManagedType in interface MessageHandlerMetrics

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

Specified by:

destroy in interface IntegrationManagement