com.clearlydecoded.messenger

Interface MessageProcessor<MessageT extends Message<MessageResponseT>,MessageResponseT extends MessageResponse>

All Known Implementing Classes:

AbstractMessageProcessor

public interface MessageProcessor<MessageT extends Message<MessageResponseT>,MessageResponseT extends MessageResponse>

MessageProcessor interface defines methods which allow its implementations to do the actual work of processing a concrete type of Message implementation and produce a response that is a concrete implementation of MessageResponse.

Clients of this framework should implement a concrete implementation of this interface for each distinct type of Message/MessageResponse pair.

Warning! Implementations of this interface must account for the fact that the execution of its code might happen in a multi-threaded environment. Do NOT assume that a new instance of this processor will be created for each thread. In other words, multiple threads might share the same instance of the processor.

Author:

Yaakov Chaikin (yaakov@ClearlyDecoded.com)

Method Summary

Modifier and Type	Method and Description
Class<MessageT>	getCompatibleMessageClassType() Retrieves class type of the message this processor is to able to process.
Class<MessageResponseT>	getCompatibleMessageResponseClassType() Retrieves class type of the message response this processor is set to return.
String	getCompatibleMessageType() Retrieves message type identifier that this processor is able to process.
MessageResponseT	process(MessageT message) Executes the message, producing message response of class type which is embedded in the type of message.

Method Detail

process

MessageResponseT process(MessageT message)

Executes the message, producing message response of class type which is embedded in the type of message.

Parameters:

message - Message object containing data which is needed for processing this message.

Returns:

Message response object that represents a processed response to the message.

getCompatibleMessageType

String getCompatibleMessageType()

Retrieves message type identifier that this processor is able to process.

The type identifier must be unique system-wide and be identical to the value returned by the Message.getType() method which is generically typed in the concrete implementation of this processor.

Returns:

Message type identifier that is unique system-wide and identical to the type identifier of the concrete Message this processor is typed with.

getCompatibleMessageClassType

Class<MessageT> getCompatibleMessageClassType()

Retrieves class type of the message this processor is to able to process.

Returns:

Class type of the message this processor is able to process.

getCompatibleMessageResponseClassType

Class<MessageResponseT> getCompatibleMessageResponseClassType()

Retrieves class type of the message response this processor is set to return.

Returns:

Class type of the message response this processor is set to return.