Package org.springframework.integration.channel

Class AbstractMessageChannel

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.channel.AbstractMessageChannel

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, ExpressionCapable, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageChannel, InterceptableChannel

Direct Known Subclasses:

AbstractAmqpChannel, AbstractJmsChannel, AbstractKafkaChannel, AbstractPollableChannel, AbstractSubscribableChannel, FluxMessageChannel, SubscribableRedisChannel, ZeroMqChannel

@IntegrationManagedResource
public abstract class AbstractMessageChannel
extends IntegrationObjectSupport
implements MessageChannel, TrackableComponent, InterceptableChannel, IntegrationManagement, IntegrationPattern

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	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	Description
protected final AbstractMessageChannel.ChannelInterceptorList	interceptors
protected final Set<MeterFacade>	meters

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.messaging.MessageChannel

INDEFINITE_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
AbstractMessageChannel()

Method Summary

Modifier and Type	Method	Description
void	addInterceptor(int index, ChannelInterceptor interceptor)	Add a channel interceptor to the specified index of the list.
void	addInterceptor(ChannelInterceptor interceptor)	Add a channel interceptor to the end of the list.
void	destroy()
protected abstract boolean	doSend(Message<?> message, long timeout)	Subclasses must implement this method.
String	getComponentType()	Subclasses may implement this method to provide component type information.
String	getFullChannelName()	Returns the fully qualified channel name including the application context id, if available.
protected AbstractMessageChannel.ChannelInterceptorList	getIChannelInterceptorList()	Exposes the interceptor list instance for subclasses.
IntegrationPatternType	getIntegrationPatternType()	Return a pattern type this component implements.
List<ChannelInterceptor>	getInterceptors()	Return a read-only list of the configured interceptors.
protected MetricsCaptor	getMetricsCaptor()
IntegrationManagement.ManagementOverrides	getOverrides()	Return the overrides.
boolean	isLoggingEnabled()	Return whether logging is enabled.
protected void	onInit()	Subclasses may implement this for initialization logic.
void	registerMetricsCaptor(MetricsCaptor metricsCaptorToRegister)	Inject a MetricsCaptor.
void	registerObservationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)	Inject an ObservationRegistry.
ChannelInterceptor	removeInterceptor(int index)
boolean	removeInterceptor(ChannelInterceptor interceptor)
boolean	send(Message<?> message)	Send a message on this channel.
boolean	send(Message<?> messageArg, long timeout)	Send a message on this channel.
void	setDatatypes(Class<?>... datatypes)	Specify the Message payload datatype(s) supported by this channel.
void	setInterceptors(List<ChannelInterceptor> interceptors)	Set the list of channel interceptors.
void	setLoggingEnabled(boolean loggingEnabled)	Enable logging or not.
void	setMessageConverter(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	setObservationConvention(MessageSenderObservationConvention observationConvention)
void	setShouldTrack(boolean shouldTrack)

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.IntegrationManagement

getManagedName, getManagedType, getThisAs, setManagedName, setManagedType

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

getBeanName, getComponentName

Field Details

interceptors

protected final AbstractMessageChannel.ChannelInterceptorList interceptors

meters

protected final Set<MeterFacade> meters

Constructor Details

AbstractMessageChannel

public AbstractMessageChannel()

Method Details

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

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.

setShouldTrack

public void setShouldTrack(boolean shouldTrack)

Specified by:

setShouldTrack in interface TrackableComponent

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

@Nullable
protected MetricsCaptor getMetricsCaptor()

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.

setDatatypes

public void setDatatypes(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(List<ChannelInterceptor> interceptors)

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

Specified by:

setInterceptors in interface InterceptableChannel

Parameters:

interceptors - The list of interceptors.

addInterceptor

public void addInterceptor(ChannelInterceptor interceptor)

Add a channel interceptor to the end of the list.

Specified by:

addInterceptor in interface InterceptableChannel

Parameters:

interceptor - The interceptor.

addInterceptor

public void addInterceptor(int index,
 ChannelInterceptor interceptor)

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

Specified by:

addInterceptor in interface InterceptableChannel

Parameters:

index - The index to add interceptor.

interceptor - The interceptor.

setMessageConverter

public void setMessageConverter(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.

setObservationConvention

public void setObservationConvention(@Nullable
 MessageSenderObservationConvention observationConvention)

getInterceptors

public List<ChannelInterceptor> getInterceptors()

Return a read-only list of the configured interceptors.

Specified by:

getInterceptors in interface InterceptableChannel

removeInterceptor

public boolean removeInterceptor(ChannelInterceptor interceptor)

Specified by:

removeInterceptor in interface InterceptableChannel

removeInterceptor

@Nullable
public ChannelInterceptor removeInterceptor(int index)

Specified by:

removeInterceptor in interface InterceptableChannel

getIChannelInterceptorList

protected AbstractMessageChannel.ChannelInterceptorList getIChannelInterceptorList()

Exposes the interceptor list instance for subclasses.

Returns:

The channel interceptor list.

getOverrides

public IntegrationManagement.ManagementOverrides getOverrides()

Description copied from interface: IntegrationManagement

Return the overrides.

Specified by:

getOverrides in interface IntegrationManagement

Returns:

the overrides.

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)

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class IntegrationObjectSupport

getFullChannelName

public String getFullChannelName()

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

Returns:

The name.

send

public boolean send(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 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(Message<?> messageArg,
 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 MessageChannel

Parameters:

messageArg - 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(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.

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

Specified by:

destroy in interface IntegrationManagement