Package com.crystaldecisions.sdk.plugin.desktop.server

This package allows you to manage servers in the BusinessObjects Enterprise system.

See:
          Description

Interface Summary
IServer The IServer interface manages the server, provides general information on the server, and retrieves the administration library specific to the server kind.
IServerBase This interface manages the server, provides general information on the server, and retrieves the administration library specific to the server kind.
IServerBase.CeCommunicationProtocol The communication protocol the server is running under
 

Package com.crystaldecisions.sdk.plugin.desktop.server Description

This package allows you to manage servers in the BusinessObjects Enterprise system. In particular, it allows you to start, stop, enable, or disable any server. It also enables you to access general and server-specific metrics. The IServer contains the method getServerAdmin that is used to obtain detailed information on the kind of server, as well as to make calls specific to the management of that server kind.

The diagram below illustrates the object model that is implemented by the Server plugin:

Retrieving desktop plugins

Each object that is created with a desktop plugin is stored in either the CI_INFOOBJECTS or the CI_SYSTEMOBJECTS category in the CMS InfoStore, and is marked with a programmatic identifier (KIND). Using SI_KIND, you can query the CMS InfoStore for a collection of objects.

Example

The following query selects the names and IDs of all Connection objects in the CMS:

IInfoObjects serverObjs = iStore.query("SELECT SI_NAME, SI_ID FROM CI_SYSTEMOBJECTS Where SI_KIND='Server');

The query method returns a collection of InfoObjects, which in this case are Server plugin objects. Like other InfoObjects, these objects are uniquely represented by their ID property. For each object in the collection, you can access general InfoObject properties, such as the SI_NAME property, SI_DESCRIPTION property, and SI_ID property.

To access the IServer objects returned by the query, the resulting IInfoObjects need to be cast. This example demonstrates how to cast the returned IInfoObjects as IServer objects.

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

Related Documentation