Package com.crystaldecisions.sdk.plugin.admin.reportappserveradmin

This package has been deprecated as of version 12.0.

See:
Description

Interface Summary

IReportAppServerAdmin

Deprecated. As of version 12.0.

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

This package has been deprecated as of version 12.0. For more information, see BusinessObjects Enterprise Java SDK Developer Guide. This package allows you to perform a number of Report Application Server (RAS) server tasks. For example, you can limit the number of records that will be retrieved from the database or determine how int a user can be inactive before the server will time out. You can also view the metrics for a particular RAS 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 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.

Example

The following query selects the names and IDs of all RAS 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 = 'rptappserver'");

The query method returns a collection of InfoObjects, which in this case are RAS 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, the SI_DESCRIPTION property, and the SI_ID property.

Once the RAS server objects are retrieved, you can use the IServer interface and the getServerAdmin() method to get the RAS Server Administration plugin's default object. Then you can use IReportAppServerAdmin interface to retrieve the metrics specific to the RAS Server.

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

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