Top Description Fields Constructors Methods
org.springframework.messaging.support

public abstract Class AbstractSubscribableChannel

extends AbstractMessageChannel
implements SubscribableChannel
Class Inheritance
All Implemented Interfaces
org.springframework.messaging.SubscribableChannel, org.springframework.messaging.MessageChannel
Known Direct Subclasses
org.springframework.messaging.support.ExecutorSubscribableChannel
Imports
java.util.Collections, .Set, java.util.concurrent.CopyOnWriteArraySet, org.springframework.messaging.MessageHandler, .SubscribableChannel
Abstract base class for SubscribableChannel implementations.
Author
Rossen Stoyanchev
Since
4.0

Field Summary

Modifier and TypeField and Description
private final Set<MessageHandler>
handlers

Inherited from org.springframework.messaging.support.AbstractMessageChannel:
logger

Constructor Summary

AccessConstructor and Description
public
AbstractSubscribableChannel()

Method Summary

Modifier and TypeMethod and Description
public Set<MessageHandler>
getSubscribers()

public boolean
hasSubscription(MessageHandler handler)

public boolean
subscribe(MessageHandler handler)

Implements org.springframework.messaging.SubscribableChannel.subscribe.

Register a message handler.
public boolean
unsubscribe(MessageHandler handler)

Implements org.springframework.messaging.SubscribableChannel.unsubscribe.

Un-register a message handler.
Inherited from org.springframework.messaging.support.AbstractMessageChannel:
addInterceptoraddInterceptorgetBeanNamegetInterceptorsgetLoggerremoveInterceptorremoveInterceptorsendsendsendInternalsetBeanNamesetInterceptorssetLoggertoString

Field Detail

handlersback to summary
private final Set<MessageHandler> handlers

Constructor Detail

AbstractSubscribableChannelback to summary
public AbstractSubscribableChannel()

Method Detail

getSubscribersback to summary
public Set<MessageHandler> getSubscribers()
hasSubscriptionback to summary
public boolean hasSubscription(MessageHandler handler)
subscribeback to summary
public boolean subscribe(MessageHandler handler)

Implements org.springframework.messaging.SubscribableChannel.subscribe.

Doc from org.springframework.messaging.SubscribableChannel.subscribe.

Register a message handler.

Returns:boolean

true if the handler was subscribed or false if it was already subscribed.

Annotations
@Override
unsubscribeback to summary
public boolean unsubscribe(MessageHandler handler)

Implements org.springframework.messaging.SubscribableChannel.unsubscribe.

Doc from org.springframework.messaging.SubscribableChannel.unsubscribe.

Un-register a message handler.

Returns:boolean

true if the handler was un-registered, or false if was not registered.

Annotations
@Override