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, InitializingBean, ApplicationContextAware, ChannelInterceptorAware, TrackableComponent, NamedComponent, MessageChannel

Direct Known Subclasses:

AbstractAmqpChannel, AbstractJmsChannel, AbstractPollableChannel, AbstractSubscribableChannel, SubscribableRedisChannel

public abstract class AbstractMessageChannel
extends IntegrationObjectSupport
implements MessageChannel, TrackableComponent, ChannelInterceptorAware

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 class	AbstractMessageChannel.ChannelInterceptorList A convenience wrapper class for the list of ChannelInterceptors.

Field Summary

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

logger

Fields inherited from interface org.springframework.messaging.MessageChannel

INDEFINITE_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
AbstractMessageChannel()

Method Summary

Methods

Modifier and Type	Method and Description
void	addInterceptor(ChannelInterceptor interceptor) Add a channel interceptor to the end of the list.
void	addInterceptor(int index, ChannelInterceptor interceptor) Add a channel interceptor to the specified index of the list.
protected abstract boolean	doSend(Message<?> message, long timeout) Subclasses must implement this method.
List<ChannelInterceptor>	getChannelInterceptors() Return a read-only list of the configured interceptors.
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	getInterceptors() Exposes the interceptor list for subclasses.
protected void	onInit() Subclasses may implement this for initialization logic.
boolean	send(Message<?> message) Send a message on this channel.
boolean	send(Message<?> message, long timeout) Send a message on this channel.
void	setConversionService(ConversionService conversionService) Deprecated. No longer used; see DefaultDatatypeChannelMessageConverter.
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	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	setShouldTrack(boolean shouldTrack)

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

afterPropertiesSet, getApplicationContextId, getBeanFactory, getComponentName, getConversionService, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setComponentName, setMessageBuilderFactory, 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

Constructor Detail

AbstractMessageChannel

public AbstractMessageChannel()

Method Detail

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

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 ChannelInterceptorAware

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 ChannelInterceptorAware

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 ChannelInterceptorAware

Parameters:

index - The index to add interceptor.

interceptor - The interceptor.

setConversionService

@Deprecated
public void setConversionService(ConversionService conversionService)

Deprecated. No longer used; see DefaultDatatypeChannelMessageConverter.

Specify the ConversionService to use when trying to convert to one of this channel's supported datatypes for a Message whose payload does not already match. If this property is not set explicitly but the channel is managed within a context, it will attempt to locate a bean named "integrationConversionService" defined within that context.

Overrides:

setConversionService in class IntegrationObjectSupport

Parameters:

conversionService - The conversion service.

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.

getChannelInterceptors

public List<ChannelInterceptor> getChannelInterceptors()

Return a read-only list of the configured interceptors.

Specified by:

getChannelInterceptors in interface ChannelInterceptorAware

getInterceptors

protected AbstractMessageChannel.ChannelInterceptorList getInterceptors()

Exposes the interceptor list for subclasses.

Returns:

The channel interceptor list.

onInit

protected void onInit()
               throws Exception

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class IntegrationObjectSupport

Throws:

Exception - Any exception.

getFullChannelName

public String getFullChannelName()

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

Returns:

The name.

send

public final 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 final boolean send(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 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(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.