net.engio.mbassy.bus

Class AbstractSyncMessageBus<T,P extends ISyncMessageBus.ISyncPostCommand>

java.lang.Object

net.engio.mbassy.bus.AbstractSyncMessageBus<T,P>

Type Parameters:

T -

P -

All Implemented Interfaces:

ISyncMessageBus<T,P>

Direct Known Subclasses:

AbstractSyncAsyncMessageBus

public abstract class AbstractSyncMessageBus<T,P extends ISyncMessageBus.ISyncPostCommand>
extends Object
implements ISyncMessageBus<T,P>

The base class for all message bus implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface net.engio.mbassy.bus.ISyncMessageBus

ISyncMessageBus.ISyncPostCommand

Constructor Summary

Constructors

Constructor and Description
AbstractSyncMessageBus(SyncBusConfiguration configuration)

Method Summary

Methods

Modifier and Type	Method and Description
void	addErrorHandler(IPublicationErrorHandler handler) Publication errors may occur at various points of time during message delivery.
protected MessagePublication.Factory	getPublicationFactory()
Collection<IPublicationErrorHandler>	getRegisteredErrorHandlers() Returns an immutable collection containing all the registered error handlers
protected Collection<Subscription>	getSubscriptionsByMessageType(Class messageType)
void	handlePublicationError(PublicationError error)
void	subscribe(Object listener) Subscribe all listeners of the given message to receive message publications.
boolean	unsubscribe(Object listener) Immediately remove all registered message handlers (if any) of the given listener.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.engio.mbassy.bus.ISyncMessageBus

post

Constructor Detail

AbstractSyncMessageBus

public AbstractSyncMessageBus(SyncBusConfiguration configuration)

Method Detail

getPublicationFactory

protected MessagePublication.Factory getPublicationFactory()

getRegisteredErrorHandlers

public Collection<IPublicationErrorHandler> getRegisteredErrorHandlers()

Description copied from interface: ISyncMessageBus

Returns an immutable collection containing all the registered error handlers

Specified by:

getRegisteredErrorHandlers in interface ISyncMessageBus<T,P extends ISyncMessageBus.ISyncPostCommand>

Returns:

unsubscribe

public boolean unsubscribe(Object listener)

Description copied from interface: ISyncMessageBus

Immediately remove all registered message handlers (if any) of the given listener. When this call returns all handlers have effectively been removed and will not receive any message publications (including asynchronously scheduled publications that have been published when the message listener was still subscribed).

A call to this method passing null, an already unsubscribed listener or any object that does not define any message handlers will not have any effect and is silently ignored.

Specified by:

unsubscribe in interface ISyncMessageBus<T,P extends ISyncMessageBus.ISyncPostCommand>

Returns:

true, if the listener was found and successfully removed false otherwise

subscribe

public void subscribe(Object listener)

Description copied from interface: ISyncMessageBus

Subscribe all listeners of the given message to receive message publications. Any message may only be subscribed once (subsequent subscriptions of an already subscribed message will be silently ignored)

Specified by:

subscribe in interface ISyncMessageBus<T,P extends ISyncMessageBus.ISyncPostCommand>

addErrorHandler

public final void addErrorHandler(IPublicationErrorHandler handler)

Description copied from interface: ISyncMessageBus

Publication errors may occur at various points of time during message delivery. A handler may throw an exception, may not be accessible due to security constraints or is not annotated properly. In any of all possible cases a publication error is created and passed to each of the registered error handlers. A call to this method will add the given error handler to the chain

Specified by:

addErrorHandler in interface ISyncMessageBus<T,P extends ISyncMessageBus.ISyncPostCommand>

getSubscriptionsByMessageType

protected Collection<Subscription> getSubscriptionsByMessageType(Class messageType)

handlePublicationError

public void handlePublicationError(PublicationError error)