Package com.crystaldecisions.sdk.plugin.admin.cachepageserveradmin

This package has been deprecated as of version 12.0.

See:
Description

Interface Summary

ICacheServerAdmin	Deprecated. As of version 12.0.
IPageServerAdmin	Deprecated. As of version 12.0.
IPageServerConnection	Deprecated. As of version 12.0.

Package com.crystaldecisions.sdk.plugin.admin.cachepageserveradmin Description

This package has been deprecated as of version 12.0. This package provides interfaces through which you can monitor and manage the behavior of each Cache Server and each Page Server. For example, it can be used to monitor and update the maximum number of processing threads on both a Cache Server and a Page Server.

Retrieving administration plugins

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 Crystal Enterprise is represented by an InfoObject. These objects are stored in the CI_SYSTEMOBJECTS category in the APS InfoStore, and are marked with a programmatic identifier (ProgID). Using SI_PROGID and SI_SERVER_KIND, you can query the APS InfoStore for a collection of server objects of a particular type.

Example

The following query selects the names, and IDs of all Cache servers in the APS:

IInfoObjects serverObjs = iStore.query("SELECT SI_NAME, SI_SERVER_ID FROM CI_SYSTEMOBJECTS Where SI_PROGID='CrystalEnterprise.Server' AND SI_SERVER_KIND = 'cacheserver'");

Note: To retrieve Page servers, replace 'cacheserver' with 'pageserver'.

The query method returns a collection of InfoObjects, which in this case are Cache server objects. Like other InfoObjects, APS 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 Cache or Page server objects are retrieved, you can use the IServer interface and the getServerAdmin() method to get the Cache or Page Server Administration plugin's default object. Then you can use ICacheServerAdmin interface to retrieve the metrics specific to the Cache Server and IPageServerAdmin to retrieve the metrics specific to the Page Server.

To access the Cache server or Page 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 Cache Server administrative object, ICacheServerAdmin.

for (int i = 0; i < serverObjs.size(); i++)
{
        IInfoObject obj = (IInfoObject) serverObjs.get(i);
        IServer serverObj = (IServer) obj;
        ICacheServerAdmin cacheServer = (ICacheServerAdmin) serverObj.getServerAdmin();
}