com.tivoli.twg.monlet
Interface Monlet


public interface Monlet

This class defines the interface implemented by monitor agent extensions (monlets) to add a node tree under the root node of the Director monitor agent.


Field Summary
static java.lang.String MONLET_ROOT_NAME_PROPERTY
           
 
Method Summary
 void GetDefaultThresholdPaths(java.util.Vector progNames, java.util.Vector dispNames, java.util.Locale locale)
          Get programmatic and display paths for all supported default thresholds
 void MonletAssignHandle(java.util.Vector path, int handle)
          Assign handle to attribute specified by node path and activate it for monitoring (open any internal resources needed for monitoring it)
 java.lang.Object MonletGetData(int handle)
          Get data for attribute specified by handle
 MonletAttrMetaData MonletGetMetaData(int handle)
          Get metadata for attribute specified by handle
 MonletAttributeNode[] MonletGetNodes(java.util.Vector path, java.util.Locale locale)
          Get children nodes of node specified by path
 MonletIndepCmd MonletIndepCmd(TWGMonPath path, MonletIndepCmd iCmd)
          Pass an Independent Command (byte blob) down to the monlet.
 void MonletReleaseHandle(int handle)
          Release handle of an active attribute and deactivate it for monitoring (release any internal resource needed for monitoring it)
 

Field Detail

MONLET_ROOT_NAME_PROPERTY

public static final java.lang.String MONLET_ROOT_NAME_PROPERTY
See Also:
Constant Field Values
Method Detail

MonletGetNodes

public MonletAttributeNode[] MonletGetNodes(java.util.Vector path,
                                            java.util.Locale locale)
                                     throws MonletException
Get children nodes of node specified by path

Parameters:
path - Vector of node names forming a path to a specific node
locale - the Locale for translation of returned child nodes
Returns:
MonletAttributeNode[] array of child nodes directly under node specified by path
Throws:
MonletException - if failed to find node or children of specified node

GetDefaultThresholdPaths

public void GetDefaultThresholdPaths(java.util.Vector progNames,
                                     java.util.Vector dispNames,
                                     java.util.Locale locale)
Get programmatic and display paths for all supported default thresholds

Parameters:
progNames - empty Vector of programmatic names for paths each as Vectors supporting default thresholds to be filled in
dispNames - empty Vector of display names each as path Vectors corresponding to progNames to be filled in
locale - Locale for determining display names

MonletGetMetaData

public MonletAttrMetaData MonletGetMetaData(int handle)
                                     throws MonletException,
                                            MonletInvalidHandleException
Get metadata for attribute specified by handle

Parameters:
handle - of active attribute
Returns:
metadata for attribute specified by handle
Throws:
MonletException - if failed to get metadata
MonletInvalidHandleException - if handle is invalid

MonletGetData

public java.lang.Object MonletGetData(int handle)
                               throws MonletException,
                                      MonletInvalidHandleException
Get data for attribute specified by handle

Parameters:
handle - of active attribute
Returns:
data object type depending on data type reported in metadata: For type MonletAttrMetaData.NODEDATA_DOUBLE object may be of class Integer, Long, or Double. For type MonletAttrMetaData.NODEDATA_STRING object must be of class String.
Throws:
MonletException - if failed to get data
MonletInvalidHandleException - if handle is invalid

MonletAssignHandle

public void MonletAssignHandle(java.util.Vector path,
                               int handle)
                        throws MonletException,
                               MonletInvalidHandleException
Assign handle to attribute specified by node path and activate it for monitoring (open any internal resources needed for monitoring it)

Parameters:
handle - to assign when activating the attribute
Throws:
MonletException - if failed to assign handle
MonletInvalidHandleException - if handle is invalid or already assigned

MonletReleaseHandle

public void MonletReleaseHandle(int handle)
                         throws MonletException,
                                MonletInvalidHandleException
Release handle of an active attribute and deactivate it for monitoring (release any internal resource needed for monitoring it)

Parameters:
handle - of active attribute
Throws:
MonletException - if failed to release handle
MonletInvalidHandleException - if handle is invalid (not assigned)

MonletIndepCmd

public MonletIndepCmd MonletIndepCmd(TWGMonPath path,
                                     MonletIndepCmd iCmd)
Pass an Independent Command (byte blob) down to the monlet.

Parameters:
path - attribute path to send the IndepCmd to
iCmd - independent command blob
Returns:
command results