Package com.opencloud.rhino.facilities.usage

Annotation Type UsageCounter

@Retention(RUNTIME)
@Target(METHOD)
@Documented
public @interface UsageCounter

Annotation that can be used to provide addition information about a usage counter to the SLEE.

Since:

Rhino 2.4.0

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
CounterType	counterType	The counter type.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	aggregate	Flag indicating whether or not updates to this counter will aggregate in the parent usage parameter set.
String	description	An arbitrary description about the counter.
int	mapping	The SNMP counter ID to use, appended to the usage parameter set’s base OID.
String	shortName	A shortened version of the counter name.
String	unitLabel	A label for the counter’s unit type.

Element Detail

counterType

CounterType counterType

The counter type.

Since:

Rhino 2.4.0

description

String description

An arbitrary description about the counter.

Since:

Rhino 2.4.0

Default:

""

aggregate

boolean aggregate

Flag indicating whether or not updates to this counter will aggregate in the parent usage parameter set. Aggregation can only occur if the parent usage parameter set is the same type as the child, or if the child’s parameter set type extends the parent’s parameter set type and the parent type defines the same counter.

Since:

Rhino 2.4.0

Default:

true

shortName

String shortName

A shortened version of the counter name.

Since:

Rhino 2.4.0

Default:

""

unitLabel

String unitLabel

A label for the counter’s unit type.

Since:

Rhino 2.4.0

Default:

""

mapping

int mapping

The SNMP counter ID to use, appended to the usage parameter set’s base OID.

Since:

Rhino 2.4.0

Default:

-1