com.tivoli.twg.monitor
Class TWGMonSubSys

java.lang.Object
  extended bycom.tivoli.twg.monitor.TWGMonSubSys

public abstract class TWGMonSubSys
extends java.lang.Object


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

eventServer

protected TWGMonThresholdEventSink eventServer
A reference to the server object that the subsystem is to report events to


addressServer

protected TWGMonMOAddressInfoProvider addressServer
A reference to the server object that the subsystem is to request address information from


stateServer

protected TWGMonMOStateInfoProvider stateServer
A reference to the server object that the subsystem is to request managed object state information from


attributeServer

protected TWGMonMOAttributeInfoProvider attributeServer
A reference to the server object that the subsystem is to use request attribute information from managed objects

Constructor Detail

TWGMonSubSys

public TWGMonSubSys(TWGMonThresholdEventSink mainThresholdServer,
                    TWGMonMOAddressInfoProvider mainAddressSource,
                    TWGMonMOStateInfoProvider mainStateSource,
                    TWGMonMOAttributeInfoProvider mainAttributeSource)
Constructor for the Monitor Subsystem base object

Parameters:
mainAddressSource - reference to the object to get moid addressing information from
mainStateSource - reference to the object to get moid state information from
mainAttributeSource - reference to the object to get moid attribute information from
Method Detail

getEventSink

public TWGMonThresholdEventSink getEventSink()
Get a reference to the Server that processes our events.

Returns:
TWGMonThresholdEventSink reference to object to process events

getAddressSource

public TWGMonMOAddressInfoProvider getAddressSource()
Get a reference to the Server that processes our request for addressing information

Returns:
TWGMonMOAddressInfoProvider reference to object to process requests for addressing blobs

getStateSource

public TWGMonMOStateInfoProvider getStateSource()
Get a reference to the Server that processes our request for state information

Returns:
TWGMonStateInfoProvider reference to object to process requests for state information

getAttributeSource

public TWGMonMOAttributeInfoProvider getAttributeSource()
Get a reference to the Server that processes our request for attribute information

Returns:
TWGMonMOAttributeInfoProvider reference to object to process requests for attribute information

startup

public abstract void startup(ServiceNode helperServiceNode)
                      throws com.tivoli.twg.monitor.TWGMonSubSysInitException
The method implements the behavior to initialize a subsystem.

This is an abstract interface that must be provided by derived classes

Parameters:
helperServiceNode - reference to service node that may be used by the subsystem to communicate with other service nodes.
Throws:
TWGMonSubSysInitException - Indicates the Subsystem had a failure during initialization

shutdown

public abstract void shutdown()
The method implements the shutdown behavior for the subsystem. There are no garantees that this method will always be called to properly shutdown the subsystem (Power outages, etc.). Therefore, the subsystem should make sure that any persistant state information that must be kept is saved on a regular basis (an example might be the threshold settings that the subsystem has been told about).

This is an abstract interface that must be provided by derived classes


reportCapabilities

public abstract void reportCapabilities(TWGMonSubSysCapabilities abilities)
The method implements the behavior retrieve the capabilities provided by a subsystem.

This is an abstract interface that must be provided by derived classes

Parameters:
abilities - object to fill in with list of capabilities the subsystem provides.

isRoot

public abstract boolean isRoot(java.lang.String testRoot)
The method implements the test for root name behavior for the subsystem.

Parameters:
testRoot - string to test against roots for subsys to see if one of them matches
Returns:
boolean that indicates that the string is indeed one of the root paths that the subsystem understands

getRootForManagedObject

public abstract TWGMonAttributePath getRootForManagedObject(long moid)
This method provides the root path to use with the moid if the subsystem can reach the managed obect.

This is an abstract interface that must be provided by derived classes

Parameters:
moid - managed object id for the object to check reachability for
Returns:
TWGMonAttributePath object if the subsystem can reach the object, null if it can not. The path returned will be the root path that would be used to talk with the object

getAttributeNodeList

public abstract TWGMonAttributeNodeList getAttributeNodeList(long[] objectArray,
                                                             TWGMonAttributePath pathInfo,
                                                             java.util.Locale requestedLocale)
The method implements the find attribute nodes behavior for the subsystem.

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

