Package com.scaleoutsoftware.modules.abstractions

Class MessageProcessor<O>

java.lang.Object

com.scaleoutsoftware.modules.abstractions.MessageProcessor<O>

Type Parameters:

O - the SOSS object type.

public abstract class MessageProcessor<O>
extends Object

The MessageProcessor is responsible for processing messages and creating objects for sent messages to module objects that do not yet exist.

Constructor Summary

Constructors

Constructor	Description
MessageProcessor()	Instantiate a new MessageProcessor.

Method Summary

Modifier and Type	Method	Description
abstract O	createObject(String moduleName, String id)	Create an object for a received messaged for an object that did not exist.
abstract NewObjectPolicy	getNewObjectPolicy(String moduleName, String id, O object)	Generate a NewObjectPolicy that defines the ExpirationType and expiration timeout.
abstract ProcessingResult	processMessage(MsgProcessingContext<O> msgProcessingContext, O sossObject, byte[] message)	Process a message for a SOSS object.

Methods inherited from class java.lang.Object

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

Constructor Details

MessageProcessor

public MessageProcessor()

Instantiate a new MessageProcessor.

Method Details

processMessage

public abstract ProcessingResult processMessage(MsgProcessingContext<O> msgProcessingContext,
 O sossObject,
 byte[] message)

Process a message for a SOSS object.

Parameters:

msgProcessingContext - the MsgProcessingContext.

sossObject - the SOSS object.

message - the serialized message.

Returns:

a ProcessingResult. ProcessingResult.Remove to remove the object, ProcessingResult.DoUpdate to update the object, and ProcessingResult.NoUpdate to indicate that the object was not changed.

createObject

public abstract O createObject(String moduleName,
 String id)

Create an object for a received messaged for an object that did not exist.

Parameters:

moduleName - the name of the module.

id - the SOSS object id.

Returns:

the newly created object.

getNewObjectPolicy

public abstract NewObjectPolicy getNewObjectPolicy(String moduleName,
 String id,
 O object)

Generate a NewObjectPolicy that defines the ExpirationType and expiration timeout. Use Duration.ZERO for an infinite timeout.

Parameters:

moduleName - the module name.

id - the object id.

object - the new object.

Returns:

the NewObjectPolicy.