com.crystaldecisions.sdk.plugin.desktop.server
Interface IServerBase

All Known Subinterfaces:

IServer

public interface IServerBase

This interface represents a server in a SAP BusinessObjects Enterprise deployment. It provides methods for managing server state and retrieving information about the server including hosted services and general server metrics. Management of the server state includes starting, stopping, restarting, enabling, and disabling the server.

Nested Class Summary

static interface

IServerBase.CeCommunicationProtocol The communication protocol the server is using.

Field Summary

static int	CE_SERVER_RESTART Specifies that the server should be restarted.
static int	CE_SERVER_START Specifies that the server should be started.
static int	CE_SERVER_STOP Specifies that the server should be stopped.
static java.lang.String	KIND The Kind used to query for Server objects.
static java.lang.String	PROGID The ProgID for the Server Class.
static int	TYPEID The TypeId for Server objects.

Method Summary

java.lang.String[]	getAdminServiceNames() Deprecated. As of version 12.0.
java.lang.Object	getAuditAdmin() Deprecated. As of version 12.0.
boolean	getAutoBoot() Returns whether this server starts automatically when the Server Intelligence Agent is started.
int	getCommunicationProtocol() Returns the communication protocol used by the server.
IConfiguredContainer	getContainer() Returns the service container associated with this server.
java.lang.String	getCurrentCommandLine() Returns the command line that was used to launch the executable binary file for this server.
boolean	getCurrentDisabledState() Returns whether the server is currently disabled.
int	getEnterpriseNodeID() Returns the ID of the enterprise node associated with this server.
ExpectedRunState	getExpectedRunState() Returns the expected run state of the server.
java.util.Date	getExpectedRunStateTimeStamp() Returns the date and time of when the expected run state was last updated.
java.lang.String	getFriendlyName() Returns the BusinessObjects Enterprise friendly name of the server.
IConfiguredServices	getHostedServices() Returns a collection containing the service configuration information for each service that is hosted on this server.
IServerMetrics	getMetrics() Returns the metrics for this server and the services that it hosts.
java.lang.String	getName() Returns the server name.
int	getPID() Returns the process ID of this server process.
boolean	getRequiresRestart() Returns whether this server requires a restart.
java.lang.String	getServerAbbreviation() Returns the abbreviated name for this server as used in log file names, etc.
java.lang.Object	getServerAdmin() Deprecated. As of version 12.0.
java.lang.String	getServerDescriptor() Internal use Only
IServerDestinations	getServerDestinations() Returns an interface to the server destinations that exist for this server, or null if this server does not host a Destination Scheduling Service.
IServerGeneralMetrics	getServerGeneralAdmin() Deprecated. As of version 12.0.
java.lang.String	getServerID() Returns the Nameserver registered server ID.
java.lang.String	getServerIOR() Returns the server's unique identifier.
java.lang.String	getServerKind() Returns the registered server kind.
java.lang.String	getServerName() Returns the host name of the machine where the server is running.
java.lang.Object	getServiceAdminObject(java.lang.String serviceName) Deprecated. As of version 12.0.
java.lang.String	getSIAHostname() Returns the host name of the machine that is hosting the Server Intelligence Agent that manages this server.
java.lang.Object	getSingleSignOnAdmin() Deprecated. As of version 12.0.
ServerState	getState() Returns whether the server is running, stopped, or waiting for resources.
IStatusInfo	getStatusInfo() For internal use only.
boolean	isAlive() Returns whether the server is alive (running).
boolean	isDisabled() Returns whether the server is disabled.
boolean	isExclusive() Returns true if the current server is exclusive.
boolean	manageServer(int operation, int timeout, java.lang.String username, java.lang.String password) Deprecated. As of version 12.0, replaced by IServerBase.setExpectedRunState(com.crystaldecisions.sdk.plugin.desktop.server.ExpectedRunState).
void	setAutoBoot(boolean value) Sets whether this server starts automatically when the Server Intelligence Agent is started.
IConfiguredContainer	setContainer(int id) Specifies the service container associated with this server.
void	setDisabled(boolean b) Sets whether the server is disabled.
void	setEnterpriseNode(int id) Sets the ID of the enterprise node associated with this server.
void	setExclusive(boolean exclusive) Sets the current server to exclusive.
void	setExpectedRunState(ExpectedRunState state) Sets the expected run state of the server (started , stopped, disabled, etc.).
void	setFriendlyName(java.lang.String friendlyName) Sets the BusinessObjects Enterprise friendly name of the server.
void	setServerAbbreviation(java.lang.String abbreviation) For internal use only.
void	setServerKind(java.lang.String kind) For internal use only.

