Package com.scaleoutsoftware.modules.abstractions

package com.scaleoutsoftware.modules.abstractions

Abstractions for API and MSG modules deployed on a ScaleOut in-memory data grid.

Class	Description
AlertSeverity	Severity of a UI alert generated by MsgProcessingContext
ApiProcessingContext<O>	The api processing context provides access to contextual information during invocation processing.
ApiProcessor<O>	The ApiProcessor is responsible for handling incoming API requests from clients for the retrieved object.
ApiProcessorLockingMode	Details the API processor's locking mode when retrieving and updating a SOSS object.
EvalResult<R>	The result of ReduceApiProcessor.evaluate(ApiProcessingContext, Object, Object, byte[]) or ForEachApiProcessor.evaluate(ApiProcessingContext, Object, byte[]).
ExpirationType	Details a cached objects expiration type
ForEachApiProcessor<O>	A parallel operation that does not return a result.
InvokeResult	The invoke result is the return value for a method annotated with SossApiMethod.
MessageProcessor<O>	The MessageProcessor is responsible for processing messages and creating objects for sent messages to module objects that do not yet exist.
ModuleAiMetadata	Annotate a DigitalTwin module's MessageProccessor with the ModuleAiMetadata annotation to describe a module for AI agents.
MsgProcessingContext<O>	The msg processing context provides access to contextual information during message processing.
NewObjectPolicy	A new object policy is used to define a SOSS object's expiration type and expiration timeout.
ObjNotFoundBehavior	Details an API module's behavior when an endpoint is invoked and the object is not found.
PersistenceProvider<V>	PersistenceProvider base class is used to provide external access to a persistent data store.
ProcessingResult	The result of a call to MessageProcessor.processMessage(MsgProcessingContext, Object, byte[]).
PropertyAiMetadata	Annotate a DigitalTwinBase class implementation's properties with PropertyAiMetadata to provide additional context about a DigitalTwin instance for AI Agents.
ReduceApiProcessor<O,R>	A parallel operation that returns a result.
SossApiMethod	Annotate a method with SossApiMethod to define an ApiModule's invokable method.
SossEvalMethod	Annotate a ReduceApiProcessor.evaluate(ApiProcessingContext, Object, Object, byte[]) or ForEachApiProcessor.evaluate(ApiProcessingContext, Object, byte[]) method with SossApiMethod to define the locking behavior of an ApiModule's evaluate method.