Parameters:
objectArray - array of longs representing managed object ids that are being checked for attribute nodes
pathInfo - TWGMonatttributePath object containing the path to search for attribute nodes
requestedLocale - locale we want the displayble version of the node names to be returned back in
Returns:
TWGMonAttributeNodeList which will contain the TWGMonAttributeNOdes that were found in response to the parameters that generated to response. This list must always be returned on thsi call. It can be returnedempty.

getEnumStringsByLocale

public 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).

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

Parameters:
pathInfo - The attribute path object with the path to return enumeration strings for
requestedLocale - Locale the enumeration strings are to be returned to be presented in
Returns:
TWGMonEnumStrings enumerated strings if available, otherwise null

getEnumBundle

public 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.

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

Parameters:
pathInfo - object with path information for the search
Returns:
String resource bundle name if available otherwise null

getThresholdTemplateFilename

public 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.

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

Parameters:
pathInfo - object with path information for the search
Returns:
String threshold template filename if available, otherwise null

acquireHandle

public abstract int acquireHandle(TWGMonAttributePath pathInfo,
                                  long[] objectArray,
                                  java.lang.String[] handleArray,
                                  int[] resultArray)
The method implements the acquire handle behavior for the subsystem

This is an abstract interface that must be provided by derived classes

Parameters:
pathInfo - the path of the attribute to start monitoring on
objectArray - the list of system ids to start monitoring the attribute on
handleArray - 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:
TWGMonRC.HANDLE_NOT_AVAILABLE
this may be returned when the subsystem is unable to generate a handle for the request.
TWGMonRC.GOT_HANDLE
this is returned when the request is successful and a valid handle is returned.
TWGMonRC.TIMEOUT
this is returned when the subsystem can not establish a handle to return in a reasonable period of time (example: when network is broken or busy) The get handle will generaly be reattempted after a delay to allow whatever caused the original problem to be resolved.
TWGMonRC.SECURITY_FAILURE
this is returned when the subsystem is unable to reach the target system due to access controls that are denying access to the system. A retry will occur only after the managed object goes through a state transition (which may include going offline and online).
TWGMonRC.LICENSE_FAILURE
the subsystems licencing controls are denying access to the system. A retry will only occur when a state transition for the system has occured.
Returns:
int indicating whether the command worked. Possible values returned for the overall return code are:
TWGMonRC.SUCCESS
This indicates the call was successful, but it does not indicate that all handles were successfully acquired. The result array must be checked to decide that

releaseHandle

public abstract int releaseHandle(java.lang.String[] handleArray,
                                  int[] resultArray)
The method implements the release handle behavior for the subsystem

This is an abstract interface that must be provided by derived classes

Parameters:
handleArray - array that provides the list of handles the server is no longer interested in
resultArray - array that is filled in with result code to indicate success or failure of request The set of defined returned values are:
TWGMonRC.SUCCESS
indicates the handle in the array was successfully released
TWGMonRC.GENERAL_ERROR
indicates the item was not properly released due to a general error while processing the request.
TWGMonRC.BAD_HANDLE
indicates the handle returned was not valid or not expected
TWGMonRC.TIMEOUT
indicates that a timeout occured while the request was being handled. A retry may be attempted when a timeout is received.
TWGMonRC.SECURITY_FAILURE
this is returned when the subsystem is unable to reach the target system due to access controls that are denying access to the system. No attempt will be made to retry the release
Returns:
int indicating whether the command worked. Possible values returned for the overall return code are:
TWGMonRC.SUCCESS
This indicates the call was successful, but it does not indicate that all handles were successfully acquired. The result array must be checked to decide that

startMonitor

public abstract int startMonitor(java.lang.String[] handleArray,
                                 int[] resultArray)
The method implements the start monitoring behavior for the subsystem

This is an abstract interface that must be provided by derived classes

Parameters:
handleArray - array that provides the handles for the items to start monitors on
resultArray - Array that is filled in with result code to indicate success or failure of request
TWGMonRC.SUCCESS
indicates the handle in the array was successfully used to start monitoring
TWGMonRC.BAD_HANDLE
indicates the handle passed in was not valid
TWGMonRC.SECURITY_FAILURE
this is returned when the subsystem is unable to reach the target system due to access controls that are denying access to the system. No attempt will be made to retry the startMonitor call until the system is marked as no longer being secured or the managed object goes offline and online again.
all others
indicate error. operation failed.
Returns:
int indicating whether the command worked. Possible values returned for the overall return code are:
TWGMonRC.SUCCESS
This indicates the call was successful.