Field Detail

TYPEID

static final int TYPEID

The TypeId for Server objects.

See Also:

Constant Field Values

KIND

static final java.lang.String KIND

The Kind used to query for Server objects.

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

The ProgID for the Server Class.

ProgID	CrystalEnterprise.Server
Query Category	CI_SYSTEMOBJECTS
Associated Interface	com.crystaldecisions.sdk.plugin.desktop.server.IServer

Query syntax:

SELECT
	SI_FRIENDLY_NAME, SI_NAME, SI_SERVER_DESCRIPTOR, SI_SERVER_ID, SI_SERVER_IOR, SI_SERVER_IS_ALIVE, SI_SERVER_KIND, SI_SERVER_NAME
FROM
	CI_SYSTEMOBJECTS
WHERE
	SI_PROGID='CrystalEnterprise.Server'

The CePropertyIDs named in the SELECT statement are those that are required to access data through the IServer interface. For more information on their associations with the interface's methods, see IServer

See Also:

Constant Field Values

CE_SERVER_START

static final int CE_SERVER_START

Specifies that the server should be started.

See Also:

Constant Field Values

CE_SERVER_STOP

static final int CE_SERVER_STOP

Specifies that the server should be stopped.

See Also:

Constant Field Values

CE_SERVER_RESTART

static final int CE_SERVER_RESTART

Specifies that the server should be restarted.

See Also:

Constant Field Values

Method Detail

getServerName

java.lang.String getServerName()
                               throws SDKException

Returns the host name of the machine where the server is running.

To read this value, this object must contain the SI_SERVER_NAME property.

Returns:

String containing the name of the host name

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_SERVER_NAME

getServerDescriptor

java.lang.String getServerDescriptor()
                                     throws SDKException

Internal use Only

Throws:

SDKException

InfoObject properties to query for:

SI_SERVER_DESCRIPTOR

getServerID

java.lang.String getServerID()
                             throws SDKException

Returns the Nameserver registered server ID.

To read this value, this object must contain the SI_SERVER_ID property.

Returns:

A String containing the Nameserver registered server ID.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_SERVER_ID

getServerKind

java.lang.String getServerKind()
                               throws SDKException

Returns the registered server kind. Each server kind, such as File Server or Job Server, has a distinct value.

To read this value, this object must contain the SI_SERVER_KIND property.

Returns:

A String containing the registered server kind.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_SERVER_KIND

getServerAbbreviation

java.lang.String getServerAbbreviation()
                                       throws SDKException

Returns the abbreviated name for this server as used in log file names, etc.

To read this value, this object must contain the SI_SERVER_ABBREVIATION and SI_SERVER_KIND properties.

Returns:

A String containing the server abbreviation.

Throws:

SDKException - if the process is unsuccessful.

Since:

4.0

InfoObject properties to query for:

SI_SERVER_ABBREVIATION
SI_SERVER_KIND

getServerIOR

java.lang.String getServerIOR()
                              throws SDKException

Returns the server's unique identifier. This is the registered IOR.

To read this value, this object must contain the SI_SERVER_IOR property.

Returns:

A String containing the server's unique indentifier.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_SERVER_IOR

getFriendlyName

