com.axemble.vdoc.sdk.messages

Class MessageController

java.lang.Object

com.axemble.vdoc.sdk.messages.MessageController

All Implemented Interfaces:

IController, IMessageController, Serializable

public class MessageController
extends Object
implements IMessageController

Author:

vlygeros

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.axemble.vdoc.sdk.interfaces.IMessageController

KEY

Constructor Summary

Constructors

Constructor and Description
MessageController()

Method Summary

Modifier and Type	Method and Description
void	dispatchMessages(Collection classExtensions) Dispatches the messages.
Object	getRecipient(String recipientName) Gets a recipient by its name.
Map	getRecipients()
Object	registerAndSendMessage(String recipientName, Class recipientClass, int eventType, Object body) Registers a specific recipient by passing its class, builds and sends a message.
void	registerAndSendMessage(String recipientName, int eventType, Object body) Registers a recipient, builds and sends a message.
void	registerRecipient(String recipientName) Allows to register a recipient by its name.
Object	registerRecipient(String recipientName, Class recipientClass) Allows to register a specific recipient by its class.
Object	registerRecipientListener(String recipientName, IRecipientListener recipientListener) Allows to register a recipient by its name.
void	sendMessage(String recipientName, int eventType, Object body) Builds and sends a message to a specific recipient.
void	unregisterRecipient(String recipientName) Allows to unregister a recipient by its name.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageController

public MessageController()

Method Detail

registerRecipient

public void registerRecipient(String recipientName)

Description copied from interface: IMessageController

Allows to register a recipient by its name.

Specified by:

registerRecipient in interface IMessageController

Parameters:

recipientName - The system name of the recipient.

registerRecipient

public Object registerRecipient(String recipientName,
                                Class recipientClass)

Description copied from interface: IMessageController

Allows to register a specific recipient by its class.

Specified by:

registerRecipient in interface IMessageController

Parameters:

recipientName - The system name of the recipient.

recipientClass - The class of the recipient.

Returns:

An Object.

registerRecipientListener

public Object registerRecipientListener(String recipientName,
                                        IRecipientListener recipientListener)

Description copied from interface: IMessageController

Allows to register a recipient by its name.

Specified by:

registerRecipientListener in interface IMessageController

Parameters:

recipientName - The system name of the recipient.

recipientListener - The recipient listener to treat the IMessage.

Returns:

An Object.

unregisterRecipient

public void unregisterRecipient(String recipientName)

Description copied from interface: IMessageController

Allows to unregister a recipient by its name.

Specified by:

unregisterRecipient in interface IMessageController

Parameters:

recipientName - The system name of the recipient.

getRecipient

public Object getRecipient(String recipientName)

Description copied from interface: IMessageController

Gets a recipient by its name.

Specified by:

getRecipient in interface IMessageController

Parameters:

recipientName - The system name of the recipient.

Returns:

An Object.

dispatchMessages

public void dispatchMessages(Collection classExtensions)

Description copied from interface: IMessageController

Dispatches the messages.

Specified by:

dispatchMessages in interface IMessageController

sendMessage

public void sendMessage(String recipientName,
                        int eventType,
                        Object body)

Description copied from interface: IMessageController

Builds and sends a message to a specific recipient.

Specified by:

sendMessage in interface IMessageController

Parameters:

recipientName - The system name of the recipient.

eventType - The event type of the message.

body - The body of the message.

getRecipients

public final Map getRecipients()

Returns:

the recipients

registerAndSendMessage

public void registerAndSendMessage(String recipientName,
                                   int eventType,
                                   Object body)

Description copied from interface: IMessageController

Registers a recipient, builds and sends a message.

Specified by:

registerAndSendMessage in interface IMessageController

Parameters:

recipientName - The system name of the recipient.

eventType - The event type of the message.

body - The body of the message.

registerAndSendMessage

public Object registerAndSendMessage(String recipientName,
                                     Class recipientClass,
                                     int eventType,
                                     Object body)

Description copied from interface: IMessageController

Registers a specific recipient by passing its class, builds and sends a message.

Specified by:

registerAndSendMessage in interface IMessageController

Parameters:

recipientName - The system name of the recipient.

recipientClass - The recipient class.

eventType - The event type of the message.

body - The body of the message.

Returns:

An Object.