Package com.crystaldecisions.sdk.plugin.admin.fileserveradmin

This package has been deprecated as of version 12.0.

See:
Description

Interface Summary

IFileServerAdmin	Deprecated. As of version 12.0.
IFRSAdminFile	Deprecated. As of version 12.0.

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

This package has been deprecated as of version 12.0. This package allows you to monitor and manage a file server. The metrics for the File Repository Server include the root directory of the files that it maintains, the maximum idle time, the number of active files, and the number of active client connections. The metrics also include the total available hard disk space, as well as the number of bytes sent and received.

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 File servers in the APS:

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

The query method returns a collection of InfoObjects, which in this case are File server objects. Like other InfoObjects, File 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 File server objects are retrieved, you can use the IServer interface and the getServerAdmin() method to get the File Server Administration plugin's default object. Then you can use IFileServerAdmin interface to retrieve the metrics specific to the File Server and IFRSAdminFile to retrieve metrics on an active files in the File Repository Server (FRS).

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

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