OSGi™ Enterprise
Release 5

org.osgi.jmx
Class JmxConstants

java.lang.Object
  extended by org.osgi.jmx.JmxConstants

public class JmxConstants
extends java.lang.Object

Constants for OSGi JMX Specification. Additionally, this class contains a number of utility types that are used in different places in the specification. These are LONG_ARRAY_TYPE, STRING_ARRAY_TYPE, and PROPERTIES_TYPE.

Immutable

Field Summary
static java.lang.String ARRAY_OF
          For an encoded array we need to start with ARRAY_OF.
static java.lang.String BIGDECIMAL
          Value for PROPERTY_TYPE value in the case of BigDecimal
static java.lang.String BIGINTEGER
          Value for PROPERTY_TYPE value in the case of BigInteger
static java.lang.String BOOLEAN
          Value for PROPERTY_TYPE value in the case of Boolean
static java.lang.String BYTE
          Value for PROPERTY_TYPE value in the case of Byte
static java.lang.String CHARACTER
          Value for PROPERTY_TYPE value in the case of Character
static java.lang.String DOUBLE
          Value for PROPERTY_TYPE value in the case of Double
static java.lang.String FLOAT
          Value for PROPERTY_TYPE value in the case of Float
static java.lang.String INTEGER
          Value for PROPERTY_TYPE value in the case of Integer
static java.lang.String KEY
          The key KEY.
static Item KEY_ITEM
          The key of a property.
static java.lang.String LONG
          Value for PROPERTY_TYPE value in the case of Long
static javax.management.openmbean.ArrayType LONG_ARRAY_TYPE
          The MBean Open type for an array of longs
static java.lang.String OSGI_COMPENDIUM
          The domain name of the selected OSGi compendium MBeans
static java.lang.String OSGI_CORE
          The domain name of the core OSGi MBeans
static java.lang.String P_BOOLEAN
          Value for PROPERTY_TYPE value in the case of the boolean primitive type.
static java.lang.String P_BYTE
          Value for PROPERTY_TYPE value in the case of the byte primitive type.
static java.lang.String P_CHAR
          Value for PROPERTY_TYPE value in the case of the char primitive type.
static java.lang.String P_DOUBLE
          Value for PROPERTY_TYPE value in the case of the double primitive type.
static java.lang.String P_FLOAT
          Value for PROPERTY_TYPE value in the case of the float primitive type.
static java.lang.String P_INT
          Value for PROPERTY_TYPE value in the case of the int primitive type.
static java.lang.String P_LONG
          Value for PROPERTY_TYPE value in the case of the long primitive type.
static java.lang.String P_SHORT
          Value for PROPERTY_TYPE value in the case of the short primitive type.
static javax.management.openmbean.TabularType PROPERTIES_TYPE
          Describes a map with properties.
static javax.management.openmbean.CompositeType PROPERTY_TYPE
          A Composite Type describing a a single property.
static java.util.List<java.lang.String> SCALAR
          A set of all scalars that can be used in the TYPE property of a PROPERTIES_TYPE.
static java.lang.String SHORT
          Value for PROPERTY_TYPE value in the case of Short
static java.lang.String STRING
          Value for PROPERTY_TYPE value in the case of String
static javax.management.openmbean.ArrayType STRING_ARRAY_TYPE
          The MBean Open type for an array of strings
static java.lang.String TYPE
          The key TYPE.
static Item TYPE_ITEM
          The type of the property.
static java.lang.String VALUE
          The key VALUE.
static Item VALUE_ITEM
          The value of a property.
static java.lang.String VECTOR_OF
          For an encoded vector we need to start with ARRAY_OF.
static java.lang.String VERSION
          Value for PROPERTY_TYPE value in the case of Version
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STRING_ARRAY_TYPE

public static final javax.management.openmbean.ArrayType STRING_ARRAY_TYPE
The MBean Open type for an array of strings


LONG_ARRAY_TYPE

public static final javax.management.openmbean.ArrayType LONG_ARRAY_TYPE
The MBean Open type for an array of longs


ARRAY_OF

public static final java.lang.String ARRAY_OF
For an encoded array we need to start with ARRAY_OF. This must be followed by one of the names in SCALAR.

See Also:
Constant Field Values

VECTOR_OF

public static final java.lang.String VECTOR_OF
For an encoded vector we need to start with ARRAY_OF. This must be followed by one of the names in SCALAR.

See Also:
Constant Field Values

STRING

public static final java.lang.String STRING
Value for PROPERTY_TYPE value in the case of String

See Also:
Constant Field Values

INTEGER

public static final java.lang.String INTEGER
Value for PROPERTY_TYPE value in the case of Integer

See Also:
Constant Field Values

LONG

public static final java.lang.String LONG
Value for PROPERTY_TYPE value in the case of Long

See Also:
Constant Field Values

FLOAT

public static final java.lang.String FLOAT
Value for PROPERTY_TYPE value in the case of Float

See Also:
Constant Field Values

DOUBLE

public static final java.lang.String DOUBLE
Value for PROPERTY_TYPE value in the case of Double

See Also:
Constant Field Values

BYTE

public static final java.lang.String BYTE
Value for PROPERTY_TYPE value in the case of Byte