java.lang.String getFriendlyName()
                                 throws SDKException

Returns the BusinessObjects Enterprise friendly name of the server.

To read this value, this object must contain the SI_FRIENDLY_NAME property.

Returns:

String containing the friendly name of the server.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_FRIENDLY_NAME

setFriendlyName

void setFriendlyName(java.lang.String friendlyName)

Sets the BusinessObjects Enterprise friendly name of the server.

Parameters:

friendlyName - the friendly name of the server.

setServerKind

void setServerKind(java.lang.String kind)

For internal use only.

setServerAbbreviation

void setServerAbbreviation(java.lang.String abbreviation)

For internal use only.

Since:

4.0

getName

java.lang.String getName()
                         throws SDKException

Returns the server name.

To read this value, this object must contain the SI_NAME property.

Returns:

String containing the name.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_NAME

isDisabled

boolean isDisabled()
                   throws SDKException

Returns whether the server is disabled. This reflects the desired run state of the server as opposed to the actual run state. For example, if the server is currently enabled and there is a request to disable the server that has not completed, isDisabled returns true and IServerBase.getCurrentDisabledState() returns false.

To read this value, this object must contain the SI_DISABLED property.

Returns:

true if the server is disabled, false otherwise.

Throws:

SDKException - if the process is unsuccessful.

See Also:

IServerBase.getCurrentDisabledState()

InfoObject properties to query for:

SI_DISABLED

setDisabled

void setDisabled(boolean b)
                 throws SDKException

Sets whether the server is disabled.

Parameters:

b - true to disable the server or false to enable it.

Throws:

SDKException - if the process is unsuccessful.

getCurrentDisabledState

boolean getCurrentDisabledState()

Returns whether the server is currently disabled. For example, if the server is currently enabled and there is a request to disable the server that has not completed, IServerBase.isDisabled() returns true and getCurrentDisabledState returns false.

To read this value, this object must contain the SI_CURRENT_DISABLED_STATE property.

Returns:

true if the server is currently disabled, false otherwise.

See Also:

IServerBase.isDisabled()

InfoObject properties to query for:

SI_CURRENT_DISABLED_STATE

isAlive

boolean isAlive()
                throws SDKException

Returns whether the server is alive (running).

To read this value, this object must contain the SI_SERVER_IS_ALIVE property.

Returns:

true if the server is running, false otherwise.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_SERVER_IS_ALIVE

manageServer

boolean manageServer(int operation,
                     int timeout,
                     java.lang.String username,
                     java.lang.String password)
                     throws SDKException

Deprecated. As of version 12.0, replaced by IServerBase.setExpectedRunState(com.crystaldecisions.sdk.plugin.desktop.server.ExpectedRunState).

Starts, stops, or restarts a server. This method implicitly commits the server object to update the expected run state in the CMS.

Parameters:

operation - The requested state of the server. This includes running, stopped, and restart. This value should be one of the constants CE_SERVER_START, CE_SERVER_STOP, or CE_SERVER_RESTART.

timeout - Ignored.

username - Ignored.

password - Ignored.

Returns:

true if the value for expectedRunState was set to the requested state, false otherwise.

Throws:

java.lang.IllegalArgumentException - if the operation argument is invalid.

SDKException

InfoObject properties to query for:

SI_EXPECTED_RUN_STATE

getServerAdmin

java.lang.Object getServerAdmin()
                                throws SDKException

Deprecated. As of version 12.0.

Returns the administrative object to manage the server. Each server kind returns an object type specific to that server.

Returns:

Object containing the administrative object to manage this server. This object must be cast to the appropriate admin interface. For example, if the IServer object represents the CMS server, then the Object must be cast to ICMSAdmin. Other possible values are ICacheServerAdmin, IEventServerAdmin, IFileServerAdmin, IJobServerAdmin, IPageServerAdmin, and IWebiServerAdmin.

Throws:

SDKException - if the process is unsuccessful

See Also:

ICMSAdmin, ICacheServerAdmin, IPageServerAdmin, IEventServerAdmin, IFileServerAdmin, IJobServerAdmin, IWebiServerAdmin

getServerGeneralAdmin

IServerGeneralMetrics getServerGeneralAdmin()
                                            throws SDKException

Deprecated. As of version 12.0.

Returns generic server metrics. This method is not supported by Adaptive Processing Servers.

Returns:

com.crystaldecisions.sdk.occa.enadmin.IServerGeneralMetrics object that can be used to retrieve the generic server metrics.

Throws:

SDKException - if invoked on an Adaptive Processing Server or if the process is unsuccessful.

See Also:

IServerGeneralMetrics

getAuditAdmin

java.lang.Object getAuditAdmin()
                               throws SDKException

Deprecated. As of version 12.0.

Returns an administrative object that can be used to manage auditing on the server.

Returns:

Object that represents the administrative instance.

Throws:

SDKException - if the process is unsuccessful.

getSingleSignOnAdmin

java.lang.Object getSingleSignOnAdmin()
                                      throws SDKException

Deprecated. As of version 12.0.

Returns an administrative object that can be used to manage single sign-on (SSO) authentication.

Returns:

Object that represents the administrative instance.

Throws:

SDKException - if the process is unsuccessful.

See Also:

ICMSAdmin, IWebiServerAdmin, IPageServerAdmin, IReportAppServerAdmin

getCommunicationProtocol

int getCommunicationProtocol()
                             throws SDKException

Returns the communication protocol used by the server.

Returns:

An int of type CeCommunicationProtocol indicating the protocol being used

Throws:

SDKException - if the process is unsuccessful.

See Also:

IServerBase.CeCommunicationProtocol

InfoObject properties to query for:

SI_COMMUNICATION_PROTOCOL

getAdminServiceNames

java.lang.String[] getAdminServiceNames()
                                        throws SDKException

Deprecated. As of version 12.0.

Returns the names of the administrative services that are exposed by this server.

Returns:

An array containing the administrative service names.

Throws:

SDKException - if the process is unsuccessful.

See Also:

IServerBase.getServiceAdminObject(java.lang.String)

InfoObject properties to query for:

SI_SERVER_KIND
SI_SERVER_IS_ALIVE

getServiceAdminObject

java.lang.Object getServiceAdminObject(java.lang.String serviceName)
                                       throws SDKException

Deprecated. As of version 12.0.

Returns a generic administrative object that supports the requested service.

Parameters:

serviceName - the name of the administrative service.

Returns:

Object that supports the requested service.

Throws:

SDKException - if the process is unsuccessful.

See Also:

IServerBase.getAdminServiceNames()

getExpectedRunState

ExpectedRunState getExpectedRunState()

Returns the expected run state of the server.

To read this value, this object must contain the SI_EXPECTED_RUN_STATE property.

the current run state.

See Also:

IServerBase.getState()

InfoObject properties to query for:

SI_EXPECTED_RUN_STATE

setExpectedRunState

void setExpectedRunState(ExpectedRunState state)

Sets the expected run state of the server (started , stopped, disabled, etc.).

Parameters:

state - The run state for the server.

getExpectedRunStateTimeStamp

java.util.Date getExpectedRunStateTimeStamp()
                                            throws SDKException

Returns the date and time of when the expected run state was last updated.

Returns:

A Date identifying the last time the expected run state was updated.

Throws:

SDKException

InfoObject properties to query for:

SI_EXPECTED_RUN_STATE_TS

getState

ServerState getState()

Returns whether the server is running, stopped, or waiting for resources.

Returns:

The current server state.

See Also:

IServerBase.getExpectedRunState()

InfoObject properties to query for:

SI_SERVER_IS_ALIVE
SI_SERVER_WAITING_FOR_RESOURCES

getAutoBoot

boolean getAutoBoot()