stopMonitor

public abstract int stopMonitor(java.lang.String[] handleArray,
                                int[] resultArray)
The method implements the stop monitoring behavior for the subsystem

This is an abstract interface that must be provided by derived classes

Parameters:
handleArray - Array with handles of monitors to stop arranged as array of handles
TWGMonRC.SUCCESS
indicates the handle in the array was successfully used to stop monitoring
TWGMonRC.BAD_HANDLE
indicates the handle passed in was not valid
all others
indicate error. operation failed.
resultArray - array that is filled in with result code to indicate success or failure of request
Returns:
int indicating whether the command worked. Possible values returned for the overall return code are:
TWGMonRC.SUCCESS
This indicates the call was successful.

startRecording

public abstract int startRecording(java.lang.String[] handleArray,
                                   long[] startTimeArray,
                                   int[] resultArray)
The method implements the start Recording behavior for the server.

This is an abstract interface that must be provided by derived classes

Parameters:
handleArray - array with handles of monitors to start recording aranged as array of handles
startTimeArray - Array of timeStamps of when the client started the recording operation in msecs since 1/1/1970
resultArray - array that is filled in with result codes that indicate success or failure of request
TWGMonRC.SUCCESS
indicates the handle in the array was successfully used to start monitoring
all others
indicate error. operation failed.
Returns:
int indicating whether the command worked. Possible values returned for the overall return code are:
TWGMonRC.SUCCESS
This indicates the call was successful.

getRecordedData

public abstract int getRecordedData(java.lang.String[] handleArray,
                                    TWGMonRecordingDataSink[] attributeArray,
                                    long[] startTimeArray)
The method implements the get Recorded data behavior for the subsystem

This is an abstract interface that must be provided by derived classes

Parameters:
handleArray - array with handles of attributes to get recorded data for arranged as array of handles
attributeArray - array with references to the attributes that should have data returned to them
startTimeArray - array with timeStamps in msecs since 1/1/1970 to specifiy the cut-off time for recorded data points to retrieve
Returns:
int indicating whether the command worked. Possible values returned for the overall return code are:
TWGMonRC.SUCCESS
This indicates the call was successful.

stopRecording

public abstract int stopRecording(java.lang.String[] handleArray,
                                  int[] resultArray)
The method implements the stop Recording behavior for the subsystem.

This is an abstract interface that must be provided by derived classes

Parameters:
handleArray - array with handles of monitors to stop recording arranged as array of handles
resultArray - array that is filled in with result code to indicate success or failure of request
Returns:
int indicating whether the command worked. Possible values returned for the overall return code are:
TWGMonRC.SUCCESS
This indicates the call was successful.

getAttributeData

public abstract int getAttributeData(java.lang.String[] handleArray,
                                     TWGMonAttributeDataSink[] attributeArray)
The method implements the get Attribute data behavior for the subsystem

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

Parameters:
handleArray - Array with handles of monitors to get data from arranged as array of handles
attributeArray - Array with references to the attributes that should have data returned to them
Returns:
int indicating whether the command worked. Possible values returned for the overall return code are:
TWGMonRC.SUCCESS
This indicates the call was successful.

getMetaData

public abstract int getMetaData(java.lang.String[] handleArray,
                                TWGMonAttributePath[] attributePathArray,
                                TWGMonAttributeMetaDataSink[] attributeArray)
The method implements the get meta data behavior for the subsystem

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

Parameters:
handleArray - array that is filled in by function with handles of started monitors
attributePathArray - array that is filled in the attribute path we want metadata for
attributeArray - array that is filled in with result metadata objects with its return code set
Returns:
int indicating whether the command worked. Possible values returned for the overall return code are:
TWGMonRC.SUCCESS
This indicates the call was successful.

setThreshold

public abstract int setThreshold(TWGMonAttributePath pathInfo,
                                 TWGMonThreshold threshInfo,
                                 long mObjectID)
The method implements the set threshold behavior for the subsystem

This is an abstract interface that must be provided by derived classes

Parameters:
pathInfo - the path of the attribute to set a threshold for
threshInfo - the threshold being set
mObjectID - the systems managed object id to set the threshold on
Returns:
int indicating whether the command worked Possible values returned for the overall return code are:
TWGMonRC.SUCCESS
This indicates the call was successful.

deleteThresholdID

