ilog.tgo.model

Class IltSNMPObjectStateSAXInfo

java.lang.Object

ilog.tgo.model.IltObjectStateSAXInfo

ilog.tgo.model.IltSNMPObjectStateSAXInfo

All Implemented Interfaces:

IlpSAXSerializable

public class IltSNMPObjectStateSAXInfo
extends IltObjectStateSAXInfo

This class defines the XML Serialization for IltSNMPObjectState. It allows you to read and write an IltSNMPObjectState in the following format:

  [<state>SSS</state>]
  [<interface state="sss" [isArray="true"|"false"] [javaClass="Java class"] [operation="add"|"remove"]>XXX</interface>]*
  [<ip state="sss" [isArray="true"|"false"] [javaClass="Java class"] [operation="add"|"remove"]>XXX</ip>]*
  [<icmp state="sss" [isArray="true"|"false"] [javaClass="Java class"] [operation="add"|"remove"]>XXX</icmp>]*
  [<tcp state="sss" [isArray="true"|"false"] [javaClass="Java class"] [operation="add"|"remove"]>XXX</tcp>]*
  [<udp state="sss" [isArray="true"|"false"] [javaClass="Java class"] [operation="add"|"remove"]>XXX</udp>]*
  [<egp state="sss" [isArray="true"|"false"] [javaClass="Java class"] [operation="add"|"remove"]>XXX</egp>]*
  [<snmp state="sss" [isArray="true"|"false"] [javaClass="Java class"] [operation="add"|"remove"]>XXX</snmp>]*
  [<system>
    [<attribute name="attr" [null="true"|"false"] [javaClass="XXX"]>XXX</attribute>]*
  </system>]
 

Where:

SSS

stands for the name of an SNMP state, such as Up.

The operation attribute is optional and indicates if the state is being added or removed from the object state. By default, the states are added to the object state. This attribute is used when the states are set within an updateState element.

For the list of possible states, read the section Graphical Representation of SNMP Primary States in the User's Manual or the IltSNMP.State class.

sss

stands for the name of a state of a MIB-II group, such as Forwarding for the IP group (see IltSNMP.Interface, IltSNMP.IP, IltSNMP.ICMP, IltSNMP.TCP, IltSNMP.UDP, IltSNMP.EGP, IltSNMP.SNMP).

Each state value may be an array (isArray="true"). It may also be of any Java class, or even an array of an arbitrary Java class. By default, its content XXX is read as a float (not an array). If it is an array, XXX follows the format described in IlpSAXArrayHandler.

Note that in the array case only, the Java class can be a Java type, such as int.

For the list of possible states, read section Graphical Representation of SNMP Secondary States in the User's Manual.

attr

stands for an attribute name. The predefined attributes are description, contact, location. Other attributes can be added (see IltSNMP.System).

The syntax for an attribute value is the same as for a "regular" attribute.

The format may also contain the elements described in the common object state format (IltObjectStateSAXInfo).

Since:

JTGO 3.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_TAG
static String	EGP_TAG
static String	ICMP_TAG
static String	INTERFACE_TAG
static String	IP_TAG
static String	SNMP_TAG
static String	SYSTEM_TAG
static Map	Tag2PathMap
static String	TCP_TAG
static String	UDP_TAG

Fields inherited from class ilog.tgo.model.IltObjectStateSAXInfo

ALARMS_TAG, MISC_TAG, PERFORMANCE_TAG, SAN_TAG, TRAPS_TAG

Fields inherited from interface ilog.cpl.storage.IlpSAXSerializable

EMPTY_ATTRS

Constructor Summary

Constructors

Constructor and Description
IltSNMPObjectStateSAXInfo()

Method Summary

Modifier and Type	Method and Description
IlpSAXAttributeValueHandler	getSAXHandler() Returns a SAX handler capable of reading the attribute.
void	output(Object value, IlpTypeConverter typeConverter, ContentHandler outputHandler) Outputs the value to an SAX ContentHandler.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INTERFACE_TAG

public static final String INTERFACE_TAG

See Also:

Constant Field Values

IP_TAG

public static final String IP_TAG

See Also:

Constant Field Values

ICMP_TAG

public static final String ICMP_TAG

See Also:

Constant Field Values

TCP_TAG

public static final String TCP_TAG

See Also:

Constant Field Values

UDP_TAG

public static final String UDP_TAG

See Also:

Constant Field Values

EGP_TAG

public static final String EGP_TAG

See Also:

Constant Field Values

SNMP_TAG

public static final String SNMP_TAG

See Also:

Constant Field Values

SYSTEM_TAG

public static final String SYSTEM_TAG

See Also:

Constant Field Values

ATTRIBUTE_TAG

public static final String ATTRIBUTE_TAG

See Also:

Constant Field Values

Tag2PathMap

public static final Map Tag2PathMap

Internal: do not use!

Constructor Detail

IltSNMPObjectStateSAXInfo

public IltSNMPObjectStateSAXInfo()

Method Detail

getSAXHandler

public IlpSAXAttributeValueHandler getSAXHandler()

Description copied from class: IltObjectStateSAXInfo

Returns a SAX handler capable of reading the attribute. To avoid an instance of SAX handler to be used simultaneously by two concurrent threads, this method should either return a new instance of SAX handler each time it is called or take advantage of the java.lang.ThreadLocal class to return a different instance for each thread.

Specified by:

getSAXHandler in interface IlpSAXSerializable

Specified by:

getSAXHandler in class IltObjectStateSAXInfo

Returns:

A SAX event handler.

output

public void output(Object value,
                   IlpTypeConverter typeConverter,
                   ContentHandler outputHandler)
            throws SAXException

Description copied from interface: IlpSAXSerializable

Outputs the value to an SAX ContentHandler. The method translates the object as SAX ContentHandler method calls.

Specified by:

output in interface IlpSAXSerializable

Overrides:

output in class IltObjectStateSAXInfo

Parameters:

value - The object to output

typeConverter - The type converter that may be needed to translate values to strings.

outputHandler - The SAX ContentHandler used by this method.

Throws:

SAXException

See Also:

IlpTypeConverter.createStringValue(Class,Object)