Managing States

INDEX PREVIOUS NEXT

The Java classes introduced by JViews TGO to implement the concepts in state models are IltState and IltStateSystem.

State classes are subclasses of IltState. Their instances are the state values that will be used to describe the state and alarm condition of a telecom object. Examples of state values are: the primary state of a telecom object, each of its secondary states, or its alarm state.

The state dictionaries are embodied by instances of IltStateSystem, which gather the related state classes as nested classes.

• IltOSI is the gathering class for the OSI state dictionary. The classes nested in IltOSI are:
• IltOSI.State   This class implements the OSI primary states. Its instances are triplets, with a member of each of:
- IltOSI.State.Operational
- IltOSI.State.Usage
- IltOSI.State.Administrative
• IltOSI.Procedural, IltOSI.Availability, IltOSI.Control, IltOSI.Standby, and IltOSI.Repair   These classes implement the OSI secondary states.
• IltBellcore is the gathering class for the Bellcore state dictionary. The classes nested in IltBellcore are:
• IltBellcore.State   This class implements the Bellcore primary states.
• IltBellcore.SecState   This class implements the Bellcore secondary states.
• IltSNMP is the gathering class for the SNMP state dictionary. The classes nested in IltSNMP are:
• IltSNMP.State   This class implements the SNMP primary state and its values.
• IltSNMP.Interface   This class contains the definition of the MIB-II Interface Group states.
• IltSNMP.IP   This class contains the definition of the states present in the MIB-II IP Group.
• IltSNMP.TCP   This class contains the definition of the states present in the MIB-II TCP Group.
• IltSNMP.UDP   This class contains the definition of the states present in the MIB-II UDP Group.
• IltSNMP.EGP   This class contains the definition of the states present in the MIB-II EGP Group.
• IltSNMP.ICMP   This class contains the definition of the states present in the MIB-II ICMP Group.
• IltSNMP.SNMP   This class contains the definition of the states present in the MIB-II SNMP Group.
• IltSNMP.System   This class models the MIB-II System Group.
• IltSONET is the gathering class for the SONET state dictionary. The classes nested in IltSONET are:
• IltSONET.State   This class implements the SONET primary states.
• IltSONET.Protection   This class implements the SONET secondary states, also called protection switch request indicators.
• IltMisc is the gathering class for the Misc state dictionary. The only class nested in IltMisc is:
• IltMisc.SecState    This class implements the additional secondary states brought in by the Misc state dictionary.
• IltPerformance is the gathering class for the Performance state dictionary. The only class nested in IltPerformance is:
• IltPerformance.SecState This class implements the additional secondary states brought in by the Performance state dictionary.
• IltSAN is the gathering class for the SAN state dictionary. The only class nested in IltSAN is:
• IltSAN.SecState This class implements the additional secondary states brought in by the SAN state dictionary.
• IltAlarm is the gathering class for the Alarm state dictionary. The classes nested in IltAlarm are:
• IltAlarm.State    This class implements the alarm state of an object, with the number of new and acknowledged alarms of each severity, plus the Not Reporting and Loss Of Connectivity conditions.
• IltAlarm.Severity   This class is not a state class. It is an extensible enumeration implementing the raw alarm severities known to JViews TGO.
• IltAlarm.ImpactSeverity   This class is not a state class. It is an extensible enumeration implementing the impact alarm severities known to JViews TGO.
• IltTrap is the gathering class for the Trap state dictionary. The classes nested in IltTrap are:
• IltTrap.State   This class implements the trap state of an object, with the number of new and acknowledged traps for each type of trap.
• IltTrap.Type   This class represents the enumeration with the traps known to JViews TGO.

• The operational, usage, and administrative components of the OSI primary state.
• The Bellcore, SONET, and SNMP primary states.
• The OSI, Bellcore, SNMP, SONET, Performance, and Misc secondary states.

The names of the static data members storing the state values are listed in the tables in Appendix A, Reference Tables for State Visuals.

The state of a telecom object is described by an Ilt ObjectState instance stored in the telecom object. This instance is called the object state of the telecom object. It contains state values corresponding to the primary state, the secondary states, and the alarm or trap state of the telecom object.

There are seven subclasses of IltObjectState in JViews TGO. Subclasses are based on the OSI, Bellcore, SNMP and SONET state systems as illustrated in Figure 12.9.

Figure 12.9 shows that each type of object state can hold states and alarms. Alarms systematically complement states with the class IltAlarmObjectState, dedicated to the objects to which only alarms, and no states, are assigned. Figure 12.9 also shows that each type of object state can hold states and traps. Traps systematically complement states with the class IltTrapObjectState, dedicated to the objects to which only traps, and no states, are assigned.

To choose the set of state dictionaries used to describe the state and alarm condition of a telecom object, select a subclass of IltObjectState to store the object state. The seven subclasses of IltObjectState - already shown in Figure 2.1 and Figure 12.9 - are listed below with the state dictionaries that they gather.

• IltOSIObjectState   OSI, SAN, Alarm, Performance, and Misc dictionaries.
• IltBellcoreObjectState   Bellcore, SAN, Alarm, Performance, and Misc dictionaries.
• IltSNMPObjectState   SNMP, SAN, Trap, Performance, and Misc dictionaries.
• IltSONETObjectState and IltBiSONETObjectState   SONET, SAN, Alarm, and Performance dictionaries.
• IltAlarmObjectState   Alarm dictionary only.
• IltTrapObjectState   Trap dictionary only.

