com.sun.corba.se.spi.monitoring

Interface MonitoredObject

All Known Implementing Classes:

MonitoredObjectImpl

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.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(MonitoredAttribute value) Adds the attribute with the given name.
void	addChild(MonitoredObject m) This method will add a child Monitored Object to this Monitored Object.
void	clearState() Clears the state of all the Monitored Attributes associated with the Monitored Object.
MonitoredAttribute	getAttribute(String name) Gets the Monitored Object registered by the given name
Collection	getAttributes() Gets all the Monitored Attributes for this Monitored Objects.
MonitoredObject	getChild(String name) Gets the child MonitoredObject associated with this MonitoredObject instance using name as the key.
Collection	getChildren() Gets all the Children registered under this instance of Monitored Object.
String	getDescription() Gets the description of MonitoredObject
String	getName() Gets the name of this MonitoredObject
MonitoredObject	getParent() 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.
void	removeAttribute(String name) Removes the attribute with the given name.
void	removeChild(String name) This method will remove child Monitored Object identified by the given name
void	setParent(MonitoredObject m) Sets the parent for this Monitored Object.

Method Detail

getName

String getName()

Gets the name of this MonitoredObject

Returns:

a String with name of this Monitored Object

getDescription

String getDescription()

Gets the description of MonitoredObject

Returns:

a String with Monitored Object Description.

addChild

void addChild(MonitoredObject m)

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

removeChild

void removeChild(String name)

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

Parameters:

name - of the ChildMonitored Object

getChild

MonitoredObject getChild(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

Parameters:

name - of the ChildMonitored Object

Returns:

a MonitoredObject identified by the given name

getChildren

Collection getChildren()

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

Returns:

Collection of immediate Children associated with this MonitoredObject.

setParent

void setParent(MonitoredObject m)

Sets the parent for this Monitored Object.

getParent

MonitoredObject getParent()

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.

Returns:

a MonitoredObject which is a Parent of this Monitored Object instance

addAttribute

void addAttribute(MonitoredAttribute value)

Adds the attribute with the given name.

Parameters:

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

removeAttribute

void removeAttribute(String name)

Removes the attribute with the given name.

Parameters:

name - is the MonitoredAttribute name

getAttribute

MonitoredAttribute getAttribute(String name)

Gets the Monitored Object registered by the given name

Parameters:

name - of the attribute

Returns:

a MonitoredAttribute identified by the given name

getAttributes

Collection getAttributes()

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.

Returns:

Collection of all the Attributes for this MonitoredObject

clearState

void clearState()

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.