Package org.certificateservices.messages.csmessages.manager

Interface MessageListener

All Superinterfaces:

MessageComponent

public interface MessageListener
extends MessageComponent

Interface of a message listener implementation.

Method Summary

Modifier and Type	Method	Description
java.util.Set<java.lang.String>	getCallbackAliases()
void	registerCallback(java.lang.String alias, MessageResponseCallback messageResponseCallback)	Used to add a messageResponse Callback to a message lister.
void	responseReceived(byte[] responseMessage, java.util.Map<java.lang.String,java.lang.String> messageAttributes)	Method signaling that a response was received.
void	unregisterCallback(java.lang.String alias)	Method to unregister a callback from a message listener.

Methods inherited from interface org.certificateservices.messages.csmessages.manager.MessageComponent

getName

Method Detail

registerCallback

void registerCallback(java.lang.String alias,
                      MessageResponseCallback messageResponseCallback)

Used to add a messageResponse Callback to a message lister.

Parameters:

alias - of the response callback. Should be unique within the message listener.

messageResponseCallback - the callback to register.

messageResponseCallback -

getCallbackAliases

java.util.Set<java.lang.String> getCallbackAliases()

Returns:

a list of registered aliases of response callbacks.

unregisterCallback

void unregisterCallback(java.lang.String alias)

Method to unregister a callback from a message listener.

Parameters:

alias - of the response callback. Should be unique within the message listener.

responseReceived

void responseReceived(byte[] responseMessage,
                      java.util.Map<java.lang.String,java.lang.String> messageAttributes)
               throws java.io.IOException,
                      MessageProcessingException,
                      MessageContentException

Method signaling that a response was received.

Parameters:

responseMessage - the response message that was received.

messageAttributes - meta data related to the message such as reply-to queues or correlation id etc if underlying implementation supports it.

Throws:

java.io.IOException - if communication problems occurred when communicating with underlying system.

MessageProcessingException - if internal problems occurred sending the message.

MessageContentException - if message content invalid.