com.sun.management.snmp
Class EnumRowStatus

java.lang.Object
  com.sun.jdmk.Enumerated
      com.sun.management.snmp.EnumRowStatus

All Implemented Interfaces:

Serializable

public class EnumRowStatus
extends Enumerated
implements Serializable

This class is an internal class which is used to represent RowStatus codes as defined in RFC 2579. It defines an additional code, unspecified, which is implementation specific, and is used to identify unspecified actions (when for instance the RowStatus variable is not present in the varbind list) or uninitialized values. mibgen does not generate objects of this class but any variable using the RowStatus textual convention can be converted into an object of this class thanks to the EnumRowStatus(Enumerated valueIndex) constructor.

Since:

Java DMK 5.1

See Also:

Serialized Form

Field Summary

static int	active This value corresponds to the active RowStatus, as defined in RFC 2579 from SMIv2: active indicates that the conceptual row is available for use by the managed device;
static int	createAndGo This value corresponds to the createAndGo RowStatus, as defined in RFC 2579 from SMIv2: createAndGo is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device;
static int	createAndWait This value corresponds to the createAndWait RowStatus, as defined in RFC 2579 from SMIv2: createAndWait is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device);
static int	destroy This value corresponds to the destroy RowStatus, as defined in RFC 2579 from SMIv2: destroy is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row.
static int	notInService This value corresponds to the notInService RowStatus, as defined in RFC 2579 from SMIv2: notInService indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device; notInService has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device;
static int	notReady This value corresponds to the notReady RowStatus, as defined in RFC 2579 from SMIv2: notReady indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instantiated);
static int	unspecified This value is Java DMK implementation specific, and is used to identify unspecified actions (when for instance the RowStatus variable is not present in the varbind list) or uninitialized values.

Fields inherited from class com.sun.jdmk.Enumerated

value

Constructor Summary

EnumRowStatus()
Build an EnumRowStatus with unspecified value.

EnumRowStatus(Enumerated valueIndex)
Build an EnumRowStatus from an Enumerated.

EnumRowStatus(int valueIndex)
Build an EnumRowStatus from an int.

EnumRowStatus(Integer valueIndex)
Build an EnumRowStatus from an Integer.

EnumRowStatus(long valueIndex)
Build an EnumRowStatus from a long.

EnumRowStatus(Long valueIndex)
Build an EnumRowStatus from a Long.

EnumRowStatus(SnmpInt valueIndex)
Build an EnumRowStatus from an SnmpInt.

EnumRowStatus(String x)
Build an EnumRowStatus from a String.

Method Summary

protected Hashtable	getIntTable() Returns the hashtable of the integer forms.
protected Hashtable	getStringTable() Returns the hashtable of the string forms.
static boolean	isValidValue(int value) Check that the given value is valid.
SnmpInt	toSnmpValue() Build an SnmpValue from this object.

Methods inherited from class com.sun.jdmk.Enumerated

equals, hashCode, intValue, toString, valueIndexes, valueStrings

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

unspecified

public static final int unspecified

This value is Java DMK implementation specific, and is used to identify unspecified actions (when for instance the RowStatus variable is not present in the varbind list) or uninitialized values.

See Also:

Constant Field Values

active

public static final int active

This value corresponds to the active RowStatus, as defined in RFC 2579 from SMIv2:

active indicates that the conceptual row is available for use by the managed device;

See Also:

Constant Field Values

notInService

public static final int notInService

This value corresponds to the notInService RowStatus, as defined in RFC 2579 from SMIv2:

notInService indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device; notInService has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device;

See Also:

Constant Field Values

notReady

public static final int notReady

This value corresponds to the notReady RowStatus, as defined in RFC 2579 from SMIv2:

notReady indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instantiated);

See Also:

Constant Field Values

createAndGo

public static final int createAndGo

This value corresponds to the createAndGo RowStatus, as defined in RFC 2579 from SMIv2:

createAndGo is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device;

See Also:

