| Netra CT Server Software Developer's Guide |    
|
| Netra CT Server Software Developer's Guide |
|
| C H A P T E R 4 |
|
Netra CT Element Management Agent API |
This chapter contains the application programming interfaces (API) of the Netra CT element management agent software and includes the following sections:
Netra CT management agent uses the Java Dynamic ManagementTM Kit (JDMK) framework as a Java API which provides the management capability for the Netra CT system.
JDMK supports JMX, which is a standard set of APIs for network/client management. JDMK provides an extended API along with different communication protocol adapters such as Remote Method Invocation (RMI), HTTP, HTML, and Simple Network Management Protocol (SNMP).
These protocol adapters are used to communicate with instances of JDMK agents; Netra CT management agent supports SNMP and RMI communication protocols.
You can find an introduction to the JDMK, tutorials, code samples, and APIs on the Java Developers website: http://developer.java.sun.com.
JDMK's API and development tools can help you develop distributed management applications. The JDMK allows resources of one host to be monitored from another host.
A resource can be any entity, physical or virtual, that you wish to monitor through your network. Physical resources include network elements, and virtual resources include applications operating on a host. A resource can be seen through its management interface, where its attributes, operations, and notifications are accessible by a management agent.
In order for a management agent to monitor a resource, the resource must be developed as a managed bean (MBean), which is Java object that represents the resource's management interface. If the resource itself is a Java application, it can be its own MBean. Otherwise, an MBean is a Java representation of a device.
In the JDMK model, a Java Dynamic Management agent follows the client-server model, in which an agent responds to the management requests from any number of client applications that wish to access its resources. The central component of an agent is the MBean server, which is a registry for MBean instances and provides the framework that allows agent services to interact with MBeans.
The JDMK provides protocol connector interfaces that allow remote applications to access agent applications and their resources. Remote method invocation (RMI) and HTTP are two such JDMK supported protocols that enable a Java client application running on one system to access the resources and methods of another Java server application running on a different system.
FIGURE 4-1 displays the location of the RMI/HTTP protocols between an agent application and a remote manager application.
In FIGURE 4-1, a resource and an agent service are registered as MBeans with the agent application's MBean server. The application agent also contains a connector server for the RMI/HTTP protocols. The remote manager application is a Java application running on a distant host system. The manager contains the RMI/HTTP connector client and proxy MBeans representing the resource and service. When the RMI/HTTP connector client establishes the connection with the agent's RMI/HTTP connector server, the other components of the application can issue management requests to the agent.
Typically, you would first determine the management interface of your resource, that is, the information needed to manage it. This information is expressed as attributes and operations. An attribute is a value of any type that a manager can get or set remotely. An operation is a method with any signature and any return type that the manager can invoke remotely.
As specified by the Java Management extensions for instrumentation, all attributes and operations are explicitly listed in an MBean interface. This Java interface defines the full management interface of an MBean. The interface must have the same name as the class that implements it, followed by the MBean suffix. Since the interface and its implementation are usually in different files, two files make up a standard MBean. For example, the management interface of the class SimpleStandard (in the file SimpleStandard.java) is defined in the interface SimpleStandardMBean (in the file SimpleStandardMBean.java).
For a complete discussion of JDMK components and protocols, refer to the Java Dynamic Management Kit documentation set found on the Solaris documentation website, http://docs.sun.com. For additional information of JDMK and the RMI/HTTP protocol, refer to the documentation, tutorials, code samples, and APIs found on the Java Developers website: http://developer.java.sun.com.
The entire Netra CT RMI API specification can be viewed online as cross-referenced HTML pages. By default, these HTML pages are installed in the following directory:
/opt/SUNWnetract/mgmt2.0/docs/api/com/sun/ctmgx/moh
You can view an index of all of these pages by opening the following link in an web browser:
file:///opt/SUNWnetract/mgmt2.0/docs/api/index.html
You can view additional Java API specification on the java.sun.com webpage at:
The following sections in this chapter list the classes of the Netra CT RMI application programming interface (API).
Each class, interface, inner class, and inner interface has its own separate section. Each of these sections have three subsections consisting of a class/interface description, summary tables, and detailed member descriptions of the following:
Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
TABLE 4-1 lists the management agent interfaces and TABLE 4-2 lists the management agent classes included in the Netra CT RMI API. In these tables, the term expose refers to the encapsulation of the object's variables inside a nucleus. This encapsulation allows for exposing (allowing access to) or hiding (denying access to) an object's access methods, which provides for greater modularity.
Detailed descriptions of the interfaces begin with Netra CT Management Agent Interface Descriptions and the detailed descriptions of the classes begin with Netra CT Management Agent Class Descriptions.
This section contains descriptions of the following RMI interfaces listed in the order in which they appear in the source code:
public interface AlarmCardPluginMBean extends PlugInUnitMBean
This class describes the management interface of the alarm card in a Netra CT system.
Resets the alarm card with a graceful shutdown.
public interface AlarmSeverityProfileMBean
This class describes the management interface of the Alarm Severity Profile MBean.
public com.sun.ctmgx.moh.AlarmSeverity
getAlarmSeverity(com.sun.ctmgx.moh.AlarmType alarmType)
Gets the alarm severity assignment for a specific type of alarm notification. This attribute identifies one alarm/severity pair.
One of the following perceived severity values:
com.sun.ctmgx.moh.AlarmSeverity.CLEARED
com.sun.ctmgx.moh.AlarmSeverity.INDETERMINATE
com.sun.ctmgx.moh.AlarmSeverity.CRITICAL
com.sun.ctmgx.moh.AlarmSeverity.MAJOR
com.sun.ctmgx.moh.AlarmSeverity.MINOR
com.sun.ctmgx.moh.AlarmSeverity.WARNING
public java.util.Map getAlarmSeverityList()
Gets the alarm severity assignment list.
This attribute identifies one or more alarm/severity pairs.
The alarm severity assignment list.
public void setAlarmSeverity(com.sun.ctmgx.moh.AlarmType alarmType, com.sun.ctmgx.moh.AlarmSeverity severity)
Sets the alarm severity assignment for a specific type of alarm notification.
This attribute identifies one alarm/severity pair.
alarmType - The alarm notification type.
severity - One of the perceived severity values defined as:
com.sun.ctmgx.moh.AlarmSeverity.CLEARED
com.sun.ctmgx.moh.AlarmSeverity.INDETERMINATE
com.sun.ctmgx.moh.AlarmSeverity.CRITICAL
com.sun.ctmgx.moh.AlarmSeverity.MAJOR
com.sun.ctmgx.moh.AlarmSeverity.MINOR
com.sun.ctmgx.moh.AlarmSeverity.WARNING
public interface CgtpServiceMBean extends SoftwareServiceMBean
This class describes the interface of class CgtpService.
|
Get the list of Ethernet physical interfaces associated with CGTP service. |
|
|
getDaemonList(), getName(), getNumExcessiveIntervals(), getPollingInterval(), getStatus(), setNumExcessiveIntervals(Integer), setPollingInterval(Integer), startPolling() |
public java.lang.Float getCurrentFilterThreshold()
Gets the current filtered failure threshold.
The threshold in percentage of the filtered failure packets over the total received packets.
public java.lang.Float getFilterMaxThreshold()
Gets the max filtered failure threshold.
The threshold in percentage of the filtered failure packets over the total received packets.
public java.lang.String[] getIfList()
Get the list of Ethernet physical interfaces associated with CGTP service.
A string array of interface names.
public OperationalState getIfState(java.lang.String ifState)
Get the operational state of a CGTP physical interface.
OperationalState.ENABLED, or OperationalState.DISABLED, or OperationalState.UNKNOWN.
public void setFilterMaxThreshold(java.lang.Float threshold)
Sets the max filtered failure threshold.
threshold -- threshold to set.
public interface ContainmentTreeMBean
This class describes the management interface of the Containment Tree MBean.
public static final java.lang.String CT_FILTER_EQUIPMENT
This attribute gets the Equipment object(s) only during topology discovery.
public static final java.lang.String CT_FILTER_HOLDER
This attribute gets the Holder object(s) only during topology discovery.
public static final java.lang.String CT_FILTER_NE
This attribute gets the NE object(s) only during topology discovery.
public static final java.lang.String CT_FILTER_NETWORK_INTERFACE
This attribute is used to get the Network Interface object(s) only during topology discovery.
public static final java.lang.String CT_FILTER_PLUGIN_UNIT
This attribute gets the Plugin object(s) only during topology discovery.
public static final java.lang.String CT_FILTER_TERMINATION_POINT
This attribute gets the Termination Point object(s) only during topology discovery.
public java.util.Set getAncestors(javax.management.ObjectName node)
Gets the ancestors of the specified MBean in the containment hierarchy.
node - The ObjectName of the MBean where the search should start from.
A set containing the ObjectName objects for the ancestors MBeans. If the specified MBean has no ancestors an empty list is returned.
public java.util.Set getAncestors(javax.management.ObjectName node, java.lang.String filter)
Gets the ancestors of the specified MBean in the containment hierarchy that match the given filter type.
node - The ObjectName of the MBean where the search should start from.
filter - The filter constant used for filtering the retrieved MBeans.
A set containing the ObjectName objects for the ancestors MBeans. If the specified MBean has no ancestors or if the ancestors do not match the given type an empty list is returned.
public java.util.Set getChildren(javax.management.ObjectName node)
Gets the children of the specified MBean in the containment hierarchy.
node - The ObjectName of the MBean where the search should start from.
A set containing the ObjectName objects for the children MBeans. If the specified MBean has no children, an empty list is returned.
public java.util.Set getChildren(javax.management.ObjectName node, java.lang.String filter)
Gets the children of the specified MBean in the containment hierarchy that match the given filter type.
node - The ObjectName of the MBean where the search should start from.
filter - The filter constant used for filtering the retrieved MBeans.
A set containing the ObjectName objects for the children MBeans. If the specified MBean has no children, or if the children do not match the given type, an empty list is returned.
public java.util.Set getDescendants(javax.management.ObjectName node)
Gets the descendants of the specified MBean in the containment hierarchy.
node - The ObjectName of the MBean where the search should start from.
A set containing the ObjectName objects for the descendants MBeans. If the specified MBean has no descendants an empty list is returned.
public java.util.Set getDescendants(javax.management.ObjectName node, java.lang.String filter)
Gets the descendants of the specified MBean in the containment hierarchy that match the given type.
node - The ObjectName of the MBean where the search should start from.
filter - The filter constant used for filtering the retrieved MBeans.
A set containing the ObjectName objects for the descendants MBeans. If the specified MBean has no descendants or if the descendants do not match the given type an empty list is returned.
public javax.management.ObjectName getParent(javax.management.ObjectName node)
Gets the parent of the specified MBean in the containment hierarchy.
node - The ObjectName of the MBean where the search should start from.
The ObjectName object for the parent MBean. If the specified MBean has no parent a null value is returned.
public javax.management.ObjectName getParent(javax.management.ObjectName node, java.lang.String filter)
Gets the parent of the specified MBean in the containment hierarchy, if it matches the given type.
node - The ObjectName of the MBean where the search should start from.
filter - The filter constant used for filtering the retrieved MBeans.
The ObjectName object for the parent MBean. If the specified MBean has no parent or if its parent does not match the given type, a null value is returned.
public javax.management.ObjectName getRoot()
Gets the object name of the root MBean in the containment hierarchy.
The ObjectName object for the root MBean. This is the object name of the instance of NEMBean.
public interface CpciSlotMBean extends SlotMBean
This class describes the management interface of the CPCI Slot objects.
EquipmentHolderMBean, SlotMbean
public static final Boolean OFF
public static final Boolean ON
public Boolean getPowerState()
Gets the slot's power state. The PowerState can be either ON or OFF. This state shows whether the board in this CPCI slot is powered on or not.
The PowerState value which can be one of:
com.sun.ctmgx.moh.CpciSlotMBean.ON
com.sun.ctmgx.moh.CpciSlotMBean.OFF
public void setPowerState(Boolean powerState)
com.sun.ctmgx.moh.CpciSlotMBean.ON
com.sun.ctmgx.moh.CpciSlotMBean.OFF
hardReset(com.sun.ctmgx.moh.CpciSlotMBean)
Hard resets the board in this slot.
public interface CpuCardEquipmentMBean extends EquipmentMBean.
This class describes the management interface for CPU Card Equipment MBean.
CpuCardEquipmentMBean Memory Monitor Feature:
The purpose of this feature is to monitor memory usage on this CPU. There are three memory usage thresholds which are settable by user: Minor memory usage threshold, Major memory usage threshold and Critical threshold.
Minor and Major memory usage thresholds are represented in percentage of memory usage over total physical memory. Critical threshold is based on number of memory pages paged out per second.
The defaults are: Minor threshold 94%, Major threshold 97%, and Critical threshold, 1 page paged out per second.
An alarm will occur when physical memory utilization exceeds one of the specified thresholds. If the memory utilization/paging decreases below a specified threshold for a specified time interval, the alarm will clear. void
public java.lang.Integer getClearAlarmTimeOut()
Gets time required for a memory alarm to clear.
public java.lang.Integer getThreshCriticalMemoryUsed()
Provides the critical threshold of memory utilization in number of page-outs per second. The default value is 1 page per second.
The threshold in number of page-outs per second.
public java.lang.Integer getThreshMajorMemoryUsed()
Provides the major threshold of memory utilization in percentage value. The default value is 97%.
Major threshold in percentage.
public java.lang.Integer getThreshMinorMemoryUsed()
Sets the minor threshold of memory utilization in percentage value.
pctUsed - value in percentage to set
public void setClearAlarmTimeOut(java.lang.Integer timeOutPeriod)
Set time required for a memory alarm to clear.
timeOutPeriod - value in seconds.
public void setThreshCriticalMemoryUsed(java.lang.Integer pagesPerSec)
Sets the critical threshold of memory utilization in terms of number of page-outs per second.
pagesPerSec - value in page-outs per second to set.
public void setThreshMajorMemoryUsed(java.lang.Integer pctUsed)
public void setThreshMinorMemoryUsed(java.lang.Integer pctUsed)
This lets the user get the major threshold of memory utilization in percentage value.
pctUsed - value in percentage to set.
public interface CpuPluginMBean extends PlugInUnitMBean
This class describes the management interface of the CPU board objects as perceived from the alarm card MOH.
|
This lets user to reset this CPU board with a graceful shutdown of the operating system running on it. |
|
Resets this CPU board with a graceful shutdown of the operating system.
This class describes the interface for DaemonMBean.
public java.lang.Integer getCurrentRetryCount()
Gets the current number of retries to recover the daemon.
Number of times the system has tried to recover the daemon.
public java.lang.Integer getMaxRetryCount()
Gets the maximum number of retries to recover the daemon.
Maximum number of times the system will try to recover the daemon.
public java.lang.String getName()
String indicating name of the daemon. For example, on Solaris, Platform Management Service daemon name is picld, NFS service is nfsd.
public java.lang.String getState()
This attribute identifies the state of the daemon.
The daemon states values defined as string("running") if the daemon is running, or string("configured") if the daemon is not running and is installed, or string("unconfigured"), if the daemon is not running and is not installed.
public void setMaxRetryCount(java.lang.Integer maxRetries)
Set the maximum recovery retry count for a daemon.
Indicates how many times the system will try to recover the daemon.
maxRetries - The number of retries.
This class describes the management interface of the EFD MBean.
public interface EquipmentHolderMBean
This class describes the management interface of the EquipmentHolderMBean
public java.lang.String getEquipmentHolderAddress()
Gets the equipment holder address.
This attribute identifies the physical location of the resource represented by the Equipment Holder instance.
public java.lang.String getEquipmentHolderLabel()
Gets the equipment holder label.
This attribute identifies the external label string for this equipment holder.
The equipment holder's external label string, if none, a null string("") is returned.
public com.sun.ctmgx.moh.EquipmentHolderType getEquipmentHolderType()
Gets the equipment holder type.
Indicates whether the Equipment Holder instance is being used to represent a rack, shelf, drawer, or slot.
The equipment holder type defined as:
com.sun.ctmgx.moh.EquipmentHolderType.RACK
com.sun.ctmgx.moh.EquipmentHolderType.SHELF
com.sun.ctmgx.moh.EquipmentHolderType.DRAWER
com.sun.ctmgx.moh.EquipmentHolderType.SLOT
public interface EquipmentMBean
CpuCardEquipmentMBean, NumericSensorMBean, SensorMBean
This class describes the interface of the Equipment MBean.
public com.sun.ctmgx.moh.AdministrativeState getAdministrativeState()
Gets the administrative state.
This attribute is used to activate (unlocked) and deactivate (locked) the function performed by the Equipment.
The administrative state value defined as either:
com.sun.ctmgx.moh.AdministrativeState.LOCKED
com.sun.ctmgx.moh.AdministrativeState.UNLOCKED
public javax.management.ObjectName getAlarmSeverityProfilePointer()
Gets the ObjectName of the AlarmSeverityProfile associated with this MBean.
This attribute provides a pointer to the instance of the Alarm Severity Assignment Profile MBean that contains the severity assignments for the alarms reported by this MBean. When the value of this attribute is set to null, default severity assignments is used.
The ObjectName of the AlarmSeverityProfile MBean.
public java.lang.String getEquipmentType()
Get the equipment type String.
This attribute identifies the type of the equipment.
The equipment type of the EquipmentMBean instance.
public java.lang.String getLocationName()
This attribute identifies the specific or general location of the Equipment.
The specific or general location of the Equipment.
public com.sun.ctmgx.moh.OperationalState getOperationalState()
This attribute identifies whether or not the Equipment is capable of performing its normal functions, that is, enabled or disabled.
One of the following operational state values:
com.sun.ctmgx.moh.OperationalState.ENABLED
com.sun.ctmgx.moh.OperationalState.DISABLED
com.sun.ctmgx.moh.OperationalState.UNKNOWN
public java.lang.String getUserLabel()
This attribute gets a user-friendly name to the associated Equipment.
The user label of the Equipment.
public java.lang.String getVendorName()
This attribute identifies the vendor of the Equipment.
public java.lang.String getVersion()
This attribute identifies the version of the Equipment.
public void setAdministrativeState(com.sun.ctmgx.moh.AdministrativeState admin_state)
Sets the administrative state.
This attribute is used to activate (unlocked) and deactivate (locked) the function performed by the Equipment.
admin_state - The administrative state value defined as either:
com.sun.ctmgx.moh.AdministrativeState.LOCKED
com.sun.ctmgx.moh.AdministrativeState.UNLOCKED
public void setAlarmSeverityProfilePointer(javax.management.ObjectName asp)
Sets the ObjectName of the AlarmSeverityProfile associated with this MBean.
This attribute provides a pointer to the instance of the Alarm Severity Assignment Profile MBean that contains the severity assignments for the alarms reported by this MBean. When the value of this attribute is set to null, default severity assignments shall be used.
asp - The ObjectName of the AlarmSeverityProfile MBean.
public void setLocationName(java.lang.String location_name)
This attribute identifies the specific or general location of the Equipment.
location_name - The location name.
public void setUserLabel(java.lang.String user_label)
This attribute is used to assign a user friendly name to the associated Equipment.
user_label - The user label of the Equipment.
public interface EtherIfStatsMBean extends SoftwareServiceMBean
This class describes the management interface of Ethernet I/O Statistics Monitoring service.
|
getDaemonList(), getName(), getNumExcessiveIntervals(), getPollingInterval(), getStatus(), setNumExcessiveIntervals(Integer), setPollingInterval(Integer), startPolling(), stopPolling() |
public java.lang.Float getMaxThreshhold()
Gets the threshold in percentage of receive-transmit errors.
This attribute identifies the receive and transmit error threshhold.
Percentage value in Float format.
public java.lang.String[] getRxExcessiveThreshholdIfList()
Gets the list of Ethernet interfaces exceeding the receive error threshold
The list of Ethernet interfaces OR null if there is none.
public java.lang.String[] getTxExcessiveThreshholdIfList()
Gets the list of Ethernet interfaces exceeding the transmit error threshold.
The list of Ethernet interfaces OR null if there is none.
public void setMaxThreshhold(java.lang.Float threshhold)
Sets the threshold in percentage of receive-transmit errors.
This attribute identifies the receive and transmit error threshhold.
threshold -- The percentage to set.
This class describes the management interface of FullLog MBean. This MBean is used to group multiple instances of the Notification classes to form a log of Notifications.
Instances of this MBean are created automatically by the NE upon initialization. Creation and deletion of instances of this MBean from the management system are not allowed.
Upon initialization of the MOH agent, there will be just one instance of FullLog which is initialized with a default filter, all notifications from MOH agent will be logged. The Object name for this instance is defined by MohNames.OBJECT_NAME_FULL_LOG.
Notifications emitted by this MBean:
This notification is used to report the creation of an instance of this MBean.
This notification is used to report the deletion of an instance of this MBean.
This notification is used to report changes to the LogFullAction attribute of this MBean. The notification identifies the attribute that changed, its old value, and its new value.
This notification is used to report changes to the OperationalState attribute and AdministrativeState attribute of this MBean. The notification identifies the state attribute that changed, its old value, and its new value.
public void deleteAllRecords()
Deletes all records logged in the Log up to this point.
public void deleteRecords(int noOfRecords, int startIndex) throws java.lang.ArrayIndexOutOfBoundsException
Deletes records from the Log starting from a specified starting index.
noOfRecords - The total number of records to be deleted.
startIndex - The index in the log starting from which the records will be deleted.
Throws - ArrayIndexOutOfBoundsException if startIndex points beyond 0..size-1.
public com.sun.ctmgx.moh.AdministrativeState getAdministrativeState()
Gets the administrative state.
This attribute is used to activate (unlocked) and deactivate (locked) the function performed by the Log.
The administrative state value defined as one of the following:
com.sun.ctmgx.moh.AdministrativeState.LOCKED com.sun.ctmgx.moh.AdministrativeState.UNLOCKED
public java.util.Vector getAllRecords()
A vector containing all the records logged up to this point.
Gets the capacity or the maximum value of the number of records that can be logged.
public javax.management.NotificationFilter getFilter()
Gets the filter which is used to filter the Notifications to be logged.
The NotificationFilter object.
public com.sun.ctmgx.moh.LogFullAction getLogFullAction()
This attribute is used to identify the action the NE takes when the log space is full. The valid values for this attribute are wrap around and halt. The default value is wrap around.
The log full action value defined as one of the following: com.sun.ctmgx.moh.LogFullAction.WRAP com.sun.ctmgx.moh.LogFullAction.HALT
public java.util.Vector getLogRecordTypes()
Gets a vector of Notification types being logged.
This attribute identifies the types of log records grouped by this log-managed entity.
A vector object containing the types as String defined as com.sun.ctmgx.moh.AlarmNotification.FAN_FAILURE, com.sun.ctmgx.moh.AlarmNotification.FUSE_FAILURE, com.sun.ctmgx.moh.AlarmNotification.HIGH_TEMPERATURE, and so on.
public com.sun.ctmgx.moh.OperationalState getOperationalState()
This attribute identifies whether or not the Log is capable of performing its normal functions, that is, enabled or disabled.
The operational state value defined as one of the following:
com.sun.ctmgx.moh.OperationalState.ENABLED
com.sun.ctmgx.moh.OperationalState.DISABLED
com.sun.ctmgx.moh.OperationalState.UNKNOWN
public java.util.Vector getRecords(int noOfRecords, int startIndex)
throws java.lang.ArrayIndexOutOfBoundsException
Gets the records from a starting index
noOfRecords - The total number of records to be retrieved.
startIndex - Index in the log starting from which the records will be retrieved.
A vector containing noOfRecords number of records.
Throws - ArrayIndexOutOfBoundsException if startIndex points beyond 0..size-1.
Gets the total number of records logged.
public void setAdministrativeState(com.sun.ctmgx.moh.AdministrativeState admin_state)
Sets the administrative state.
This attribute activates (unlocks) and deactivates (locks) the function performed by the Log.
admin_state - The administrative state value defined as one of the following:
com.sun.ctmgx.moh.AdministrativeState.LOCKED com.sun.ctmgx.moh.AdministrativeState.UNLOCKED
public void setFilter(javax.management.NotificationFilter logFilter)
Sets the filter, for the Notifications to be logged.
logFilter - An object of type NotificationFilter. This can be object of one of the following:
com.sun.ctmgx.moh.AlarmNotificationFilter
com.sun.ctmgx.moh.AttributeChangeNotificationFilter
com.sun.ctmgx.moh.StateChangeNotificationFilter
javax.management.NotificationFilterSupport
public void setLogFullAction(com.sun.ctmgx.moh.LogFullAction logFullAction)
This attribute is used to identify the action the NE takes when the log space is full. The valid values for this attribute are wrap around and halt. The default value is wrap.
logFullAction - the log full action value defined as one of the following:
com.sun.ctmgx.moh.LogFullAction.WRAP
com.sun.ctmgx.moh.LogFullAction.HALT
public interface IpServiceMBean extends SoftwareServiceMBean
This class describes the interface of Unix File System (UFS) service.
|
getDaemonList(), getName(), getNumExcessIntervals(), getPollingInterval(),getStatus(), setNumExcessiveIntervals(Integer), setPollingInterval(Integer), startPolling(), stopPolling() |
public java.lang.Float getCurrentInAddrErrorThreshold()
Gets the current threshold of input datagrams discarded due to an invalid IP address in their IP header's destination field.
The threshold in percentage of number of errors over the total receiving datagrams.
public java.lang.Float getCurrentInHdrErrorThreshold()
Gets the current threshold of input datagrams discarded due to errors in their IP headers.
The threshold in percentage of number of errors over the total receiving datagrams.
public java.lang.Float getMaxInAddrErrorThreshold()
Gets the maximum threshold of input datagrams discarded due to invalid IP address in IP header destination field.
The maximum threshold in percentage of number of errors over the total receiving datagrams.
public java.lang.Float getMaxInHdrErrorThreshold()
Gets the maximum threshold of input datagrams discarded due to an error in the IP header.
The maximum threshold in percentage of number of errors over the total receiving datagrams.
public void setMaxInAddrErrorThreshold(java.lang.Float newThreshold)
Sets the maximum threshold of input datagrams discarded due to invalid IP address in IP header.
newThreshold - maximum threshold to set.
public void setMaxInHdrErrorThreshold(java.lang.Float newThreshold)
Sets the maximum threshold of input datagrams discarded due to errors in their IP headers.
newThreshold - maximum threshold to set.
This class describes the management interface for Latest Occurrence Log MBean.
This MBean groups multiple instances of the Notification classes to form a latest occurrence log (LOL) of Notifications.
If no other log Notification/record contained in LOL has values of the attributes identified by the 'key attribute list' attribute equal to the attribute values of the log record to be added, the log record is added as a new entry to LOL. If a log record contained in the LOL has values of the attributes identified by the 'key attribute list' attribute equal to the attribute values of the log record to be added, the older existing log record contained in the LOL is replaced by the new log record.
Instances of this MBean are created automatically by the NE upon initialization.
Creation and deletion of instances of this MBean from the management system are not allowed.
Upon initialization of the MOH agent there are two instances of this class. One instance is initialized with an AlarmNotificationFilter with all severities enabled and 'Type' and 'PerceivedSeverity' being set as the Key attributes. The AdministrativeState is also activated. The object name for this instance is defined by NetraCtDefs.OBJECT_NAME_LOL_ALARM.
And the other instance is just initialized with a default filter for netract.moh The object name for this instance is defined by NetraCtDefs.OBJECT_NAME_LOL_ALL.
Notifications emitted by this MBean:
This notification is used to report the creation of an instance of this MBean.
This notification is used to report the deletion of an instance of this MBean.
This notification is used to report changes to the LogFullAction attribute of this MBean. The notification identifies the attribute that changed, its old value, and its new value.
This notification is used to report changes to the OperationalState attribute and AdministrativeState attribute of this MBean. The notification identifies the state attribute that changed, its old value, and its new value.
public void addAttribute(java.lang.String attribute)
Adds the attribute into the key attribute list.
attribute - Name (string) of the attribute to be added to the key attribute list
public void deleteAllRecords()
Deletes all records logged in the Log till now.
public void deleteRecords(int noOfRecords, int startIndex)
throws ArrayIndexOutOfBoundsException
Deletes records from the Log starting from a specified starting index.
noOfRecords - The total number of records to be deleted
startIndex - Index in the log starting from which the records will be deleted
Throws - ArrayIndexOutOfBoundsException if startIndex points beyond 0..size-1.
public com.sun.ctmgx.moh.AdministrativeState getAdministrativeState()
Gets the administrative state.
This attribute is used to activate (unlock) and deactivate (lock) the function performed by the Log.
The administrative state value defined as one of the following:
com.sun.ctmgx.moh.AdministrativeState.LOCKED
com.sun.ctmgx.moh.AdministrativeState.UNLOCKED
public java.util.Vector getAllRecords()
A vector containing all the records logged till now.
Gets the capacity or the maximum value of the number of records which can be logged.
public javax.management.NotificationFilter getFilter()
Gets the filter which is used to filter the Notifications to be logged.
The NotificationFilter object.
public java.util.Set getKeyAttributeList()
Gets the key attribute list as an object of Set.
An object of java.util.Set containing all the key attribute names as String.
public com.sun.ctmgx.moh.LogFullAction getLogFullAction()
This attribute is used to identify the action the NE takes when the log space is full. The valid values for this attribute are wrap around and halt. The default value is wrap around.
The log full action value defined as one of the following:
com.sun.ctmgx.moh.LogFullAction.WRAP
com.sun.ctmgx.moh.LogFullAction.HALT
public java.util.Vector getLogRecordTypes()
Gets a set of Notification types being logged.
This attribute identifies the types of log records grouped by this log-managed entity.
A set object containing the types as String defined as com.sun.ctmgx.moh.AlarmNotification.FAN_FAILURE, com.sun.ctmgx.moh.AlarmNotification.FUSE_FAILURE, com.sun.ctmgx.moh.AlarmNotification.HIGH_TEMPERATURE, and so on.
public com.sun.ctmgx.moh.OperationalState getOperationalState()
This attribute identifies whether or not the Log is capable of performing its normal functions, that is, enabled or disabled.
The operational state value defined as one of the following:
com.sun.ctmgx.moh.OperationalState.ENABLED
com.sun.ctmgx.moh.OperationalState.DISABLED
com.sun.ctmgx.moh.OperationalState.UNKNOWN
public java.util.Vector getRecords(int noOfRecords, int startIndex)
throws ArrayIndexOutOfBoundsException
Gets the records from a starting index.
noOfRecords -The total number of records to be retrieved.
startIndex - The index in the log starting from which the records will be retrieved.
A vector containing noOfRecord number of records.
Throws - ArrayIndexOutOfBoundsException if startIndex points beyond 0..size-1.
Gets the total number of records logged.
public void removeAttribute(java.lang.String attribute)
attribute - A String which is the name of the attribute to be deleted from the key attribute list.
public void setAdministrativeState(com.sun.ctmgx.moh.AdministrativeState admin_state)
Sets the administrative state.
This attribute is used to activate (unlock) and deactivate (lock) the function performed by the Log.
admin_state - The administrative state value defined as one of the following:
com.sun.ctmgx.moh.AdministrativeState.LOCKED
com.sun.ctmgx.moh.AdministrativeState.UNLOCKED
public void setCapacity(int capacity)
capacity - Maximum size for the log.
public void setFilter(javax.management.NotificationFilter logFilter)
Sets the filter, which will be used to filter the Notifications to be logged.
logFilter - An object of type NotificationFilter. This can be object of one of the following:
com.sun.ctmgx.moh.AlarmNotificationFilter
com.sun.ctmgx.moh.AttributeChangeNotificationFilter
com.sun.ctmgx.moh.StateChangeNotificationFilter
javax.management.NotificationFilterSupport
public void setKeyAttributeList(java.util.Set list)
This attribute indicates the list of attribute names to be used as keys to uniquely identify the entries in a latest occurrence log.
list - An object of java.util.Set containing the attribute names
public void setLogFullAction(com.sun.ctmgx.moh.LogFullAction logFullAction)
This attribute is used to identify the action the NE takes when the log space is full. The valid values for this attribute are wrap and halt. The default value is wrap.
logFullAction - The log full action value defined as one of the following:
com.sun.ctmgx.moh.LogFullAction.WRAP
com.sun.ctmgx.moh.LogFullAction.HALT
This class describes the management interface of the NE MBean.
public javax.management.ObjectName getAlarmSeverityProfilePointer()
Gets the ObjectName of the AlarmSeverityProfile associated with this MBean.
This attribute provides a pointer to the instance of the Alarm Severity Assignment Profile MBean that contains the severity assignments for the alarms reported by this MBean. When the value of this attribute is set to null, default severity assignments are used.
The ObjectName of the AlarmSeverityProfile MBean.
public java.lang.String getDescription()
Description of this network element.
Gets the time-of-day system time.
The difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
public java.lang.String getLocationName()
Gets the location name of the NE.
This attribute identifies the specific or general location of the NE.
The specific or general location of the NE.
public com.sun.ctmgx.moh.OperationalState getOperationalState()
This attribute identifies whether or not the NE MBean is capable of performing its normal functions, that is, enabled or disabled.
One of the following operational state values:
com.sun.ctmgx.moh.OperationalState.ENABLED
com.sun.ctmgx.moh.OperationalState.DISABLED
com.sun.ctmgx.moh.OperationalState.UNKNOWN
public java.lang.Boolean getSecurityState()
Get the security state of the NE.
This attribute identifies the security state of the NE. It is used to determine whether authentication checks need to be performed on the client connection. A boolean value of true indicates that authentication checking will be performed on each client connection. (See Netra CT Agent Security for more information.)
public java.lang.String getVendorName()
This attribute identifies the vendor of the NE.
public java.lang.String getVersion()
This attribute identifies the version of the NE. A value of null should be used in cases where version information is not available or applicable to the NE being represented.
public void setAlarmSeverityProfilePointer(ObjectName asp)
Sets the AlarmSeverityProfile associated with this MBean.
This attribute provides a pointer to the instance of the Alarm Severity Assignment Profile MBean that contains the severity assignments for the alarms reported by this MBean. When the value of this attribute is set to null, default severity assignments shall be used.
asp - The ObjectName of the AlarmSeverityProfile MBean.
public void setLocationName(java.lang.String location_name)
location_name - The location name to set
public interface NetworkInterfaceMBean
This class describes the management interface for Network Interface MBean.
This interface needs to be implemented to represent a network interface object in the system.
|
Gets the physical TerminationPoint used by this network interface |
|
public ObjectName getAlarmSeverityProfilePointer()
Gets the AlarmSeverityProfile associated with this MBean.
This attribute provides a pointer to the instance of the Alarm Severity Assignment Profile MBean that contains the severity assignments for the alarms reported by this MBean. When the value of this attribute is set to null, default severity assignments shall be used.
The ObjectName of the AlarmSeverityProfile MBean.
public java.lang.Integer getMtu()
Gets Mtu (Maximum Transmit Unit) of the interface.
The maximum size of a packet this interface can send/receive.
public java.lang.String getName()
Gets the name of the interface.
The name of the network interface.
public com.sun.ctmgx.moh.OperationalState getOperationalState()
One of the following operational state values:
com.sun.ctmgx.moh.OperationalState.ENABLED
com.sun.ctmgx.moh.OperationalState.DISABLED
com.sun.ctmgx.moh.OperationalState.UNKNOWN
public java.lang.String getPermanentAddress()
Gets the address of the interface.
The device specific physical address.
public javax.management.ObjectName getTerminationPoint()
Gets the physical TerminationPoint used by this network interface.
The ObjectName of the TerminationPoint.
public java.lang.String getType()
Type of the network interface.
public java.lang.String getVendorName()
public java.lang.String getVersion()
public void setAlarmSeverityProfilePointer(javax.management.ObjectName asp)
Sets the AlarmSeverityProfile associated with this MBean.
This attribute provides a pointer to the instance of the Alarm Severity Assignment Profile MBean that contains the severity assignments for the alarms reported by this MBean. When the value of this attribute is set to null, default severity assignments shall be used.
asp - The ObjectName of the AlarmSeverityProfile MBean.
public interface NfsServiceMBean extends SoftwareServiceMBean
This class describes the management interface of the Network File System (NFS) Monitor service.
|
getDaemonList(), getName(), getNumExcessiveIntervals(), getPollingInterval(), getStatus(), setNumExcessiveIntervals(Integer), setPollingInterval(Integer), startPolling(), stopPolling() |
public java.lang.Float getClientMaxThreshHold()
Gets client maximum threshhold. Threshhold is the percentage of errors/total transactions.
public java.lang.Float getClientThreshHold()
Gets client current threshhold.
Threshhold is the percentage of errors/total transactions
public java.lang.String[] getMountFailureList()
Gets the list of failed NFS mount points
List of failed file system mount points.
public java.lang.Float getServerMaxThreshHold()
Gets server maximum threshhold.
Threshhold is the percentage of errors/total transactions.
public java.lang.Float getServerThreshHold()
Gets server current threshhold.
Threshhold is the percentage of errors/total transactions.
public void setClientMaxThreshHold(java.lang.Float threshHold)
Sets client maximum threshhold.
Threshhold is the percentage of errors/total transactions.
public void setServerMaxThreshHold(java.lang.Float threshHold)
Sets server maximum threshhold.
Threshhold is the percentage of errors/total transactions.
public interface NumericSensorMBean extends SensorMBean
This class describes the interface for NumericSensorMBean.
This Mbean is used to model the thermistor (temperature sensor) on the CPU card. There are three temperature regions to monitor: noncritical, critical, and fatal. Each of the temperature regions has lower and upper boundaries or thresholds.
In general, an alarm is generated when the temperature falls below the lower threshold or exceeds the upper threshold.
Not all thresholds are supported in Netra CT. In Netra C 410 and CT 810, only the upper threshold of each region is supported.
The noncritical and critical thresholds are settable and under user control. The fatal threshold is the CPU junction temperature which is determined and set at board manufacturing time. This threshold is read-only by user.
An alarm occurs when the temperature exceeds the noncritical or critical threshold.
An alarm occurs and the system goes through automatic shutdown when the temperature exceeds the fatal threshold.
|
If the RateUnits property is set to a value other than none, the units are further qualified as rate units. |
|
public static final java.lang.Short CRITICAL_LOWER
Lower bound of the second (middle) level threshold.
public static final java.lang.Short CRITICAL_UPPER
Upper bound of the second (middle) level threshold.
public static final java.lang.Short FATAL_LOWER
Lower bound of the third (highest) level threshold.
public static final java.lang.Short FATAL_UPPER
Upper bound of the third (highest) level threshold.
public static final java.lang.Short NONCRITICAL_LOWER
Lower bound of the first (lowest) level threshold.
public static final java.lang.Short NONCRITICAL_UPPER
Upper bound of the first level threshold.
public java.lang.String getBaseUnits()
Gets the base unit of this numeric sensor; e.g., a temperature sensor might read the temperature in degree C.
degree C for temperature in Celsius.
public java.lang.Short[] getEnabledThresholds()
Gets enabled thresholds. This API provides the same information as getSupportedThresholds.
An array of enabled thresholds where each element(Short) in the array identifies a threshold type. An instance of this MBean, which is a temperature sensor, might return a Short array { NONCRITICAL_UPPER, CRITICAL_UPPER, FATAL_UPPER }.
public java.lang.Integer getLowerThresholdCritical()
Gets lower critical threshold of sensor-reading.
public java.lang.Integer getLowerThresholdFatal()
Gets upper fatal threshold of sensor-reading.
public java.lang.Integer getLowerThresholdNonCritical()
Gets lower non-critical threshold of sensor-reading.
public java.lang.String getRateUnits()
If the RateUnits property is set to a value other than none, the units are further qualified as rate units. For an instance that is a temperature sensor, the value is none.
public java.lang.Short[] getSettableThresholds()
An array of settable thresholds where each element(Short) in the array identifies a threshold type. An instance of this MBean, which is a temperature sensor, might return a Short array {NONCRITICAL_UPPER, CRITICAL_UPPER}. All possible thresholds modelled by this NumericSensor are declared as public constants.
public java.lang.Short[] getSupportedThresholds()
Gets supported thresholds for this system. This API provides the same information as getEnabledThresholds.
An array of supported thresholds where each element(Short) in the array identifies a threshold type. An instance of this MBean, which is a temperature sensor, might return a Short array {NONCRITICAL_UPPER, CRITICAL_UPPER, FATAL_UPPER}.
All possible thresholds modelled by this NumericSensor are declared as public constants.
public java.lang.Integer getUnitModifier()
public java.lang.Integer getUpperThresholdCritical()
Gets upper critical threshold of sensor-reading.
public java.lang.Integer getUpperThresholdFatal()
Gets upper fatal threshold of sensor-reading.
public java.lang.Integer getUpperThresholdNonCritical()
Gets the upper noncritical threshold of sensor-reading.
public void setUpperThresholdCritical(java.lang.Integer threshVal)
Sets the upper critical threshold to a new value.
threshVal- Value of temperature
public void setUpperThresholdNonCritical(java.lang.Integer threshVal)
Sets the upper noncritical threshold to a new value.
threshVal- Value of temperature.
public interface PlugInUnitMBean
AlarmCardPluginMBean,CpuPluginMBean
This class describes the management interface of the Plug-in Unit MBean.
|
setAlarmSeverityProfilePointer(javax.management.ObjectName asp) |
|
public com.sun.ctmgx.moh.AdministrativeState getAdministrativeState()
Gets the administrative state.
This function gets the current status(locked/unlocked) of this object.
The administrative state value defined as either:
com.sun.ctmgx.moh.AdministrativeState.LOCKED
com.sun.ctmgx.moh.AdministrativeState.UNLOCKED
public javax.management.ObjectName getAlarmSeverityProfilePointer()
Gets the AlarmSeverityProfile associated with this MBean.
This function gets a pointer to an instance of the Alarm Severity Profile MBean containing the severity assignments for the alarms reported by this MBean. When the returned value is null, the default alarm severity profile is used.
The ObjectName of the AlarmSeverityProfile MBean.
public com.sun.ctmgx.moh.AvailabilityStatus getAvailabilityStatus()
This function is used to get the availability status of this object. Valid values for the availability status are Available, In Test, Failed, Power Off, Not Installed, Off Line, and Dependency. This last value indicates that the plug-in unit cannot operate because some other resource on which it depends is unavailable.
One of the following availability status values:
com.sun.ctmgx.moh.AvailabilityStatus.AVAILABLE
com.sun.ctmgx.moh.AvailabilityStatus.INTEST
com.sun.ctmgx.moh.AvailabilityStatus.FAILED
com.sun.ctmgx.moh.AvailabilityStatus.POWEROFF
com.sun.ctmgx.moh.AvailabilityStatus.NOTINSTALLED
com.sun.ctmgx.moh.AvailabilityStatus.OFFLINE
com.sun.ctmgx.moh.AvailabilityStatus.DEPENDENCY
public com.sun.ctmgx.moh.OperationalState getOperationalState()
This function gets the operation state of the object. The operational state indicates whether or not the plug-in unit is capable of performing its normal functions, i.e. enabled or disabled.
One of the following operational state values:
com.sun.ctmgx.moh.OperationalState.ENABLED
com.sun.ctmgx.moh.OperationalState.DISABLED
com.sun.ctmgx.moh.OperationalState.UNKNOWN
public java.lang.String getPlugInUnitLabel()
Gets the external label string, if there is any.
The external label string of the plug-in unit.If there is no label, a null string("") is returned.
public java.lang.String getPlugInUnitType()
public java.lang.String getVendorName()
The vendor name of the plug-in unit.
public java.lang.String getVersion()
The version of the plug-in unit.
public void setAdministrativeState(com.sun.ctmgx.moh.AdministrativeState admin_state)
Sets the administrative state.
This function sets the administrative status of this object.
admin_state - The administrative state value defined as either com.sun.ctmgx.moh.AdministrativeState.LOCKED or com.sun.ctmgx.moh.AdministrativeState.UNLOCKED.
public void setAlarmSeverityProfilePointer(ObjectName asp)
Sets the AlarmSeverityProfile associated with this MBean.
This function sets the pointer attribute of this Mbean to the instance of the Alarm Severity Profile. When the setting value is null, the default alarm severity profile is used.
asp - The ObjectName of the AlarmSeverityProfile object.
public interface RnfsServiceMBean extends SoftwareServiceMBean
This class describes the interface of the Reliable Network File System (RNFS) Monitor service.
|
setDaemonList(), getName(), getNumExcessiveIntervals(), getPollingInterval(), getStatus(), setNumExcessiveIntervals(Integer), setPollingInterval(Integer), startPolling(), stopPolling() |
public java.lang.String[] getExcessiveThresholdFileSystemList()
Gets the list of RNFS exceeding threshold.
Null returned if there is no file systems exceeding threshold.
public java.lang.Float getMaxSyncThreshold()
Gets maximum synchronization threshold.
Threshold is the percentage of RNFS disk space that needs to be synchronized.
public java.lang.Float getSyncThreshold(java.lang.String rnfs)
Gets current synchronization threshhold of a RNFS.
Threshold is the percentage of RNFS disk space that needs to be synchronized.
public void setMaxSyncThreshold(java.lang.Float threshold)
Sets maximum synchronization threshold of all RNFS.
Threshold is the percentage of RNFS disk space that needs to be synchronized.
public interface SensorMBean extends EquipmentMBean
This class describes the interface for Sensor MBean. For Netra CT 410 and CT 810, only sensor type SENSOR_TYPE_TEMPERATURE is supported.
public static final java.lang.Short SENSOR_TYPE_OTHER
public static final java.lang.Short SENSOR_TYPE_TEMPERATURE
public java.lang.String getCurrentState()
The current state of the sensed property. Currently not supported.
public java.lang.String[] getPossibleStates()
Possible states the sensed property can go through. Currently not supported.
public java.lang.Short getSensorType()
Sensor type. Each sensor type is associated with a particular property of a logical/physical device, for example, a voltage sensor might sense/measure/read the voltage through a power supply unit, and a temperature sensor might do similar thing but for the temperature of the unit.
public interface SlotMBean extends EquipmentHolderMBean
This class describes the management interface of the Slot MBean.
|
Gets the ObjectName of the SoftwareLoad associated with this MBean. |
|
|
setSoftwareLoad(javax.management.ObjectName sw_load) Sets the ObjectName of the SoftwareLoad associated with this MBean. |
|
|
getEquipmentHolderAddress(), getEquipmentHolderLabel(), getEquipmentHolderType() |
public java.lang.String getAcceptablePlugInUnitTypes()
Gets the acceptable plug-in unit types.
This attribute identifies the types of plug-in units that can be supported by the slot.
The newline separated string representing the acceptable plug-in unit types.
public com.sun.ctmgx.moh.SlotStatus getSlotStatus()
This attribute provides an indication as to whether or not the slot is empty or full.
The slot status value defined as com.sun.ctmgx.moh.SlotStatus.EMPTY or com.sun.ctmgx.moh.SlotStatus.FULL.
public java.lang.String getSlotType()
This attribute identifies the type of a slot in the chassis, such as a CPCI slot, fan slot, power supply slot, rmm slot, or pmc slot.
A String that identifies a type of slot in a chassis.
public javax.mNgement.ObjectName getSoftwareLoad()
Gets the ObjectName of the SoftwareLoad associated with this MBean.
This attribute identifies the software load, if there is any, which is currently designated as the one to be loaded to the plug-in whenever an automatic reload of software is needed.
The ObjectName of the SoftwareLoad MBean.
public void setAcceptablePlugInUnitTypes(java.lang.String types)
Sets the acceptable plug-in unit types.
This attribute identifies the types of plug-in units that can be supported by the slot.
types - A newline separated string representing the acceptable plug-in unit types.
public void setSoftwareLoad(javax.management.ObjectName sw_load)
Sets the ObjectName of the SoftwareLoad associated with this MBean.
This attribute identifies the software load, if there is any, which is currently designated as the one to be loaded to the plug-in whenever an automatic reload of software is needed.
The ObjectName of the SoftwareLoad MBean.
public interface SoftwareMonitorMBean.
|
Gets a list of object names representing the software services. |
|
public static final java.lang.String ETHER_STATS_SERVICE
Ethernet Driver Statistic service name.
public static final java.lang.String ETHER_STATS_SERVICE_OBJ
Ethernet Driver Statistic service object name.
public static final java.lang.String IP_SERVICE
Internet Protocol service name.
public static final java.lang.String IP_SERVICE_OBJ
Internet Protocol service object name.
public static final java.lang.String NFS_SERVICE
Network File System service name.
public static final java.lang.String NFS_SERVICE_OBJ
Network File System service object name.
public static final java.lang.String PLATFORM_MGT_SERVICE
Platform Management service name. It is PICL on Solaris or SMF on Alarm Card.
public static final java.lang.String PLATFORM_MGT_SERVICE_OBJ
Platform Management service object name.
public static final java.lang.String TCP_SERVICE
Transport Control Protocol service name.
public static final java.lang.String TCP_SERVICE_OBJ
Transport Control Protocol service object name.
public static final java.lang.String TFTP_SERVICE
Trivial File Transfer Protocol service name.
public static final java.lang.String TFTP_SERVICE_OBJ
Trivial File Transfer Protocol service object name.
public static final java.lang.String UDP_SERVICE
User Datagram Protocol service name.
public static final java.lang.String UDP_SERVICE_OBJ
User Datagram Protocol service object name.
public static final java.lang.String UFS_SERVICE
Unix File System service name.
public static final java.lang.String UFS_SERVICE_OBJ
Unix File System service object name.
public java.util.Set getSoftwareServiceList()
Gets a list of object names representing the software services.
Set of objects of the software services. Each object contains a string representing one of the following the object names:
com.sun.ctmgx.moh.SoftwareMonitorMbean.NFS_SERVICE_OBJ
com.sun.ctmgx.moh.SoftwareMonitorMbean.UFS_SERVICE_OBJ
com.sun.ctmgx.moh.SoftwareMonitorMbean.TCP_SERVICE_OBJ
com.sun.ctmgx.moh.SoftwareMonitorMbean.UDP_SERVICE_OBJ
com.sun.ctmgx.moh.SoftwareMonitorMbean.IP_SERVICE_OBJ
com.sun.ctmgx.moh.SoftwareMonitorMbean.TFTP_SERVICE_OBJ
com.sun.ctmgx.moh.SoftwareMonitorMbean.ETHER_STATS_SERVICE_OBJ
com.sun.ctmgx.moh.SoftwareMonitorMbean.PLATFORM_MGT_SERVICE_OBJ
public interface SoftwareServiceMBean
CgtpServiceMBean, EtherIfStatsMBean,IpServiceMBean, NfsServiceMBean, RnfsServiceMBean, TcpServiceMBean, UdpServiceMBean,UfsServiceMBean
This class describes the interface of Software Service MBean.
This is the base class from which all software services are derived.
Software services in the systems such as NFS, NIS, CGTP, etc. are modeled via MOH software modules. Each software module represents a service.
The software modules of MOH running on host CPU and satellite CPU monitor the software services in the system. Software services can be a software sub-system such as network stacks (TCP, UDP, IP), or I/O drivers such as Ethernet drivers, or processes or daemons such as NFS, UFS, TFTP, reliable NFS, etc.
In general, a service contains two parts: The daemon monitor part and the statistic part. The daemon monitor part deals with the installed/not installed, and running/not running status of a daemon. The statistic part deals with error count, error thresholds, polling, etc. Not all of the services contain two parts, since some services might not be implemented as daemons.
public javax.management.ObjectName() getDaemonList()
Gets the list of daemons supporting the service.
The list of object name of DaemonMbean(s). Each object name is defined as com.sun.ctmgx.moh.SoftwareMonitorMbean."softwareservice name"."daemon name"
public java.lang.String getName()
Gets the name of the service. All of available services are defined in this method.
The name of the service defined as one of the following:
com.sun.ctmgx.moh.SoftwareMonitorMbean.NFS_SERVICE
com.sun.ctmgx.moh.SoftwareMonitorMbean.UFS_SERVICE
com.sun.ctmgx.moh.SoftwareMonitorMbean.TCP_SERVICE
com.sun.ctmgx.moh.SoftwareMonitorMbean.UDP_SERVICE
com.sun.ctmgx.moh.SoftwareMonitorMbean.IP_SERVICE
com.sun.ctmgx.moh.SoftwareMonitorMbean.TFTP_SERVICE
com.sun.ctmgx.moh.SoftwareMonitorMbean.ETHER_STATS_SERVICE
or string("") if there is none.
public java.lang.Integer getNumExcessiveIntervals()
Gets the number of excessive intervals that the service exceeds error threshold.
This excessive polling interval threshold indicates the maximum number of consecutive polling intervals that the corresponding service exceeds the maximum allowable threshold before an error event is generated.
The number of excessive intervals.
public java.lang.Integer getPollingInterval()
Gets polling interval of the service.
The polling interval indicates how often the service is polled for status.
The polling interval in millisecond. The default is 15 minutes.
public java.lang.String getStatus()
The status of the service defined as string("up"), or string("down").
public void setNumExcessiveIntervals(java.lang.Integer numExcessiveIntervals)
Sets the number of configured polling intervals threshold or number of excessive intervals that the service exceeds error threshold.
This excessive polling interval threshold indicates the maximum number of consecutive polling intervals that the corresponding service exceeds the maximum allowable threshold before an error event is generated.
numExcessiveIntervals - interval threshold to set. The default of this threshold is 1.
public void setPollingInterval(java.lang.Integer milliSecs)
Sets polling interval of the service. The polling interval indicates how often the service is polled for status.
milliSecs- polling interval to set. The default is 15 minutes. The minimum interval is 15 seconds.
public interface TcpServiceMBean extends SoftwareServiceMBean
This class describes the interface of Unix File System (UFS) service.
|
getDaemonList(), getName(), getNumExcessiveIntervals(), getPollingInterval(), getStatus(), setNumExcessiveIntervals(Integer), setPollingInterval(Integer), startPolling(), stopPolling() |
public java.lang.Float getCurrentInErrorThreshold()
Gets the current threshold of segments received in error.
The threshold in percentage of number of errors over the total received segments of the current polling interval.
public java.lang.Float getCurrentOutRstsThreshold()
Gets the current threshold of segments sent with RST flag.
The threshold in percentage of number of errors over the total sent segments of the current polling interval.
public java.lang.Float getMaxInErrorThreshold()
Gets the maximum threshold of segments received in error.I
The configured threshold in percentage of number of errors over the total received segments of the current polling interval.
public java.lang.Float getMaxOutRstsThreshold()
Gets the maximum threshold of segments sent with RST flag.
The max threshold in percentage of number of errors over the total received segments of the current polling interval.
public void setMaxInErrorThreshold(java.lang.Float newThreshold)
Sets the maximum threshold of segments received in error. If the threshold exceeds a number of configured consecutive intervals, a notification of class AttributeChangeNotification is sent to the clients for the change of attribute "CurrentInErrorThreshold".
newThreshold - maximum threshold to set.
public void setMaxOutRstsThreshold(java.lang.Float newThreshold)
Sets the maximum threshold of segments sent with RST flag. If the threshold exceeds a number of configured consecutive intervals, a notification of class AttributeChangeNotification is sent to the clients for the change of attribute CurrentOutRstsThreshold.
newThreshold - maximum threshold to set.
public interface TerminationPointMBean
This class describes the management interface of the Termination Point MBean.
|
getAlarmSeverityProfilePointer() Gets the ObjectName of the AlarmSeverityProfile associated with this MBean. |
|
public com.sun.ctmgx.moh.AdministrativeState getAdministrativeState()
Gets the administrative state.
This attribute is used to activate (unlocked) and deactivate (locked) the function performed by the physical path termination point.
The administrative state value defined as either
com.sun.ctmgx.moh.AdministrativeState.LOCKED or
com.sun.ctmgx.moh.AdministrativeState.UNLOCKED
public javax.management.ObjectName getAlarmSeverityProfilePointer()
Gets the ObjectName of the AlarmSeverityProfile associated with this MBean.
This attribute provides a pointer to the instance of the Alarm Severity Assignment Profile MBean that contains the severity assignments for the alarms reported by this MBean. When the value of this attribute is set to null, default severity assignmentsare used.
The ObjectName of the AlarmSeverityProfile MBean.
public com.sun.ctmgx.moh.OperationalState getOperationalState()
This attribute identifies whether or not the physical path termination point is capable of performing its normal functions, that is, enabled or disabled.
One of the following operational state values:
com.sun.ctmgx.moh.OperationalState.ENABLED
com.sun.ctmgx.moh.OperationalState.DISABLED
com.sun.ctmgx.moh.OperationalState.UNKNOWN
public java.lang.String getPhysicalPathType()
This attribute identifies the type of physical path being terminated (for example DS1, DS3, SONET STS-3c, or Ethernet).
This attribute identifies the port on the line card where the physical path terminates.
public java.lang.String getPortLabel()
This attribute provides the external label string of this physical path termination point object.
public void setAdministrativeState(com.sun.ctmgx.moh.AdministrativeState admin_state)
Sets the administrative state.
This attribute is used to activate (unlocked) and deactivate (locked) the function performed by the physical path termination point.
admin_state - The administrative state value defined as either:
com.sun.ctmgx.moh.AdministrativeState.LOCKED
com.sun.ctmgx.moh.AdministrativeState.UNLOCKED
public void setAlarmSeverityProfilePointer(ObjectName asp)
Sets the ObjectName of the AlarmSeverityProfile associated with this MBean.
This attribute provides a pointer to the instance of the Alarm Severity Assignment Profile MBean that contains the severity assignments for the alarms reported by this MBean. When the value of this attribute is set to null, default severity assignments are used.
asp - The ObjectName of the AlarmSeverityProfile MBean.
public interface UdpServiceMBean extends SoftwareServiceMBean
This class describes the interface of Unix File System (UFS) service.
|
getDaemonList(), getName(), getNumExcessiveIntervals(), getPollingInterval(), getStatus(), setNumExcessiveIntervals(Integer), setPollingInterval(Integer), startPolling(), stopPolling() |
public java.lang.Float getCurrentInErrorThreshold()
Gets the current threshold of received UDP datagrams that could not be delivered for reasons other than the lack of an application at the destination port.
The threshold in percentage of number of errors over the total receiving datagrams of the current polling interval.
public java.lang.Float getMaxInErrorThreshold()
Gets the maximum threshold of received UDP datagrams that could not be delivered for reasons other than the lack of an application at the destination port.
The maximum threshold in percentage.
public void setMaxInErrorThreshold(java.lang.Float newThreshold)
Sets the maximum threshold of received UDP datagrams that could not be delivered for reasons other than the lack of an application at the destination port.
newThreshold - maximum threshold to set.
public interface UfsServiceMBean extends SoftwareServiceMBean
This class describes the interface of UfsService class.
|
getDaemonList(), getName(), getNumExcessiveIntervals(), getPollingInterval(), getStatus(), setNumExcessiveIntervals(Integer), setPollingInterval(Integer), startPolling(), stopPolling() |
public java.lang.String[] getExcessiveThreshHoldFileSystemList()
Gets the list of file systems exceeding threshold.
Null is returned if there is no file systems exceeding threshold.
public java.lang.Float getFileSystemMaxThreshHold()
Gets the threshold percentage usage of the file system.
public void setFileSystemMaxThreshHold(java.lang.Float threshHold)
Sets the threshold percentage usage of the file system.
threshHold-maximum threshold to set.
This section contains descriptions of the following management agent classes:
public class AdministrativeState extends java.lang.Object implements java.io.Serializable
java.lang.Object
|
+--com.sun.ctmgx.moh.AdministrativeState
This class defines the administrative states of an object. Currently, for Netra CT 410, and CT 810, there is no implementation in MOH to perform lockout processing based on this state.
public static final com.sun.ctmgx.moh.AdministrativeState LOCKED
Indicates the related object is in-use or busy performing a function.
public static final com.sun.ctmgx.moh.AdministrativeState UNLOCKED
Indicates the related object is not in-use or not busy performing a function.
public Boolean equals(java.lang.Object obj)
public java.lang.String toString()
public class AlarmNotification extends com.sun.ctmgx.moh.AlarmNotification
java.lang.Object
|
+--java.util.EventObject
|
+--javax.management.Notification
|
+--com.sun.ctmgx.moh.AlarmNotification
The Alarm Notification class represents an alarm notification emitted by an MBean. This notification is used to notify the management system when a failure has been detected or cleared.
It contains a reference to the source MBean: if the notification has been forwarded through the MBean server, this is the object name of the MBean. If the listener has registered directly with the MBean, this is a direct reference to the MBean.
public AlarmNotification(com.sun.ctmgx.moh.AlarmType alarmType, java.lang.Object source, long sequenceNumber, java.lang.String message, com.sun.ctmgx.moh.AlarmSeverity perceivedSeverity, java.lang.String specificProblems, Boolean backedUpStatus, java.management.ObjectName backUpObject, java.lang.String proposedRepairActions, java.util.Set failedSwitchComponentList)
Constructs an alarm notification object.
alarmType - one of the predefined AlarmType instances.
source - The notification source, that is, the MBean that emits the notification.
sequenceNumber - The notification sequence number within the source object.
message - A String containing the message of the notification.
specificProblems - Indicates further refinements to the problem identified by the alarm type.
perceivedSeverity - One of the perceived severity values in the com.sun.ctmgx.moh.AlarmSeverity class.
backedUpStatus - A Boolean indication as to whether or not the failed entity has been backed-up.
backUpObject - The ObjectName of the MBean providing back-up services to the failed entity.
proposedRepairActions - Indicates proposed repair actions for the problem identified by the alarm.
failedSwitchComponentList - A set of failed (or possibly failed) components associated with this alarm identified by their ObjectName.
public com.sun.ctmgx.moh.AlarmType getAlarmType()
public Boolean getBackedUpStatus()
If the value of this object is true, the agent reported in this notification that the failed object had been backed up.
public javax.management.ObjectName getBackUpObject()
Indicates the object that provided back-up services to the failed object.
The ObjectName of the back-up object.
public java.util.Set getFailedSwitchComponentList()
Gets the list of failed switch components.
The list of failed switch components.
public com.sun.ctmgx.moh.AlarmSeverity getPerceivedSeverity()
Gets the perceived severity of the alarm.
One of the constants for perceived severity defined in the class com.sun.ctmgx.moh.AlarmSeverity.
public java.lang.String getProposedRepairActions()
Gets the proposed repair actions.
Indicates proposed repair actions reported by the agent for the problem identified by the alarm. If more than one action is described in this object, the problem descriptions are separated by newline characters.
public java.lang.String getSpecificProblems()
Gets the specific problems of the alarm.
Indicates further refinements to the problem identified by the alarm type. If more than one specific problem is described in this object, the problem descriptions are separated by newline characters.
The specific problems of the alarm.
public class AlarmNotificationFilter implements java.io.Serializable
java.lang.Object
|
+--com.sun.ctmgx.moh.AlarmNotificationFilter
javax.management.NotificationFilter,java.io.Serializable
This class describes the filtering of AlarmNotification notifications by selecting the types and severities of interest.
It manages a list of enabled types and severities for which notifications should be sent. Methods in this class allow users to enable/disable (allow/disallow of notifications based on severities and types) as many types and severities as required.
|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
public AlarmNotificationFilter()
public void disableAlarmType(com.sun.ctmgx.moh.AlarmType type)
Disables a specific alarm type. To disable a specific Alarm type. If all alarm types are enabled through an enableAllAlarmTypes() call, this call will not have any effect.
public void disableAllAlarmTypes()
Disables all alarm types. This method disables all enabled Alarm types as well as the effect of the enableAllAlarmTypes() call.
public void disableAllSeverities()
Disables all the severities that were enabled.
public void disableSeverity(com.sun.ctmgx.moh.AlarmSeverity severity)
Disables a specific severity type. Remove a severity for which you are no longer interested in receiving notifications.
severity - The severity value.
public void enableAlarmType(com.sun.ctmgx.moh.AlarmType type)
This enables a specific Alarm type. If all Alarm types are already enabled through the enableAllAlarmTypes() call, then type is also already enabled. In this case, to enable just a specific Alarm type, disableAllAlarmTypes() call has to be performed first and then this method can be invoked.
public void enableAllAlarmTypes()
Enables all alarm types.This will enable all kinds of Alarm. This call enables the notifications with the type string that have a prefix of AlarmType.ALARM_TYPE_PREFIX, for example netract.moh.alarm.
public void enableSeverity(com.sun.ctmgx.moh.AlarmSeverity severity)
throws IllegalArgumentException
Adds a severity for which you are interested in receiving notifications.
severity - The severity value.
java.lang.IllegalArgumentException
public java.util.Vector getEnabledAlarmTypes()
Gets the alarm types currently enabled.
A vector of strings representing alarm types.
public java.util.Vector getEnabledSeverities()
Gets the list of enabled severities for this filter.
The list containing the severities for which notifications should be sent.
public Boolean isNotificationEnabled(javax.management.Notification notification)
Queries whether notification is needed. This method is invoked before sending the specified notification to the listener.
This filter compares the type and severity of the specified alarm notification with each enabled type and severity. If the type equals one of the enabled types and the severity equals one of the enabled severities, the notification must be sent to the listener so this method returns true.
notification - The alarm notification to be sent.
true if the notification has to be sent to the listener, false otherwise.
public class AlarmSeverity implements java.io.Serializable
+--com.sun.ctmgx.moh.AlarmSeverity
This class defines the alarm severity objects for use with alarm notification.
public static final com.sun.ctmgx.moh.AlarmSeverity CLEARED
Indicates the alarm condition is clear.
public static final com.sun.ctmgx.moh.AlarmSeverity CRITICAL
Indicates the alarm is critical.
public static final com.sun.ctmgx.moh.AlarmSeverity INDETERMINATE
Indicates the alarm condition is indeterminate.
public static final com.sun.ctmgx.moh.AlarmSeverity MAJOR
public static final com.sun.ctmgx.moh.AlarmSeverity MINOR
public static final com.sun.ctmgx.moh.AlarmSeverity WARNING
Indicates the alarm is a warning
public Boolean equals(java.lang.Object obj)
public java.lang.String toString()
public class AlarmType extends jaba.lang.Object implements java.io.Serializable
java.lang.Object
|
+--com.sun.ctmgx.moh.AlarmType
This class is an enumeration of predefined Alarm types; the user needs to use one of the predefined types to construct an AlarmNotification object.
|
Alarm type that indicates a high physical memory utilization alarm. |
|
public static final com.sun.ctmgx.moh.AlarmType FAN_FAILURE
Alarm type that indicates a fan failure alarm.
public static final com.sun.ctmgx.moh.AlarmType FUSE_FAILURE
Alarm type that indicates a fuse failure alarm.
public static final com.sun.ctmgx.moh.AlarmType HIGH_MEMORY_UTILIZATION
Alarm type that indicates a high physical memory utilization alarm.
public static final com.sun.ctmgx.moh.AlarmType HIGH_TEMPERATURE
Alarm type that indicates a high temperature alarm.
public Boolean equals(java.lang.Object obj)
public java.lang.String toString()
public class AttributeChangeNotification extends javax.management.AttributeChangeNotification
java.lang.Object
|
+--java.util.EventObject
|
+--javax.management.Notification
|
+--javax.management.AttributeChangeNotification
|
+--com.sun.ctmgx.moh.AttributeChangeNotification
This class defines definitions of the attribute change notifications sent by MBeans.
It is up to the MBean owning the attribute of interest to create and send attribute change notifications when the attribute change occurs, so the NotificationBroadcaster interface has to be implemented by any MBean interested in sending attribute change notifications.
|
clone(), equals(Object), finalize(), getClass(), hashCode(), notify(), notifyAll(), toString(), wait(), wait(), wait() |
public static final java.lang.String ATTRIBUTE_CHANGE
Notification type that indicates that the observed MBean attribute value has changed.
The value of this type string is netract.moh.attribute.change.
public AttributeChangeNotification(java.lang.Object source, long sequenceNumber, java.lang.String message, java.lang.String attributeName, java.lang.String attributeType, java.lang.Object oldValue, java.lang.Object newValue)
Construct an attribute change notification object whose type string is netract.moh.attribute.change. In addition to the information common to all notifications, the caller must supply the name and type of the attribute, as well as its old and new values.
source - The notification source, that is, the MBean that emits the notification.
sequenceNumber - The notification sequence number within the source object.
message - A String containing the message of the notification.
attributeName - A String specifying the name of the attribute.
attributeType - A String specifying the type of the attribute.
oldValue - An object representing the value of the attribute before the change.
newValue - An object representing the value of the attribute after the change.
public java.lang.String getType()
getType in class javax.management.Notification
ATTRIBUTE_CHANGE. The method of javax.management.Notification is overridden to return ATTRIBUTE_CHANGE.
public class AttributeChangeNotificationFilter extends javax.management.AttributeChangeNotificationFilter
java.lang.Object
|
+--javax.management.AttributeChangeNotificationFilter
|
+--com.sun.ctmgx.moh.AttributeChangeNotificationFilter
javax.management.NotificationFilter, java.io.Serializable
This class describes the filtering performed on the name of the observed attribute.
It manages a list of enabled attributes for which notifications should be sent when their attribute changes. A method in this class allows users to decide whether notifications should be sent for attribute changes.
|
isNotificationEnabled(Notification notification) This method is invoked before sending the specified notification to the listener. |
|
public AttributeChangeNotificationFilter()
public Boolean isNotificationEnabled(javax.management.Notification notification)
This method is invoked before sending the specified notification to the listener.
This filter compares the attribute name of the specified attribute change notification with each enabled attribute name. If the attribute name equals one of the enabled attribute names, the notification must be sent to the listener so this method returns true.
notification - The attribute change notification to be sent.
true if the notification has to be sent to the listener, false otherwise.
public class AuthClient extends java.lang.Object
java.lang.Object
|
+--com.sun.ctmgx.moh.AuthClient
This class defines the client utility routines, particularly for authentication.
|
setAuthInfo(com.sun.jdmk.comm.RmiConnectorClient client, java.lang.String user, java.lang.String passwd) |
|
|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
public static void
setAuthInfo(com.sun.jdmk.comm.RmiConnectorClient client, java.lang.String user, java.lang.String passwd)
Set the authentication information for a Connector client.
client - an instance of RmiConnectorClient.
user - The username which is the same as the user configured on the Alarm card.
passwd - The password as configured on the Alarm card for the username.
public class AvailabilityStatus extends java.lang.Object implements java.io.Serializable
java.lang.Object
|
+--com.sun.ctmgx.moh.AvailabilityStatus
This class defines the availability status for a plug-in unit object.
|
This class defines the availability status for a plug-in unit object. |
|
public static final com.sun.ctmgx.moh.AvailabilityStatus AVAILABLE
Indicates the object is capable of performing its normal function.
public static final com.sun.ctmgx.moh.AvailabilityStatus DEPENDENCY
Indicates the object is in dependency state.
public static final com.sun.ctmgx.moh.AvailabilityStatus FAILED
Indicates the object is in failed state.
public static final com.sun.ctmgx.moh.AvailabilityStatus INTEST
Indicates the object is under test.
public static final com.sun.ctmgx.moh.AvailabilityStatus NOTINSTALLED
Indicates the object is not properly configured
public static final com.sun.ctmgx.moh.AvailabilityStatus OFFLINE
Indicates the object is in offline state.
public static final com.sun.ctmgx.moh.AvailabilityStatus POWEROFF
Indicates the object is in power off state.
public static final com.sun.ctmgx.moh.AvailabilityStatus UNKNOWN
Indicates the object is unknown.
public Boolean equals(java.lang.Object obj)
public java.lang.String toString()
public class EquipmentHolderType extends java.lang.Object implements java.io.Serializable
java.lang.Object
|
+--com.sun.ctmgx.moh.EquipmentHolderType
public static final com.sun.ctmgx.moh.EquipmentHolderType DRAWER
This type is currently not supported in Netra CT 410/810.
public static final com.sun.ctmgx.moh.EquipmentHolderType RACK
This type is currently not supported in Netra CT 410/810.
public static final com.sun.ctmgx.moh.EquipmentHolderType SHELF
This type is currently not supported in Netra CT 410/810.
public static final com.sun.ctmgx.moh.EquipmentHolderType SLOT
Holder type SLOT such as disk slot, fan slot, power supply slot, or CPCI slots.
public Boolean equals(java.lang.Object obj)
public java.lang.String toString()
public class LogFullAction extends java.lang.Object implements java.io.Serializable
java.lang.Object
|
+--com.sun.ctmgx.moh.LogFullAction
This class describes the action to perform when the log is full. For Netra CT 410/CT 810, this class is not supported.
public static final LogFullAction HALT
public static final LogFullAction WRAP
public java.lang.String toString()
Overrides: toString in class java.lang.Object
public class MohNames extends java.lang.Object
java.lang.Object
|
+--com.sun.ctmgx.moh.MohNames
This class defines the public constants and static variables for MOH user to communicate to the MBean server. For example:
|
equals(Object), getClass(), hashCode(), notify(), notifyAll(), toString(), wait(), wait(), wait() |
public static final java.lang.String CLASS_NAME_ASP
AlarmSeverityProfile Class Name.
public static final java.lang.String CLASS_NAME_EFD
public static final java.lang.String CLASS_NAME_SOFTWAREMONITOR
public static final java.lang.String DESCR_ALARM
Notification Description: AlarmNotification
public static final java.lang.String DESCR_ATTRIBUTE_CHANGE
Notification Description: AttributeChangeNotification
public static final java.lang.String DESCR_OBJECT_CREATION
Notification Description: ObjectCreationNotification
public static final java.lang.String DESCR_OBJECT_DELETION
Notification Description: ObjectDeletionNotification
public static final java.lang.String DESCR_STATE_CHANGE
Notification Description: StateChangeNotification
public static javax.management.ObjectName MOH_CONTAINMENT_TREE
The object name of the only instance of ContainmentTreeMBean. The value is DOMAIN + ":name=ContainmentTree"
public static javax.management.ObjectName MOH_DEFAULT_ASP
The object name used by the MOH implementation for registering the default Alarm Severity Profile MBean. The value is DOMAIN + ":name=AlarmSeverityProfile,id=0".
public static javax.management.ObjectName MOH_DEFAULT_EFD
The object name used by the MOH implementation for registering the default EFD MBean.
The value is DOMAIN + ":name=EFD".
public static ObjectName MOH_SOFTWARE_MONITOR
The object name used by the MOH implementation for registering the Software Monitor MBean. The value is DOMAIN + ":name=softwaremonitor".
public class ObjectCreationNotification extends TopologyChangeNotification
java.lang.Object
|
+--java.util.EventObject
|
+--javax.management.Notification
|
+--com.sun.ctmgx.moh.TopologyChangeNotification
|
+--com.sun.ctmgx.moh.ObjectCreationNotification
This class defines the creation notifications sent by MBeans.
It is up to the parent MBean, which creates the child MBean, to send the object creation notification, so the NotificationBroadcaster interface has to be implemented by the parent MBean.
public static final java.lang.String OBJECT_CREATION
Notification type denoting that an MBean has been created.
The value of this type string is netract.moh.object.creation.
public ObjectCreationNotification(java.lang.Object source, long sequenceNumber, java.lang.String message, javax.management.ObjectName child, javax.management.ObjectName parent)
Creates an ObjectCreationNotification object specifying the object names of the created MBean and the parent of the created MBean in the containment hierarchy.
source - The notification source, that is, the MBean that emits the notification.
sequenceNumber - The notification sequence number within the source object.
message - A String containing the message of the notification.
child - The object name of the created MBean, that is, the child MBean in the containment hierarchy.
parent - The object name of the parent MBean in the containment hierarchy.
public javax.management.ObjectName getChildMBeanName()
Gets the object name of the created or deleted MBean.
The ObjectName of the created or deleted MBean.
public javax.management.ObjectName getParentMBeanName()
Gets the object name of the parent of the created/deleted MBean in the containment hierarchy.
The ObjectName of the parent MBean.
public class ObjectDeletionNotification extends TopologyChangeNotification
java.lang.Object
|
+--java.util.EventObject
|
+--javax.management.Notification
|
+--com.sun.ctmgx.moh.TopologyChangeNotification
|
+-com.sun.ctmgx.moh.ObjectDeletionNotification
This class defines the deletion notifications sent by MBeans.
public static final java.lang.String OBJECT_DELETION
Notification type denoting that an MBean has been deleted.
The value of this type string is netract.moh.object.deletion.
public ObjectDeletionNotification(java.lang.Object source, long sequenceNumber, java.lang.String message, javax.management.ObjectName child, javax.management.ObjectName parent)
Creates an ObjectDeletionNotification object specifying the object names of the deleted MBean and the parent of the deleted MBean in the containment hierarchy.
source - The notification source, that is, the MBean that emits the notification.
sequenceNumber - The notification sequence number within the source object.
message - A String containing the message of the notification.
child - The object name of the deleted MBean, that is, the child MBean in the containment hierarchy.
parent - The object name of the parent MBean in the containment hierarchy.
public javax.management.ObjectName getChildMBeanName()
Gets the object name of the created or deleted MBean.
The ObjectName of the created or deleted MBean.
public javax.management.ObjectName getParentMBeanName()
Gets the object name of the parent of the created or deleted MBean in the containment hierarchy.
The ObjectName of the parent MBean.
public class OperationalState extends java.lang.Object implements java.io.Serializable
java.lang.Object
|
+--com.sun.ctmgx.moh.OperationalState
This class defines the operational states of a device (equipment or plug-in):
public static final com.sun.ctmgx.moh.OperationalState DISABLED
Device is incapable of performing its normal function.
public static final com.sun.ctmgx.moh.OperationalState ENABLED
Device is capable of performing its normal function.
public static final com.sun.ctmgx.moh.OperationalState UNKNOWN
State of this device cannot be determined.
public Boolean equals(java.lang.Object obj)
public java.lang.String toString()
Overrides: toString in class Object
public class SlotStatus extends java.lang.Objec implements java.io.Serializable
java.lang.Object
|
+--com.sun.ctmgx.moh.SlotStatus
This class defines the status of the slot object.
public static final com.sun.ctmgx.moh.SlotStatus EMPTY
No card or device is plugged into this slot.
public static final com.sun.ctmgx.moh.SlotStatus FULL
There is a card or device plugged into this slot.
public Boolean equals(java.lang.Object obj)
public java.lang.String toString()
public class StateChangeNotification extends javax.management.AttributeChangeNotification
java.lang.Object
|
+--java.util.EventObject
|
+--javax.management.Notification
|
+--javax.management.AttributeChangeNotification
|
+--com.sun.ctmgx.moh.StateChangeNotification
This class defines the state change notifications sent by MBeans.
It is up to the MBean owning the state attribute of interest to create and send state change notifications when the state attribute change occurs, so the NotificationBroadcaster interface has to be implemented by any MBean interested in sending state change notifications.
public static final java.lang.String STATE_CHANGE
Notification type which indicates that the observed MBean state attribute value has changed.
The value of this type string is netract.moh.state.change.
public StateChangeNotification(java.lang.Object source, long sequenceNumber, java.lang.String message, java.lang.String attributeName, java.lang.String attributeType, java.lang.Object oldValue, java.lang.Object newValue)
Constructs a state change notification object whose type string is netract.moh.state.change. In addition to the information common to all notifications, the caller must supply the name and type of the attribute, as well as the attribute's old and new values.
source - The notification source, that is, the MBean that emits the notification.
sequenceNumber - The notification sequence number within the source object.
message - A String containing the message of the notification.
attributeName - A String specifying the name of the state attribute.
attributeType - A String specifying the type of the state attribute.
oldValue - An object representing the value of the state attribute before the change.
newValue - An object representing the value of the state attribute after the change.
public java.lang.String getType()
Gets notification type. The method of javax.management.Notification is overridden to return STATE_CHANGE.
getType in class javax.management.Notification
public class StateChangeNotificationFilter extends javax.management.AttributeChangeNotificationFilter
java.lang.Object
|
+--javax.management.AttributeChangeNotificationFilter
|
+--com.sun.ctmgx.moh.StateChangeNotificationFilter
javax.management.NotificationFilter, java.io.Serializable
This class describes the filtering performed on the name of the observed attribute.
It manages a list of enabled attributes for which notifications should be sent when their attribute changes. A method of this class allows users to enable or disable (allow or disallow notifications to be sent) as many attribute names as required.
|
isNotificationEnabled(javax.management.Notification notification) This method is invoked before sending the specified notification to the listener. |
|
public StateChangeNotificationFilter()
public Boolean isNotificationEnabled(javax.management.Notification notification)
This method is invoked before sending the specified notification to the listener.
This filter compares the state attribute name of the specified state change notification with each enabled attribute name. If the attribute name equals one of the enabled attribute names, the notification must be sent to the listener so this method returns true.
isNotificationEnabled in class javax.management.AttributeChangeNotificationFilter
notification - The attribute change notification to be sent.
true if the notification has to be sent to the listener, false otherwise.
| Netra CT Server Software Developer's Guide | 816-2486-11 |
|
Copyright © 2004, Sun Microsystems, Inc. All rights reserved.