Package com.crystaldecisions.sdk.plugin.admin.eventserveradmin

This package has been deprecated as of version 12.0.

See:
Description

Interface Summary

IEventServerAdmin	Deprecated. As of version 12.0.
IEventServerAdminFile	Deprecated. As of version 12.0.

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

This package has been deprecated as of version 12.0. This package allows you to monitor the Event server and the files that trigger those events. Metrics for the server include the number of events, host machine, and the time between polling. Polling times can be adjusted. File information includes file name, file type, number of clients using the event, and the last time the event was fired.

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 Event 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 = 'eventserver'");

The query method returns a collection of InfoObjects, which in this case are Event server objects. Like other InfoObjects, Event 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 Event server objects are retrieved, you can use the IServer interface and the getServerAdmin() method to get the Event Server Administration plugin's default object. Then you can use IEventServerAdmin interface to retrieve the metrics specific to the Event Server and IEventServerAdminFile to retrieve information about the files that are used to trigger events.

To access the Event 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 Event Server administrative object, IEventServerAdmin.

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