|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tivoli.twg.monitor.TWGMonSubSys
Field Summary | |
---|---|
protected TWGMonMOAddressInfoProvider |
addressServer
A reference to the server object that the subsystem is to request address information from |
protected TWGMonMOAttributeInfoProvider |
attributeServer
A reference to the server object that the subsystem is to use request attribute information from managed objects |
protected TWGMonThresholdEventSink |
eventServer
A reference to the server object that the subsystem is to report events to |
protected TWGMonMOStateInfoProvider |
stateServer
A reference to the server object that the subsystem is to request managed object state information from |
Constructor Summary | |
---|---|
TWGMonSubSys(TWGMonThresholdEventSink mainThresholdServer,
TWGMonMOAddressInfoProvider mainAddressSource,
TWGMonMOStateInfoProvider mainStateSource,
TWGMonMOAttributeInfoProvider mainAttributeSource)
Constructor for the Monitor Subsystem base object |
Method Summary | |
---|---|
abstract int |
acquireHandle(TWGMonAttributePath pathInfo,
long[] objectArray,
java.lang.String[] handleArray,
int[] resultArray)
The method implements the acquire handle behavior for the subsystem |
abstract int |
deleteThresholdID(TWGMonAttributePath pathInfo,
TWGMonThresholdId threshID,
long mObjectID)
The method implements the delete threshold by ID behavior for the subsystem |
TWGMonMOAddressInfoProvider |
getAddressSource()
Get a reference to the Server that processes our request for addressing information |
abstract int |
getAttributeData(java.lang.String[] handleArray,
TWGMonAttributeDataSink[] attributeArray)
The method implements the get Attribute data behavior for the subsystem |
abstract TWGMonAttributeNodeList |
getAttributeNodeList(long[] objectArray,
TWGMonAttributePath pathInfo,
java.util.Locale requestedLocale)
The method implements the find attribute nodes behavior for the subsystem. |
TWGMonMOAttributeInfoProvider |
getAttributeSource()
Get a reference to the Server that processes our request for attribute information |
abstract int |
getDefaultThresholdPaths(long mObjectID,
java.util.Vector symPaths,
java.util.Vector guiPaths)
The method implements the get default threshold paths behavior for the subsystem. |
abstract java.lang.String |
getDispRootName(java.util.Locale neededLocale)
The method implements the behavior to get the root GUI string for the subsystem based on the locale passed in |
abstract java.lang.String |
getEnumBundle(TWGMonAttributePath pathInfo)
The method retrieves the resource bundle name containing the enumeration strings * of a specific locale for an enumerated attribute node from the subsystem. |
abstract TWGMonEnumStrings |
getEnumStringsByLocale(TWGMonAttributePath pathInfo,
java.util.Locale requestedLocale)
This method provides the server with a means to retreive strings which enumerate the responses that are possible for an enumerated attribute node (enumerated attributes are string attributes where the set of strings that may be returned is fixed and known). |
TWGMonThresholdEventSink |
getEventSink()
Get a reference to the Server that processes our events. |
abstract int |
getMetaData(java.lang.String[] handleArray,
TWGMonAttributePath[] attributePathArray,
TWGMonAttributeMetaDataSink[] attributeArray)
The method implements the get meta data behavior for the subsystem |
abstract int |
getRecordedData(java.lang.String[] handleArray,
TWGMonRecordingDataSink[] attributeArray,
long[] startTimeArray)
The method implements the get Recorded data behavior for the subsystem |
abstract java.lang.String |
getRoot()
This method returns the root name for the sub-system. |
abstract TWGMonAttributePath |
getRootForManagedObject(long moid)
This method provides the root path to use with the moid if the subsystem can reach the managed obect. |
abstract java.lang.String |
getRootQualifierBundleName()
This method returns the NLS bundle name for the bundle containing the root qualifier name for the subsystem. |
abstract java.lang.String |
getRootQualifierKey()
This method returns the NLS key that should be used to retrieve from the "root qualifier bundle", the qualifier name for the subsystem. |
TWGMonMOStateInfoProvider |
getStateSource()
Get a reference to the Server that processes our request for state information |
abstract int |
getThresholdIDs(TWGMonAttributePath pathinfo,
long mObjectID,
java.util.Vector threshIDs)
The method implements the get threshold IDs behavior for the subsystem |
abstract java.lang.String |
getThresholdTemplateFilename(TWGMonAttributePath pathInfo)
The method retrieves the property filename that contains the Threshold Template for the given attribute node from the subsystem. |
abstract boolean |
isRoot(java.lang.String testRoot)
The method implements the test for root name behavior for the subsystem. |
abstract int |
releaseHandle(java.lang.String[] handleArray,
int[] resultArray)
The method implements the release handle behavior for the subsystem |
abstract void |
reportCapabilities(TWGMonSubSysCapabilities abilities)
The method implements the behavior retrieve the capabilities provided by a subsystem. |
abstract TWGMonIndepCmd |
sendIndepCmd(TWGMonAttributePath pathInfo,
TWGMonIndepCmd indepCmd,
long mObjectID)
The method implements the sending of independent command blobs for the subsystem |
abstract int |
setThreshold(TWGMonAttributePath pathInfo,
TWGMonThreshold threshInfo,
long mObjectID)
The method implements the set threshold behavior for the subsystem |
abstract void |
shutdown()
The method implements the shutdown behavior for the subsystem. |
abstract int |
startMonitor(java.lang.String[] handleArray,
int[] resultArray)
The method implements the start monitoring behavior for the subsystem |
abstract int |
startRecording(java.lang.String[] handleArray,
long[] startTimeArray,
int[] resultArray)
The method implements the start Recording behavior for the server. |
abstract void |
startup(ServiceNode helperServiceNode)
The method implements the behavior to initialize a subsystem. |
abstract int |
stopMonitor(java.lang.String[] handleArray,
int[] resultArray)
The method implements the stop monitoring behavior for the subsystem |
abstract int |
stopRecording(java.lang.String[] handleArray,
int[] resultArray)
The method implements the stop Recording behavior for the subsystem. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected TWGMonThresholdEventSink eventServer
protected TWGMonMOAddressInfoProvider addressServer
protected TWGMonMOStateInfoProvider stateServer
protected TWGMonMOAttributeInfoProvider attributeServer
Constructor Detail |
public TWGMonSubSys(TWGMonThresholdEventSink mainThresholdServer, TWGMonMOAddressInfoProvider mainAddressSource, TWGMonMOStateInfoProvider mainStateSource, TWGMonMOAttributeInfoProvider mainAttributeSource)
mainAddressSource
- reference to the object to get moid addressing information frommainStateSource
- reference to the object to get moid state information frommainAttributeSource
- reference to the object to get moid attribute information fromMethod Detail |
public TWGMonThresholdEventSink getEventSink()
public TWGMonMOAddressInfoProvider getAddressSource()
public TWGMonMOStateInfoProvider getStateSource()
public TWGMonMOAttributeInfoProvider getAttributeSource()
public abstract void startup(ServiceNode helperServiceNode) throws com.tivoli.twg.monitor.TWGMonSubSysInitException
This is an abstract interface that must be provided by derived classes
helperServiceNode
- reference to service node that may be used
by the subsystem to communicate with other
service nodes.
TWGMonSubSysInitException
- Indicates the Subsystem had a failure during
initializationpublic abstract void shutdown()
This is an abstract interface that must be provided by derived classes
public abstract void reportCapabilities(TWGMonSubSysCapabilities abilities)
This is an abstract interface that must be provided by derived classes
abilities
- object to fill in with list of capabilities the
subsystem provides.public abstract boolean isRoot(java.lang.String testRoot)
testRoot
- string to test against roots for subsys to see if one
of them matches
public abstract TWGMonAttributePath getRootForManagedObject(long moid)
This is an abstract interface that must be provided by derived classes
moid
- managed object id for the object to check
reachability for
public abstract TWGMonAttributeNodeList getAttributeNodeList(long[] objectArray, TWGMonAttributePath pathInfo, java.util.Locale requestedLocale)
It will always be called with a path object, but the path object may be empty. when it is empty it indicates that the subsystem should return its root name if it support attribute nodes on the item identified by the managed object id.
The attribute nodes in the attribute node list contain information that indicates which managed object ids provide the attribute nodes that are identified in the list. It is possible for one returned list to have attributes returned that are unique to one or more of the systems. Only one of the managed objects in the input list need support an attribute node for it to be returned in the list.
Attribute nodes can identify nodes that are branch points in the attribute tree or they may identify nodes that are monitorable attributes
This is an abstract interface that must be provided by derived classes
objectArray
- array of longs representing managed object ids that
are being checked for attribute nodespathInfo
- TWGMonatttributePath object containing
the path to search for attribute nodesrequestedLocale
- locale we want the displayble version of
the node names to be returned back in
public abstract TWGMonEnumStrings getEnumStringsByLocale(TWGMonAttributePath pathInfo, java.util.Locale requestedLocale)
The returned result of this query when successful will be an object that has the list of strings and an associated set of Locale specific strings that identify a locale specific equivalent string for the strings in the enumeration list.
This method is used to provide the strings to the console when this user is viewing an attribute's current value or when they are setting thresholds against the attribute
This is an abstract interface that must be provided by derived classes
pathInfo
- The attribute path object with the path
to return enumeration strings forrequestedLocale
- Locale the enumeration strings are to
be returned to be presented in
public abstract java.lang.String getEnumBundle(TWGMonAttributePath pathInfo)
This is used by the server when handling events associated with an enumerated attribute node. It retrieves the bundle name to pass to the event server so that the data associated with the event may be viewed in any supported locale with a locale specific translation available.
The subsystem may not have a bundle to provide the server. If this is the case (when translations not provided by property files), then the method should return a null object reference
This is an abstract interface that must be provided by derived classes
pathInfo
- object with path information for the search
public abstract java.lang.String getThresholdTemplateFilename(TWGMonAttributePath pathInfo)
Threshold templates provide default information (suggested set points, etc) for the user when they bring up the threshold dialog against an attribute that has a template and has not had a threshold setting established yet.
See the software developers kit for the product for an explaination of the format of these property files.
This is an abstract interface that must be provided by derived classes
pathInfo
- object with path information for the search
public abstract int acquireHandle(TWGMonAttributePath pathInfo, long[] objectArray, java.lang.String[] handleArray, int[] resultArray)
This is an abstract interface that must be provided by derived classes
pathInfo
- the path of the attribute to start monitoring onobjectArray
- the list of system ids to start monitoring
the attribute onhandleArray
- array that is filled in by function with
handles of started monitors. if the handle is
acquired, the array will have a reference to
a string object with the handle. if not acquired,
the array will have a null for the reference.resultArray
- array that is filled in with result code
to indicate success or failure of request.
The set of defined returned values are:
public abstract int releaseHandle(java.lang.String[] handleArray, int[] resultArray)
This is an abstract interface that must be provided by derived classes
handleArray
- array that provides the list of handles the
server is no longer interested inresultArray
- array that is filled in with result code to
indicate success or failure of request
The set of defined returned values are:
public abstract int startMonitor(java.lang.String[] handleArray, int[] resultArray)
This is an abstract interface that must be provided by derived classes
handleArray
- array that provides the handles for the items to
start monitors onresultArray
- Array that is filled in with result code to indicate
success or failure of request
public abstract int stopMonitor(java.lang.String[] handleArray, int[] resultArray)
This is an abstract interface that must be provided by derived classes
handleArray
- Array with handles of monitors to stop arranged
as array of handles
resultArray
- array that is filled in with result code to
indicate success or failure of request
public abstract int startRecording(java.lang.String[] handleArray, long[] startTimeArray, int[] resultArray)
This is an abstract interface that must be provided by derived classes
handleArray
- array with handles of monitors to start
recording aranged as array of handlesstartTimeArray
- Array of timeStamps of when the client started
the recording operation in msecs since 1/1/1970resultArray
- array that is filled in with result codes that
indicate success or failure of request
public abstract int getRecordedData(java.lang.String[] handleArray, TWGMonRecordingDataSink[] attributeArray, long[] startTimeArray)
This is an abstract interface that must be provided by derived classes
handleArray
- array with handles of attributes to get recorded
data for arranged as array of handlesattributeArray
- array with references to the attributes that
should have data returned to themstartTimeArray
- array with timeStamps in msecs since 1/1/1970 to
specifiy the cut-off time for recorded data points
to retrieve
public abstract int stopRecording(java.lang.String[] handleArray, int[] resultArray)
This is an abstract interface that must be provided by derived classes
handleArray
- array with handles of monitors to stop recording
arranged as array of handlesresultArray
- array that is filled in with result code to
indicate success or failure of request
public abstract int getAttributeData(java.lang.String[] handleArray, TWGMonAttributeDataSink[] attributeArray)
for each handle passed in a a TWGMonCurrentData object will be created with values indicating the current state and value of the attribute being monitored and it will be delivered to the object in the attribute array that is associated with the handle used in the request
The thread used to call this interface must be allowed to return as quickly as possible. If the request is going to take any significan length of time, the subsystem should use an internal work queue and set of threads to actually collect and return the value.
This is an abstract interface that must be provided by derived classes
handleArray
- Array with handles of monitors to get data from
arranged as array of handlesattributeArray
- Array with references to the attributes that
should have data returned to them
public abstract int getMetaData(java.lang.String[] handleArray, TWGMonAttributePath[] attributePathArray, TWGMonAttributeMetaDataSink[] attributeArray)
The thread used to call this interface must be allowed to return as quickly as possible. If the request is going to take any significan length of time, the subsystem should use an internal work queue and set of threads to actually collect and return the value.
This is an abstract interface that must be provided by derived classes
handleArray
- array that is filled in by function with
handles of started monitorsattributePathArray
- array that is filled in the attribute
path we want metadata forattributeArray
- array that is filled in with result
metadata objects with its return code
set
public abstract int setThreshold(TWGMonAttributePath pathInfo, TWGMonThreshold threshInfo, long mObjectID)
This is an abstract interface that must be provided by derived classes
pathInfo
- the path of the attribute to set a threshold forthreshInfo
- the threshold being setmObjectID
- the systems managed object id to set the threshold on
public abstract int deleteThresholdID(TWGMonAttributePath pathInfo, TWGMonThresholdId threshID, long mObjectID)
Notes:
This is an abstract interface that must be provided by derived classes
pathInfo
- the path of the attribute to delete a threshold forthreshID
- the unique threshold ID to deletemObjectID
- the list of system ids to delete the threshold on
public abstract int getThresholdIDs(TWGMonAttributePath pathinfo, long mObjectID, java.util.Vector threshIDs)
Notes:
This is an abstract interface that must be provided by derived classes
pathinfo
- the path of the attribute to get threshold IDs formObjectID
- the system id to get the thresholds fromthreshIDs
- array is filled in with the returned threshold IDs
public abstract int getDefaultThresholdPaths(long mObjectID, java.util.Vector symPaths, java.util.Vector guiPaths)
This is an abstract interface that must be provided by derived classes
mObjectID
- the managed object to get the default threshold
paths forsymPaths
- vector of symbolic paths that should have
default thresholds setguiPaths
- vector of matching NLS GUI paths to display as
the threshold path
public abstract TWGMonIndepCmd sendIndepCmd(TWGMonAttributePath pathInfo, TWGMonIndepCmd indepCmd, long mObjectID)
Independant commands are used to send blobs of configuration data for managed objects to or through the subsystem. The TWGMonIndepCmd object reference will carry back with it the result of the operation.
The return codes that are expected to be returned in the command object are:
This is an abstract interface that must be provided by derived classes
pathInfo
- the programatic path of the attribute to delete
a threshold forindepCmd
- the indep command class instance to sendmObjectID
- the system id to send the indepCmd to
public abstract java.lang.String getRootQualifierBundleName()
This is an abstract interface that must be provided by derived classes
public abstract java.lang.String getRootQualifierKey()
This is an abstract interface that must be provided by derived classes
public abstract java.lang.String getRoot()
This is an abstract interface that must be provided by derived classes
public abstract java.lang.String getDispRootName(java.util.Locale neededLocale)
neededLocale
- locale to get the string in
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |