Package org.somda.sdc.glue.provider.sco

Annotation Type IncomingSetServiceRequest

@Target(METHOD)
@Retention(RUNTIME)
public @interface IncomingSetServiceRequest

Annotation to define a callback for incoming set service operation calls.

The receiving method needs to be parameterized with the following arguments:

1. Context instance
2. requested data type

Requested data types can be:

• String for a SetString request
• BigDecimal for a SetValue request
• List of Object depending on the argument types for an Activate request
• An instance derived from AbstractMetricState for a SetMetricState request
• An instance derived from AbstractAlertState for a SetAlertState request
• An instance derived from AbstractDeviceComponentState for a SetComponentState request
• An instance derived from AbstractContextState for a SetContextState request

The result of the operation is required to be of the type InvocationResponse, which can be created by using Context.createSuccessfulResponse(MdibVersion, InvocationState) or Context.createUnsuccessfulResponse(MdibVersion, InvocationState, InvocationError, List).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IncomingSetServiceRequest.NoList	Indicates a no-list type.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Class<?>	listType	Defines the data type of a list container that is required due to type erasure.
String	operationHandle	Defines the operation handle that triggers the method.

Element Details

operationHandle

String operationHandle

Defines the operation handle that triggers the method.

The annotated method is called only if the handle of the operation matches this value. Leave the value empty to match every handle.

Returns:

the handle to match for this incoming operation call annotation.

Default:

""

listType

Class<?> listType

Defines the data type of a list container that is required due to type erasure.

If the operation payload comes as a list of proposed data items, this type defines the list type that is used to distinguish between different functions that accept lists (required as Java lacks real templates).

Returns:

the generic type of the list element. Defaults to IncomingSetServiceRequest.NoList, which indicates no list type.

Default:

org.somda.sdc.glue.provider.sco.IncomingSetServiceRequest.NoList.class