Constant Field Values

createAndWait

public static final int createAndWait

This value corresponds to the createAndWait RowStatus, as defined in RFC 2579 from SMIv2:

createAndWait is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device);

See Also:

Constant Field Values

destroy

public static final int destroy

This value corresponds to the destroy RowStatus, as defined in RFC 2579 from SMIv2:

destroy is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row.

See Also:

Constant Field Values

Constructor Detail

EnumRowStatus

public EnumRowStatus(int valueIndex)
              throws IllegalArgumentException

Build an EnumRowStatus from an int.

Parameters:

valueIndex - should be either 0 (unspecified), or one of the values defined in RFC 2579.

Throws:

IllegalArgumentException - if the given valueIndex is not valid.

EnumRowStatus

public EnumRowStatus(Enumerated valueIndex)
              throws IllegalArgumentException

Build an EnumRowStatus from an Enumerated.

Parameters:

valueIndex - should be either 0 (unspecified), or one of the values defined in RFC 2579.

Throws:

IllegalArgumentException - if the given valueIndex is not valid.

EnumRowStatus

public EnumRowStatus(long valueIndex)
              throws IllegalArgumentException

Build an EnumRowStatus from a long.

Parameters:

valueIndex - should be either 0 (unspecified), or one of the values defined in RFC 2579.

Throws:

IllegalArgumentException - if the given valueIndex is not valid.

EnumRowStatus

public EnumRowStatus(Integer valueIndex)
              throws IllegalArgumentException

Build an EnumRowStatus from an Integer.

Parameters:

valueIndex - should be either 0 (unspecified), or one of the values defined in RFC 2579.

Throws:

IllegalArgumentException - if the given valueIndex is not valid.

EnumRowStatus

public EnumRowStatus(Long valueIndex)
              throws IllegalArgumentException

Build an EnumRowStatus from a Long.

Parameters:

valueIndex - should be either 0 (unspecified), or one of the values defined in RFC 2579.

Throws:

IllegalArgumentException - if the given valueIndex is not valid.

EnumRowStatus

public EnumRowStatus()
              throws IllegalArgumentException

Build an EnumRowStatus with unspecified value.

Throws:

IllegalArgumentException

EnumRowStatus

public EnumRowStatus(String x)
              throws IllegalArgumentException

Build an EnumRowStatus from a String.

Parameters:

x - should be either "unspecified", or one of the values defined in RFC 2579 ("active", "notReady", etc...)

Throws:

IllegalArgumentException - if the given String x is not valid.

EnumRowStatus

public EnumRowStatus(SnmpInt valueIndex)
              throws IllegalArgumentException

Build an EnumRowStatus from an SnmpInt.

Parameters:

valueIndex - should be either 0 (unspecified), or one of the values defined in RFC 2579.

Throws:

IllegalArgumentException - if the given valueIndex is not valid.

Method Detail

toSnmpValue

public SnmpInt toSnmpValue()
                    throws IllegalArgumentException

Build an SnmpValue from this object.

Returns:

an SnmpInt containing this object value.

Throws:

IllegalArgumentException - if this object holds an unspecified value.

isValidValue

public static boolean isValidValue(int value)

Check that the given value is valid. Valid values are:

• unspecified(0)
• active(1)
• notInService(2)
• notReady(3)
• createAndGo(4)
• createAndWait(5)
• destroy(6)

getIntTable

protected Hashtable getIntTable()

Description copied from class: Enumerated

Returns the hashtable of the integer forms. getIntTable().get(x) returns the string form associated to the integer x. This method must be implemented by the derived class.

Specified by:

getIntTable in class Enumerated

Returns:

An hashtable for read-only purpose

getStringTable

protected Hashtable getStringTable()

Description copied from class: Enumerated

Returns the hashtable of the string forms. getStringTable().get(s) returns the integer form associated to the string s. This method must be implemented by the derived class.

Specified by:

getStringTable in class Enumerated

Returns:

An hashtable for read-only purpose