org.springframework.integration.channel

Class AbstractMessageChannel

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.channel.AbstractMessageChannel

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, ChannelInterceptorAware, ExpressionCapable, NamedComponent, ConfigurableMetricsAware<AbstractMessageChannelMetrics>, IntegrationManagement, IntegrationStatsManagement, MessageChannelMetrics, TrackableComponent, org.springframework.messaging.MessageChannel

Direct Known Subclasses:

AbstractAmqpChannel, AbstractJmsChannel, AbstractPollableChannel, AbstractSubscribableChannel, FluxMessageChannel, SubscribableRedisChannel

@IntegrationManagedResource
public abstract class AbstractMessageChannel
extends IntegrationObjectSupport
implements org.springframework.messaging.MessageChannel, TrackableComponent, ChannelInterceptorAware, MessageChannelMetrics, ConfigurableMetricsAware<AbstractMessageChannelMetrics>

Base class for MessageChannel implementations providing common properties such as the channel name. Also provides the common functionality for sending and receiving Messages including the invocation of any ChannelInterceptors.

Author:

Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractMessageChannel.ChannelInterceptorList A convenience wrapper class for the list of ChannelInterceptors.

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

IntegrationManagement.ManagementOverrides

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractMessageChannel.ChannelInterceptorList	interceptors

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

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.messaging.MessageChannel

INDEFINITE_TIMEOUT

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

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractMessageChannel()

Method Summary

Modifier and Type	Method and Description
void	addInterceptor(org.springframework.messaging.support.ChannelInterceptor interceptor) Add a channel interceptor to the end of the list.
void	addInterceptor(int index, org.springframework.messaging.support.ChannelInterceptor interceptor) Add a channel interceptor to the specified index of the list.
void	configureMetrics(AbstractMessageChannelMetrics metrics)
protected abstract boolean	doSend(org.springframework.messaging.Message<?> message, long timeout) Subclasses must implement this method.
java.util.List<org.springframework.messaging.support.ChannelInterceptor>	getChannelInterceptors() Return a read-only list of the configured interceptors.
java.lang.String	getComponentType() Subclasses may implement this method to provide component type information.
Statistics	getErrorRate()
java.lang.String	getFullChannelName() Returns the fully qualified channel name including the application context id, if available.
protected AbstractMessageChannel.ChannelInterceptorList	getInterceptors() Exposes the interceptor list for subclasses.
double	getMaxSendDuration()
double	getMeanErrorRate()
double	getMeanErrorRatio()
double	getMeanSendDuration()
double	getMeanSendRate()
protected AbstractMessageChannelMetrics	getMetrics()
protected MetricsCaptor	getMetricsCaptor()
double	getMinSendDuration()
IntegrationManagement.ManagementOverrides	getOverrides() Return the overrides.
int	getSendCount()
long	getSendCountLong()
Statistics	getSendDuration()
int	getSendErrorCount()
long	getSendErrorCountLong()
Statistics	getSendRate()
double	getStandardDeviationSendDuration()
double	getTimeSinceLastSend()
boolean	isCountsEnabled()
boolean	isLoggingEnabled()
boolean	isStatsEnabled()
protected void	onInit() Subclasses may implement this for initialization logic.
void	registerMetricsCaptor(MetricsCaptor metricsCaptor) Inject a MetricsCaptor
boolean	removeInterceptor(org.springframework.messaging.support.ChannelInterceptor interceptor) Remove the provided ChannelInterceptor from the target implementation.
org.springframework.messaging.support.ChannelInterceptor	removeInterceptor(int index) Remove a ChannelInterceptor from the target implementation for specific index.
void	reset()
boolean	send(org.springframework.messaging.Message<?> message) Send a message on this channel.
boolean	send(org.springframework.messaging.Message<?> message, long timeout) Send a message on this channel.
void	setCountsEnabled(boolean countsEnabled)
void	setDatatypes(java.lang.Class<?>... datatypes) Specify the Message payload datatype(s) supported by this channel.
void	setInterceptors(java.util.List<org.springframework.messaging.support.ChannelInterceptor> interceptors) Set the list of channel interceptors.
void	setLoggingEnabled(boolean loggingEnabled)
void	setMessageConverter(org.springframework.messaging.converter.MessageConverter messageConverter) Specify the MessageConverter to use when trying to convert to one of this channel's supported datatypes (in order) for a Message whose payload does not already match.
void	setShouldTrack(boolean shouldTrack)
void	setStatsEnabled(boolean statsEnabled)

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

afterPropertiesSet, extractTypeIfPossible, getApplicationContext, getApplicationContextId, getBeanFactory, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, 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.context.NamedComponent

getComponentName

