|
||||||||||
| PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES | |||||||||
See:
Description
| Interface Summary | |
| ICMSAdmin | This interface allows you to retrieve the metrics specific to a CMS cluster. |
This package allows you to retrieve the metrics specific to a CMS cluster. This information is useful to monitor CMS clusters, and includes metrics on the CMS database, licenses, scheduled jobs, and user connections.
The administration plugins cannot be queried for directly. Administration plugins are used to monitor all of the servers in the system, which means that the server objects need to be retrieved before using the plugins to access information about them.
Each server object in BusinessObjects Enterprise is represented by an InfoObject. These objects are stored
in the CI_SYSTEMOBJECTS category in the CMS InfoStore, and are marked with a programmatic
identifier (SI_KIND). Using SI_KIND
and SI_SERVER_KIND, you can query the CMS InfoStore for a
collection of server objects of a particular type.
The following query selects the names, and IDs of all CMS servers in the CMS:
IInfoObjects serverObjs = iStore.query("SELECT SI_NAME, SI_SERVER_ID FROM CI_SYSTEMOBJECTS
Where SI_KIND='Server' AND SI_SERVER_KIND = 'aps'");
The query method returns a collection of InfoObjects, which in this case are CMS server objects.
Like other InfoObjects, CMS server objects are uniquely represented by their ID property.
Through the server object, you can access general InfoObject properties, such as the SI_NAME property,
SI_DESCRIPTION property, and
SI_ID property.
Once the CMS server objects are retrieved, you can use the IServer interface and the
getServerAdmin() method to get the CMS Administration plugin's default object.
Then you can use ICMSAdmin interface to retrieve the metrics specific to an CMS cluster.
To access the CMS server object, the resulting IInfoObjects need to be cast. The following
code illustrates how the IInfoObjects retrieved by the query can then be cast as the CMS
administrative object, ICMSAdmin.
for (int i = 0; i < serverObjs.size(); i++)
{
IInfoObject obj = (IInfoObject) serverObjs.get(i);
IServer serverObj = (IServer) obj;
ICMSAdmin cmsServer = (ICMSAdmin) serverObj.getServerAdmin();
}
|
||||||||||
| PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES | |||||||||