com.axemble.vdoc.sdk.interfaces

Interface IMessageController

All Superinterfaces:

IController, Serializable

public interface IMessageController
extends IController

This class allows to play with messages on IMessageSupport objects.

Since:

1.0, 25/09/2009

Author:

vlygeros

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY Name of the session key.

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

Field Detail

KEY

static final String KEY

Name of the session key.

See Also:

Constant Field Values

Method Detail

registerRecipient

void registerRecipient(String recipientName)

Allows to register a recipient by its name.

Parameters:

recipientName - The system name of the recipient.

registerRecipient

Object registerRecipient(String recipientName,
                         Class recipientClass)

Allows to register a specific recipient by its class.

Parameters:

recipientName - The system name of the recipient.

recipientClass - The class of the recipient.

Returns:

An Object.

registerRecipientListener

Object registerRecipientListener(String recipientName,
                                 IRecipientListener recipientListener)

Allows to register a recipient by its name.

Parameters:

recipientName - The system name of the recipient.

recipientListener - The recipient listener to treat the IMessage.

Returns:

An Object.

unregisterRecipient

void unregisterRecipient(String recipientName)

Allows to unregister a recipient by its name.

Parameters:

recipientName - The system name of the recipient.

getRecipient

Object getRecipient(String recipientName)

Gets a recipient by its name.

Parameters:

recipientName - The system name of the recipient.

Returns:

An Object.

dispatchMessages

void dispatchMessages(Collection classExtensions)

Dispatches the messages.

Parameters:

classExtensions -

sendMessage

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

Builds and sends a message to a specific recipient.

Parameters:

recipientName - The system name of the recipient.

eventType - The event type of the message.

body - The body of the message.

registerAndSendMessage

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

Registers a recipient, builds and sends a message.

Parameters:

recipientName - The system name of the recipient.

eventType - The event type of the message.

body - The body of the message.

registerAndSendMessage

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

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

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.