org.sodeac.common.message.dispatcher.api

Interface IMessageDispatcher

All Known Implementing Classes:

MessageDispatcherImpl

public interface IMessageDispatcher

API for message dispatcher

Author:

Sebastian Palarus

Method Summary

Modifier and Type	Method and Description
IPropertyBlock	createPropertyBlock() factory-methode creating instance of IPropertyBlock
void	dispose() Remove all workers and clean resources.
IChannel<?>	getChannel(String channelId) getter to request for IChannel with given id
List<String>	getChannelIdList() request for all IChannel-IDs
String	getId() getter for id of dispatcher.
IPropertyBlock	getPropertyBlock() getter for propertyblock of dispatcher
<T> IChannel<T>	getTypedChannel(String channelId, Class<T> messageType)
void	registerChannelManager(IChannelManager queueController)
void	registerChannelService(IChannelService queueService)
<T> void	sendMessage(String channelId, T message) queue a message to addressed queue
void	unregisterChannelManager(IChannelManager eventController)
void	unregisterChannelService(IChannelService queueService)

Method Detail

sendMessage

<T> void sendMessage(String channelId,
                     T message)
              throws ChannelNotFoundException,
                     ChannelIsFullException

queue a message to addressed queue

Parameters:

channelId - id of IChannel

message - message to queue

Throws:

ChannelNotFoundException

ChannelIsFullException

createPropertyBlock

IPropertyBlock createPropertyBlock()

factory-methode creating instance of IPropertyBlock

Returns:

instance of IPropertyBlock

getChannelIdList

List<String> getChannelIdList()

request for all IChannel-IDs

Returns:

List with queueIds

getChannel

IChannel<?> getChannel(String channelId)

getter to request for IChannel with given id

Parameters:

channelId - id for queue

Returns:

instance of IChannel registered with queueId

getTypedChannel

<T> IChannel<T> getTypedChannel(String channelId,
                                Class<T> messageType)

getPropertyBlock

IPropertyBlock getPropertyBlock()

getter for propertyblock of dispatcher

Returns:

IPropertyBlock of dispatcher

getId

String getId()

getter for id of dispatcher.

Returns:

id of dispatcher

dispose

void dispose()

Remove all workers and clean resources. After disposing the dispatcher is not usable anymore.

registerChannelManager

void registerChannelManager(IChannelManager queueController)

registerChannelService

void registerChannelService(IChannelService queueService)

unregisterChannelManager

void unregisterChannelManager(IChannelManager eventController)

unregisterChannelService

void unregisterChannelService(IChannelService queueService)