public abstract int deleteThresholdID(TWGMonAttributePath pathInfo,
                                      TWGMonThresholdId threshID,
                                      long mObjectID)
The method implements the delete threshold by ID behavior for the subsystem

Notes:

if (pathinfo.getPathLevels() > 1)
if (threshInfo.getThreshId() == 0
delete all thresholds from this server for the given path/node
else
delete the threshold matching the given path/node and threshId
if (pathinfo.getPathLevels() <= 1)
delete all thresholds from this server for every node

This is an abstract interface that must be provided by derived classes

Parameters:
pathInfo - the path of the attribute to delete a threshold for
threshID - the unique threshold ID to delete
mObjectID - the list of system ids to delete the threshold on
Returns:
int indicating whether the command worked Possible values returned for the overall return code are:
TWGMonRC.SUCCESS
This indicates the call was successful.

getThresholdIDs

public abstract int getThresholdIDs(TWGMonAttributePath pathinfo,
                                    long mObjectID,
                                    java.util.Vector threshIDs)
The method implements the get threshold IDs behavior for the subsystem

Notes:

if (pathinfo.getPathLevels() > 1)
get all thresholds from this server for the given path/node
if (pathinfo.getPathLevels() <= 1)
get all thresholds from this server for every node

This is an abstract interface that must be provided by derived classes

Parameters:
pathinfo - the path of the attribute to get threshold IDs for
mObjectID - the system id to get the thresholds from
threshIDs - array is filled in with the returned threshold IDs
Returns:
int indicating whether the command worked. Possible values returned for the overall return code are:
TWGMonRC.SUCCESS
This indicates the call was successful.

getDefaultThresholdPaths

public 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.

This is an abstract interface that must be provided by derived classes

Parameters:
mObjectID - the managed object to get the default threshold paths for
symPaths - vector of symbolic paths that should have default thresholds set
guiPaths - vector of matching NLS GUI paths to display as the threshold path
Returns:
int indicating whether the command worked. Possible values returned for the overall return code are:
TWGMonRC.SUCCESS
This indicates the call was successful.
Anything else
indicates that the data was not retreiveable. The operation will generally be retried the next time the item is detected to have come online.

sendIndepCmd

public abstract TWGMonIndepCmd sendIndepCmd(TWGMonAttributePath pathInfo,
                                            TWGMonIndepCmd indepCmd,
                                            long mObjectID)
The method implements the sending of independent command blobs for the subsystem

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:

TWGMonRC.SUCCESS
Indicates the operation succeeded an there is no need to resend the data.
TWGMonRC.NO_SUPPORT_FOR_CLIENT
Indicates that the operation was not supported for the managed object that was the target and that there is no need to retry sending the command.
TWGMonRC.SOURCE_OFFLINE, TWGMonRC.TIMEOUT, TWGMonRC.GENERAL_ERROR, TWGMonRC.INVALID_PATH, TWGMonRC.INVALID_MOID, TWGMonRC.INVALID_VERSION
Indicates that the operation was not successful and that the attempt to send the command should be retried when the managed object goes through a state change.
All other errors
Indicates that the operation was not successful and that the attempt to send the command should not be retried.

This is an abstract interface that must be provided by derived classes

Parameters:
pathInfo - the programatic path of the attribute to delete a threshold for
indepCmd - the indep command class instance to send
mObjectID - the system id to send the indepCmd to
Returns:
TWGMonIndepCmd the resulting container class for the indepCmd

getRootQualifierBundleName

public abstract java.lang.String getRootQualifierBundleName()
This method returns the NLS bundle name for the bundle containing the root qualifier name for the subsystem. The text retrieved from this bundle is displayed on the console.

This is an abstract interface that must be provided by derived classes

Returns:
String The name of the NLS bundle that contains the root qualifier name for the subsystem.

getRootQualifierKey

public 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. See "getRootQualifierBundleName"

This is an abstract interface that must be provided by derived classes

Returns:
String The key that will retrieve the root qualifier name. subsystem provides.

getRoot

public abstract java.lang.String getRoot()
This method returns the root name for the sub-system. This name is used as the first level qualifier under "Director". For example, Director sub-system has a root name of "Director Agent".

This is an abstract interface that must be provided by derived classes

Returns:
String The root name.

getDispRootName

public 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

Parameters:
neededLocale - locale to get the string in
Returns:
String subsystem GUI name from our NLS resource bundle