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

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.
CounterType	counterType	The counter type.
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.
UsageCounter.Visibility	visibility	The SNMP visibility of the usage counter.

Element Detail

description

String description

An arbitrary description about the counter.

Since:

Rhino 2.4.0

Default:

""

counterType

CounterType counterType

The counter type.

Since:

Rhino 2.4.0

Default:

com.opencloud.rhino.facilities.usage.CounterType.COUNTER

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

visibility

UsageCounter.Visibility visibility

The SNMP visibility of the usage counter. A public counter will be registered with SNMP using the defined OID suffix mapping. A private counter will not be registered with SNMP, but will still be visible to management clients using the Rhino Statistics API.

Since:

Rhino 3.1.0

Default:

com.opencloud.rhino.facilities.usage.UsageCounter.Visibility.PUBLIC