Field Detail

interceptors

protected final AbstractMessageChannel.ChannelInterceptorList interceptors

Constructor Detail

AbstractMessageChannel

public AbstractMessageChannel()

Method Detail

getComponentType

public java.lang.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

registerMetricsCaptor

public void registerMetricsCaptor(MetricsCaptor metricsCaptor)

Description copied from interface: IntegrationManagement

Inject a MetricsCaptor

Specified by:

registerMetricsCaptor in interface IntegrationManagement

Parameters:

metricsCaptor - the captor.

getMetricsCaptor

protected MetricsCaptor getMetricsCaptor()

setCountsEnabled

public void setCountsEnabled(boolean countsEnabled)

Specified by:

setCountsEnabled in interface IntegrationManagement

isCountsEnabled

public boolean isCountsEnabled()

Specified by:

isCountsEnabled in interface IntegrationManagement

setStatsEnabled

public void setStatsEnabled(boolean statsEnabled)

Specified by:

setStatsEnabled in interface IntegrationStatsManagement

isStatsEnabled

public boolean isStatsEnabled()

Specified by:

isStatsEnabled in interface IntegrationStatsManagement

isLoggingEnabled

public boolean isLoggingEnabled()

Specified by:

isLoggingEnabled in interface IntegrationManagement

setLoggingEnabled

public void setLoggingEnabled(boolean loggingEnabled)

Specified by:

setLoggingEnabled in interface IntegrationManagement

getMetrics

protected AbstractMessageChannelMetrics getMetrics()

configureMetrics

public void configureMetrics(AbstractMessageChannelMetrics metrics)

Specified by:

configureMetrics in interface ConfigurableMetricsAware<AbstractMessageChannelMetrics>

setDatatypes

public void setDatatypes(java.lang.Class<?>... datatypes)

Specify the Message payload datatype(s) supported by this channel. If a payload type does not match directly, but the 'conversionService' is available, then type conversion will be attempted in the order of the elements provided in this array.

If this property is not set explicitly, any Message payload type will be accepted.

Parameters:

datatypes - The supported data types.

See Also:

setMessageConverter(MessageConverter)

setInterceptors

public void setInterceptors(java.util.List<org.springframework.messaging.support.ChannelInterceptor> interceptors)

Set the list of channel interceptors. This will clear any existing interceptors.

Specified by:

setInterceptors in interface ChannelInterceptorAware

Parameters:

interceptors - The list of interceptors.

addInterceptor

public void addInterceptor(org.springframework.messaging.support.ChannelInterceptor interceptor)

Add a channel interceptor to the end of the list.

Specified by:

addInterceptor in interface ChannelInterceptorAware

Parameters:

interceptor - The interceptor.

addInterceptor

public void addInterceptor(int index,
                           org.springframework.messaging.support.ChannelInterceptor interceptor)

Add a channel interceptor to the specified index of the list.

Specified by:

addInterceptor in interface ChannelInterceptorAware

Parameters:

index - The index to add interceptor.

interceptor - The interceptor.

setMessageConverter

public void setMessageConverter(org.springframework.messaging.converter.MessageConverter messageConverter)

Specify the MessageConverter to use when trying to convert to one of this channel's supported datatypes (in order) for a Message whose payload does not already match.

Note: only the MessageConverter.fromMessage(Message, Class) method is used. If the returned object is not a Message, the inbound headers will be copied; if the returned object is a Message, it is expected that the converter will have fully populated the headers; no further action is performed by the channel. If null is returned, conversion to the next datatype (if any) will be attempted. Defaults to a DefaultDatatypeChannelMessageConverter.

Parameters:

messageConverter - The message converter.

getChannelInterceptors

public java.util.List<org.springframework.messaging.support.ChannelInterceptor> getChannelInterceptors()

Return a read-only list of the configured interceptors.

Specified by:

getChannelInterceptors in interface ChannelInterceptorAware

Returns:

the ChannelInterceptor list.

removeInterceptor

public boolean removeInterceptor(org.springframework.messaging.support.ChannelInterceptor interceptor)

Description copied from interface: ChannelInterceptorAware

Remove the provided ChannelInterceptor from the target implementation.

Specified by:

removeInterceptor in interface ChannelInterceptorAware

Parameters:

interceptor - ChannelInterceptor to remove.

Returns:

the boolean if ChannelInterceptor has been removed.

removeInterceptor

public org.springframework.messaging.support.ChannelInterceptor removeInterceptor(int index)

Description copied from interface: ChannelInterceptorAware

Remove a ChannelInterceptor from the target implementation for specific index.

Specified by:

removeInterceptor in interface ChannelInterceptorAware

Parameters:

index - the index for the ChannelInterceptor to remove.

Returns:

the boolean if the ChannelInterceptor has been removed.

getInterceptors

protected AbstractMessageChannel.ChannelInterceptorList getInterceptors()

Exposes the interceptor list for subclasses.

Returns:

The channel interceptor list.

reset

public void reset()

Specified by:

reset in interface IntegrationManagement

getSendCount

public int getSendCount()

Specified by:

getSendCount in interface MessageChannelMetrics

Returns:

the number of successful sends

getSendCountLong

public long getSendCountLong()

Specified by:

getSendCountLong in interface MessageChannelMetrics

Returns:

the number of successful sends

getSendErrorCount

public int getSendErrorCount()

Specified by:

getSendErrorCount in interface MessageChannelMetrics

Returns:

the number of failed sends (either throwing an exception or rejected by the channel)

getSendErrorCountLong

public long getSendErrorCountLong()

Specified by:

getSendErrorCountLong in interface MessageChannelMetrics

Returns:

the number of failed sends (either throwing an exception or rejected by the channel)

getTimeSinceLastSend

public double getTimeSinceLastSend()

Specified by:

getTimeSinceLastSend in interface MessageChannelMetrics

Returns:

the time in milliseconds since the last send

getMeanSendRate

public double getMeanSendRate()

Specified by:

getMeanSendRate in interface MessageChannelMetrics

Returns:

the mean send rate (per second)

getMeanErrorRate

public double getMeanErrorRate()

Specified by:

getMeanErrorRate in interface MessageChannelMetrics

Returns:

the mean error rate (per second). Errors comprise all failed sends.

getMeanErrorRatio

public double getMeanErrorRatio()

Specified by:

getMeanErrorRatio in interface MessageChannelMetrics

Returns:

the mean ratio of failed to successful sends in approximately the last minute

getMeanSendDuration

public double getMeanSendDuration()

Specified by:

getMeanSendDuration in interface MessageChannelMetrics

Returns:

the mean send duration (milliseconds)

getMinSendDuration

public double getMinSendDuration()

Specified by:

getMinSendDuration in interface MessageChannelMetrics

Returns:

the minimum send duration (milliseconds) since startup

getMaxSendDuration

public double getMaxSendDuration()

Specified by:

getMaxSendDuration in interface MessageChannelMetrics

Returns:

the maximum send duration (milliseconds) since startup

getStandardDeviationSendDuration

public double getStandardDeviationSendDuration()

Specified by:

getStandardDeviationSendDuration in interface MessageChannelMetrics

Returns:

the standard deviation send duration (milliseconds)

getSendDuration

public Statistics getSendDuration()

Specified by:

getSendDuration in interface MessageChannelMetrics

Returns:

summary statistics about the send duration (milliseconds)

getSendRate

public Statistics getSendRate()

Specified by:

getSendRate in interface MessageChannelMetrics

Returns:

summary statistics about the send rates (per second)

getErrorRate

public Statistics getErrorRate()

Specified by:

getErrorRate in interface MessageChannelMetrics

Returns:

summary statistics about the error rates (per second)

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()
               throws java.lang.Exception

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class IntegrationObjectSupport

Throws:

java.lang.Exception - Any exception.

getFullChannelName

public java.lang.String getFullChannelName()

Returns the fully qualified channel name including the application context id, if available.

Returns:

The name.

send

public boolean send(org.springframework.messaging.Message<?> message)

Send a message on this channel. If the channel is at capacity, this method will block until either space becomes available or the sending thread is interrupted.

Specified by:

send in interface org.springframework.messaging.MessageChannel

Parameters:

message - the Message to send

Returns:

true if the message is sent successfully or false if the sending thread is interrupted.

send

public boolean send(org.springframework.messaging.Message<?> message,
                    long timeout)

Send a message on this channel. If the channel is at capacity, this method will block until either the timeout occurs or the sending thread is interrupted. If the specified timeout is 0, the method will return immediately. If less than zero, it will block indefinitely (see send(Message)).

Specified by:

send in interface org.springframework.messaging.MessageChannel

Parameters:

message - the Message to send

timeout - the timeout in milliseconds

Returns:

true if the message is sent successfully, false if the message cannot be sent within the allotted time or the sending thread is interrupted.

doSend

protected abstract boolean doSend(org.springframework.messaging.Message<?> message,
                                  long timeout)

Subclasses must implement this method. A non-negative timeout indicates how long to wait if the channel is at capacity (if the value is 0, it must return immediately with or without success). A negative timeout value indicates that the method should block until either the message is accepted or the blocking thread is interrupted.

Parameters:

message - The message.

timeout - The timeout.

Returns:

true if the send was successful.