Package com.scaleoutsoftware.modules.abstractions

Class ApiProcessor<O>

java.lang.Object

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

Type Parameters:

O - the SOSS object type.

public abstract class ApiProcessor<O>
extends Object

The ApiProcessor is responsible for handling incoming API requests from clients for the retrieved object.

Constructor Summary

Constructors

Constructor	Description
ApiProcessor()	Instantiate a new ApiProcessor.

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 and the SossApiMethod's ObjNotFoundBehavior is set to ObjNotFoundBehavior.Create.
abstract NewObjectPolicy	getNewObjectPolicy(String moduleName, String id, O object)	Generate a NewObjectPolicy that defines the ExpirationType and expiration timeout.

Methods inherited from class java.lang.Object

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

Constructor Details

ApiProcessor

public ApiProcessor()

Instantiate a new ApiProcessor.

Method Details

createObject

public abstract O createObject(String moduleName,
 String id)

Create an object for a received messaged for an object that did not exist and the SossApiMethod's ObjNotFoundBehavior is set to ObjNotFoundBehavior.Create.

Parameters:

moduleName - the name of the module.

id - the SOSS object id.

Returns:

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