FileDocCategorySizeDatePackage
MonitoredObject.javaAPI DocJava SE 5 API3883Fri Aug 26 14:54:38 BST 2005com.sun.corba.se.spi.monitoring

MonitoredObject

public interface MonitoredObject

author
Hemanth Puttaswamy

Monitored Object provides an Hierarchichal view of the ORB Monitoring System. It can contain multiple children and a single parent. Each Monitored Object may also contain Multiple Monitored Attributes.

Fields Summary
Constructors Summary
Methods Summary
public voidaddAttribute(com.sun.corba.se.spi.monitoring.MonitoredAttribute value)

Adds the attribute with the given name.

param
value is the MonitoredAttribute which will be set as one of the attribute of this MonitoredObject.

public voidaddChild(com.sun.corba.se.spi.monitoring.MonitoredObject m)

This method will add a child Monitored Object to this Monitored Object.

public voidclearState()

Clears the state of all the Monitored Attributes associated with the Monitored Object. It will also clear the state on all it's child Monitored Object. The call to clearState will be initiated from CORBAMBean.startMonitoring() call.

public com.sun.corba.se.spi.monitoring.MonitoredAttributegetAttribute(java.lang.String name)

Gets the Monitored Object registered by the given name

return
a MonitoredAttribute identified by the given name

param
name of the attribute

public java.util.CollectiongetAttributes()

Gets all the Monitored Attributes for this Monitored Objects. It doesn't include the Child Monitored Object, that needs to be traversed using getChild() or getChildren() call.

return
Collection of all the Attributes for this MonitoredObject

public com.sun.corba.se.spi.monitoring.MonitoredObjectgetChild(java.lang.String name)

Gets the child MonitoredObject associated with this MonitoredObject instance using name as the key. The name should be fully qualified name like orb.connectionmanager

return
a MonitoredObject identified by the given name

param
name of the ChildMonitored Object

public java.util.CollectiongetChildren()

Gets all the Children registered under this instance of Monitored Object.

return
Collection of immediate Children associated with this MonitoredObject.

public java.lang.StringgetDescription()

Gets the description of MonitoredObject

return
a String with Monitored Object Description.

public java.lang.StringgetName()

Gets the name of this MonitoredObject

return
a String with name of this Monitored Object

public com.sun.corba.se.spi.monitoring.MonitoredObjectgetParent()

There will be only one parent for an instance of MontoredObject, this call gets parent and returns null if the Monitored Object is the root.

return
a MonitoredObject which is a Parent of this Monitored Object instance

public voidremoveAttribute(java.lang.String name)

Removes the attribute with the given name.

param
name is the MonitoredAttribute name

public voidremoveChild(java.lang.String name)

This method will remove child Monitored Object identified by the given name

param
name of the ChildMonitored Object

public voidsetParent(com.sun.corba.se.spi.monitoring.MonitoredObject m)

Sets the parent for this Monitored Object.