Package com.opencloud.rhino.facilities.usage

Annotation Type UsageParameters

  • @Retention(RUNTIME)
@Target(TYPE)
@Documented
public @interface UsageParameters

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

    Since:
    Rhino 2.4.0

    • Element Detail

      • description

        String description

        An arbitrary description about the usage parameters interface.

        Since:
        Rhino 2.4.0
        Default:
        ""

      • oid

        @Deprecated(since="Rhino 3.1.0")
String oid
        Deprecated.
        use oidSuffix() for Rhino 3.1.0+ static SNMP OID declarations.

        The base SNMP OID to use for this usage parameters interface.

        This attribute is mutually exclusive with oidSuffix(). Only one may be given a non-empty value in a given annotation usage.

        Since:
        Rhino 2.4.0
        Default:
        ""

      • oidSuffix

        String oidSuffix

        The SNMP OID suffix to use for this usage parameters interface.

        This attribute is mutually exclusive with oid(). Only one may be given a non-empty value in a given annotation usage.

        Since:
        Rhino 3.1.0
        Default:
        ""

      • singleton

        UsageParameters.Singleton singleton

        Flag indicating if this usage parameters interface is a singleton type.

        A singleton usage parameters interface type can only have one usage parameter set created from it. For SLEE components that declare a usage parameters interface in the sbb-jar.xml deployment descriptor, ie. using the SLEE-defined method rather than the Rhino extension method, the singleton usage parameter set will be the default usage parameter set automatically created by the SLEE as described in the SLEE specification.

        Usage parameter sets created from a singleton usage parameters interface type have a slightly different SNMP OID structure than non-singleton types.

        The default value for this annotation is UsageParameters.Singleton.UNSPECIFIED. This allows the singleton status to be specified in the deployment descriptor instead of via this annotation if desired. If the singleton status is not specified either by annotation or deployment descriptor element then the usage parameters interface type is assumed to be non-singleton.

        Since:
        Rhino 3.1.0
        Default:
        com.opencloud.rhino.facilities.usage.UsageParameters.Singleton.UNSPECIFIED

      • usageParameterSetNameOIDMappings

        UsageParameterSetNameOIDMapping[] usageParameterSetNameOIDMappings

        An array of usage parameter set name to SNMP OID suffix mappings.

        These definitions allow the developer to specify terser OID table indexes for parameter sets with known names than would be otherwise be generated by Rhino from those names. Usage parameter sets with statically mapped names also have a different SNMP OID structure (non-tabular) than unmapped names (tabular).

        This attribute is only relevant if the usage parameter set type is not defined as a singleton.

        Since:
        Rhino 3.1.0
        Default:
        {}