IltNetworkElement berlin =
  new IltNetworkElement
                     ("Berlin",
                      IltNetworkElement.Type.NE,
                      IltNetworkElement.Function.TransportCrossConnect,
                      IltNetworkElement.Family.OC12,
                      new IltBellcoreObjectState());

IltOSIObjectState is an object state class that provides an OSI primary state, a set of secondary states to be taken from the OSI, Misc, and Performance state dictionaries, and an alarm state from the Alarm state dictionary.

An instance of IltOSIObjectState thus holds:

• The object primary state as an instance of IltOSI.State
• The object secondary states as a list of state values which can be instances of IltOSI.Procedural, IltOSI.Availability, IltOSI.Control, IltOSI.Standby, IltOSI.Repair, IltSAN.SecState, IltMisc.SecState, or IltPerformance.SecState.
• The object alarms as an instance of IltAlarm.State.

IltBellcoreObjectState is an object state class that provides a Bellcore primary state, a set of secondary states to be taken from the Bellcore, Performance, and Misc state dictionaries, and an alarm state from the Alarm state dictionary.

An instance of IltBellcoreObjectState thus holds:

• The object primary state as an instance of IltBellcore.State.
• The object secondary states as a list of state values that can be instances of IltBellcore.SecState, IltSAN.SecState, IltMisc.SecState, or IltPerformance.SecState.
• The alarms of the object as an instance of IltAlarm.State.

An instance of IltSNMPObjectState thus holds:

• The object primary state as an instance of IltSNMP.State.
• The object secondary states as a list of state values that can be instances of IltLimitedNumericState, IltSAN.SecState, IltMisc.SecState or IltPerformance.SecState.
• The alarms of the object as an instance of IltTrap.State.

IltSONETObjectState and IltBiSONET ObjectState are object state classes that provide one or two SONET primary states respectively, two sets of protection switch request indicators, a secondary state taken from the Performance state dictionary if needed and one alarm state. They are dedicated to links, typically links in SONET rings.

An instance of IltSONETObjectState thus holds:

• The link primary state as an instance of IltSONET.State.
• The protection switch request indicators that have been set on one end of the link, as a list of instances of IltSONET.Protection.
• The protection switch request indicators that have been set on the other end of the link, as a second list of instances of IltSONET.Protection.
• The object secondary states as a list of state values that are instances of IltSAN.SecState or IltPerformance.SecState.
• The link alarms as an instance of IltAlarm.State.

An instance of IltBiSONETObjectState holds:

• A second instance of IltSONET .State, to store the state of the link in the reverse direction.

IltAlarmObjectState is an object state class that provides only an alarm state from the Alarm state dictionary. It is intended for objects with no states.

An instance of IltAlarmObjectState thus holds only an instance of IltAlarm.State.

IltTrapObjectState is an object state class that provides only a trap state from the Trap state dictionary. It is intended for objects with no states.

An instance of IltTrapObjectState thus holds only an instance of IltTrap.State.

neast.setState(IltOSI.State.Usage.Active);

The IltOSI.State.Usage.Active symbol is the name of a global variable that contains a state value. This value is an instance of the IltOSI.State.Usage class (which is itself an IltState subclass).

berlin.setState(IltBellcore.State.EnabledActive);
berlin.setState(IltBellcore.SecState.Busy);

berlin.setState(IltSNMP.State.Shutdown);
berlin.setState (IltMisc.SecState.TestFailed);
berlin.set (IltSNMP.Interface.InOctets, new Integer (123));

In the SNMP state dictionary, most of the states have numeric values. In order to set the values for these states you can use either IltSNMPObjectState or IltObject. Both of these APIs provide methods to set and retrieve the values of numeric states.

• IltSNMPObjectState.set (IltState state, Object value)  sets the value of the given state
• Object IltSNMPObjectState.get (IltState state)  returns the value of the given state.

Besides the numeric and Boolean states present in the SNMP state dictionary, there is also a set of information that is related to the system being managed and that is defined in the MIB-II System Group. The information in the group is displayed in a System window (explained in detail in System Window). The graphical representation of this information is an icon that, when clicked, opens the System window containing the list of all the attributes set in the telecom object. For information regarding the insertion of new attributes, see Creating a New Attribute in the System Group in the Styling documentation.

IltSNMPObjectState objstate = (IltSNMPObjectState) berlin.getObjectState();
IltSNMP.SystemInfo sysinfo = objstate.getSystemInfo();
Sysinfo.setDescription ("Berlin station");
Sysinfo.setContact ("John Doe");

berlin_west.setState(IltSONET.State.Active);

In addition to the API used to assert states, another API is available for accessing and removing states. Most of the functions for accessing states are available from the class IltObject.

neast.hasState(IltOSI.State.Usage.Idle);

Sometimes, specific accesses are granted using the functional interfaces on the classes IltObjectState and IltState. The following code shows how to access the state object and then set the accessors for retrieving a given state.

IltOSIObjectState osiObjectState = 
          (IltOSIObjectState)neast.getObjectState();
IltOSI.State osiState = osiObjectState.getState();
osiState.getOperationalState();
osiState.getUsageState();
osiState.getAdministrativeState();

• You can use the clearState member function, which removes secondary states or resets the primary state to its default value.
• You can use the resetState member function, which removes all the secondary states and resets the primary state to its default value.