Returns whether this server starts automatically when the Server Intelligence Agent is started.

To read this value, this object must contain the SI_AUTOBOOT property.

Returns:

true if autoboot is on, false otherwise.

InfoObject properties to query for:

SI_AUTOBOOT

setAutoBoot

void setAutoBoot(boolean value)

Sets whether this server starts automatically when the Server Intelligence Agent is started. If set to true, the Server Intelligence Agent will start this server at startup.

Parameters:

value - true to turn on autoboot, false otherwise.

getHostedServices

IConfiguredServices getHostedServices()
                                      throws SDKException

Returns a collection containing the service configuration information for each service that is hosted on this server.

To read this value, this object must contain the SI_HOSTED_SERVICES property.

Returns:

com.businessobjects.sdk.plugin.desktop.common.IConfiguredServices containing configuration information for services hosted on this server.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_HOSTED_SERVICES

setContainer

IConfiguredContainer setContainer(int id)
                                  throws SDKException

Specifies the service container associated with this server.

Parameters:

id - The service container ID

Returns:

com.businessobjects.sdk.plugin.desktop.common.IConfiguredContainer containing configuration information for the service container associated with this server.

Throws:

SDKException - if the process is unsuccessful.

getContainer

IConfiguredContainer getContainer()
                                  throws SDKException

Returns the service container associated with this server.

Returns:

com.businessobjects.sdk.plugin.desktop.common.IConfiguredContainer containing configuration information for the service container associated with this server.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_CONFIGURED_CONTAINERS

getEnterpriseNodeID

int getEnterpriseNodeID()

Returns the ID of the enterprise node associated with this server. A return value of 0 indicates there is no no enterprise node assigned.

Returns:

The ID of the enterprise node associated with this server.

See Also:

IEnterpriseNode

InfoObject properties to query for:

SI_ENTERPRISENODE

setEnterpriseNode

void setEnterpriseNode(int id)

Sets the ID of the enterprise node associated with this server.

Parameters:

id - The ID of the enterprise node

See Also:

IEnterpriseNode

getPID

int getPID()

Returns the process ID of this server process.

Returns:

The process ID of this server.

InfoObject properties to query for:

SI_PID

getServerDestinations

IServerDestinations getServerDestinations()
                                          throws SDKException

Returns an interface to the server destinations that exist for this server, or null if this server does not host a Destination Scheduling Service.

Returns:

An interface to the available service destinations.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_HOSTED_SERVICES

getStatusInfo

IStatusInfo getStatusInfo()

For internal use only.

InfoObject properties to query for:

SI_STATUSINFO

getMetrics

IServerMetrics getMetrics()
                          throws SDKException

Returns the metrics for this server and the services that it hosts.

Returns:

The metrics for this server.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_METRICS

getRequiresRestart

boolean getRequiresRestart()

Returns whether this server requires a restart. The server may require a restart if certain configuration property values have changed since the last time it was started.

Returns:

true if this server needs a restart, false otherwise.

InfoObject properties to query for:

SI_REQUIRES_RESTART

getCurrentCommandLine

java.lang.String getCurrentCommandLine()

Returns the command line that was used to launch the executable binary file for this server.

Returns:

String containing the command line.

InfoObject properties to query for:

SI_CURRENT_COMMAND_LINE

getSIAHostname

java.lang.String getSIAHostname()

Returns the host name of the machine that is hosting the Server Intelligence Agent that manages this server.

Returns:

String containing the host name.

InfoObject properties to query for:

SI_SIA_HOSTNAME

isExclusive

boolean isExclusive()

Returns true if the current server is exclusive. An exclusive server will not be visible in the server common pool.

Returns:

Integer representing if the server is exclusive

InfoObject properties to query for:

SI_EXCLUSIVE

setExclusive

void setExclusive(boolean exclusive)

Sets the current server to exclusive. An exclusive server will not be visible in the server common pool.

Parameters:

exclusive - Boolean representing if the server is exclusive