See Also:
Constant Field Values

SHORT

public static final java.lang.String SHORT
Value for PROPERTY_TYPE value in the case of Short

See Also:
Constant Field Values

CHARACTER

public static final java.lang.String CHARACTER
Value for PROPERTY_TYPE value in the case of Character

See Also:
Constant Field Values

BOOLEAN

public static final java.lang.String BOOLEAN
Value for PROPERTY_TYPE value in the case of Boolean

See Also:
Constant Field Values

BIGDECIMAL

public static final java.lang.String BIGDECIMAL
Value for PROPERTY_TYPE value in the case of BigDecimal

See Also:
Constant Field Values

BIGINTEGER

public static final java.lang.String BIGINTEGER
Value for PROPERTY_TYPE value in the case of BigInteger

See Also:
Constant Field Values

VERSION

public static final java.lang.String VERSION
Value for PROPERTY_TYPE value in the case of Version

Since:
1.1
See Also:
Constant Field Values

P_DOUBLE

public static final java.lang.String P_DOUBLE
Value for PROPERTY_TYPE value in the case of the double primitive type.

See Also:
Constant Field Values

P_FLOAT

public static final java.lang.String P_FLOAT
Value for PROPERTY_TYPE value in the case of the float primitive type.

See Also:
Constant Field Values

P_LONG

public static final java.lang.String P_LONG
Value for PROPERTY_TYPE value in the case of the long primitive type.

See Also:
Constant Field Values

P_INT

public static final java.lang.String P_INT
Value for PROPERTY_TYPE value in the case of the int primitive type.

See Also:
Constant Field Values

P_SHORT

public static final java.lang.String P_SHORT
Value for PROPERTY_TYPE value in the case of the short primitive type.

See Also:
Constant Field Values

P_BYTE

public static final java.lang.String P_BYTE
Value for PROPERTY_TYPE value in the case of the byte primitive type.

See Also:
Constant Field Values

P_CHAR

public static final java.lang.String P_CHAR
Value for PROPERTY_TYPE value in the case of the char primitive type.

See Also:
Constant Field Values

P_BOOLEAN

public static final java.lang.String P_BOOLEAN
Value for PROPERTY_TYPE value in the case of the boolean primitive type.

See Also:
Constant Field Values

SCALAR

public static final java.util.List<java.lang.String> SCALAR
A set of all scalars that can be used in the TYPE property of a PROPERTIES_TYPE. This contains the following names:

KEY

public static final java.lang.String KEY
The key KEY.

See Also:
Constant Field Values

KEY_ITEM

public static final Item KEY_ITEM
The key of a property. The key is KEY and the type is SimpleType.STRING.


VALUE

public static final java.lang.String VALUE
The key VALUE.

See Also:
Constant Field Values

VALUE_ITEM

public static final Item VALUE_ITEM
The value of a property. The key is VALUE and the type is SimpleType.STRING. A value will be encoded by the string given in TYPE. The syntax for this type is given in TYPE_ITEM.


TYPE

public static final java.lang.String TYPE
The key TYPE.

See Also:
Constant Field Values

TYPE_ITEM

public static final Item TYPE_ITEM
The type of the property. The key is TYPE and the type is SimpleType.STRING. This string must follow the following syntax:

 type      ::= scalar | vector | array
 vector    ::= 'Vector of' scalar
 array     ::= 'Array of' (scalar | primitive)
 scalar    ::= 'String' | 'BigInteger' | 'BigDecimal'
              | 'Byte' | 'Character' | 'Short'
              | 'Integer' | 'Long' | 'Float'
              | 'Double' | 'Version'
 primitive ::= 'byte' | 'char' | 'short'
              | 'int' | 'long' | 'float'
              | 'double'
 
This encoding does not support arrays in vectors or arrays. Arrays and vectors can only contain scalars. List properties are encoded as arrays. Empty lists, arrays or vectors are not represented. Null is not an allowed value.

For example, the encoding of a byte array byte[] {1,2,3,5,7} would look like:

   type:  'Array of byte'
   value: 1,2,3,5,7
 
Quoting can be used as follows:
   type:  'Array of String'
   value: 'abc', 'def', '\'quoted\'', "'quoted'", "\\"
 


PROPERTY_TYPE

public static final javax.management.openmbean.CompositeType PROPERTY_TYPE
A Composite Type describing a a single property. A property consists of the following items KEY_ITEM, VALUE_ITEM, and TYPE_ITEM.


PROPERTIES_TYPE

public static final javax.management.openmbean.TabularType PROPERTIES_TYPE
Describes a map with properties. The row type is PROPERTY_TYPE. The index is defined to the KEY of the property.


OSGI_CORE

public static final java.lang.String OSGI_CORE
The domain name of the core OSGi MBeans

See Also:
Constant Field Values

OSGI_COMPENDIUM

public static final java.lang.String OSGI_COMPENDIUM
The domain name of the selected OSGi compendium MBeans

See Also:
Constant Field Values

OSGi™ Enterprise
Release 5

Copyright © OSGi Alliance (2000, 2012). All Rights Reserved. Licensed under the OSGi Specification License, Version 2.0