Package com.scaleoutsoftware.modules.abstractions

Annotation Interface SossApiMethod

@Retention(RUNTIME)
public @interface SossApiMethod

Annotate a method with SossApiMethod to define an ApiModule's invokable method.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
ApiProcessorLockingMode	lockingMode	Set whether this API method should use locking when reading/writing SOSS objects.
String	operationId	The name of the SossApiMethod to invoke.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
ObjNotFoundBehavior	objNotFoundBehavior	Set the object not found behavior when this API method is called and the object is missing.

Element Details

operationId

String operationId

The name of the SossApiMethod to invoke.

Returns:

the name of the SossApiMethod.

lockingMode

ApiProcessorLockingMode lockingMode

Set whether this API method should use locking when reading/writing SOSS objects.

Returns:

ApiProcessorLockingMode.ExclusiveLock if the API method should use locking, ApiProcessorLockingMode.None otherwise.

objNotFoundBehavior

ObjNotFoundBehavior objNotFoundBehavior

Set the object not found behavior when this API method is called and the object is missing. Default: ObjNotFoundBehavior.DoNotCreate.

Returns:

ObjNotFoundBehavior.Create to create the object (or read-through to a persistence provider) or ObjNotFoundBehavior.DoNotCreate to not create the object (or perform read-through to a persistence provider) when the object is not found.

Default:

DoNotCreate