org.springframework.integration.channel

Class AbstractSubscribableChannel

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.channel.AbstractMessageChannel

org.springframework.integration.channel.AbstractSubscribableChannel

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, ChannelInterceptorAware, TrackableComponent, NamedComponent, MessageChannel, SubscribableChannel

Direct Known Subclasses:

DirectChannel, ExecutorChannel, PublishSubscribeChannel

public abstract class AbstractSubscribableChannel
extends AbstractMessageChannel
implements SubscribableChannel

Base implementation of MessageChannel that invokes the subscribed handler(s) by delegating to a MessageDispatcher.

Author:

Mark Fisher, Oleg Zhurakousky, Gary Russell

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.channel.AbstractMessageChannel

AbstractMessageChannel.ChannelInterceptorList

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

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	doSend(Message<?> message, long timeout) Subclasses must implement this method.
protected abstract MessageDispatcher	getDispatcher()
boolean	subscribe(MessageHandler handler)
boolean	unsubscribe(MessageHandler handle)

Methods inherited from class org.springframework.integration.channel.AbstractMessageChannel

addInterceptor, addInterceptor, getChannelInterceptors, getComponentType, getFullChannelName, getInterceptors, onInit, send, send, setConversionService, setDatatypes, setInterceptors, setMessageConverter, setShouldTrack

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

send, send

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

getComponentName

Constructor Detail

AbstractSubscribableChannel

public AbstractSubscribableChannel()

Method Detail

subscribe

public boolean subscribe(MessageHandler handler)

Specified by:

subscribe in interface SubscribableChannel

unsubscribe

public boolean unsubscribe(MessageHandler handle)

Specified by:

unsubscribe in interface SubscribableChannel

doSend

protected boolean doSend(Message<?> message,
             long timeout)

Description copied from class: AbstractMessageChannel

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.

Specified by:

doSend in class AbstractMessageChannel

Parameters:

message - The message.

timeout - The timeout.

Returns:

true if the send was successful.

getDispatcher

protected abstract MessageDispatcher getDispatcher()