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

All Known Subinterfaces:
IServer

public interface IServerBase

This interface manages the server, provides general information on the server, and retrieves the administration library specific to the server kind. Management of the server includes starting, stopping, restarting, enabling, and disabling the server. Information is specific to the server itself as well as the general metrics available in the IServerGeneralMetrics interface. The administration libraries can be used to obtain detailed information on the kind of server, as well as to make calls specific to the management of that server kind.


Nested Class Summary
static interface IServerBase.CeCommunicationProtocol
          The communication protocol the server is running under
 
Field Summary
static int CE_SERVER_RESTART
           This constant value specifies that the server should be restarted.
static int CE_SERVER_START
           This constant value specifies that the server should be started.
static int CE_SERVER_STOP
           This constant value specifies that the server should be stopped.
 
Method Summary
 java.lang.Object getAuditAdmin()
           Returns the administrative object to manage the auditing.
 int getCommunicationProtocol()
          Returns the communication protocol the server is running under
 java.lang.String getFriendlyName()
           Returns the BusinessObjects Enterprise Friendly Name of the server.
 java.lang.String getName()
           Returns the SI_NAME.
 java.lang.Object getServerAdmin()
           Returns the administrative object to manage the server.
 java.lang.String getServerDescriptor()
           Returns the type of BusinessObjects Enterprise server.
 IServerGeneralMetrics getServerGeneralAdmin()
           Returns the IServerGeneralMetrics object that is used to retrieve generic server metrics.
 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 name of the host (machine) where the server is running.
 java.lang.Object getSingleSignOnAdmin()
           Returns the administrative object that allows you to manage single sign-on (SSO) authentication.
 boolean isAlive()
           Returns true if the server is alive (running), and false otherwise.
 boolean isDisabled()
           Returns true if the server is disabled, and false otherwise.
 boolean manageServer(int operation, int timeout, java.lang.String username, java.lang.String password)
           Starts, stops, or restarts a server.
 void setDisabled(boolean b)
           Sets whether the server is disabled.
 

Field Detail

CE_SERVER_START

public static final int CE_SERVER_START

This constant value specifies that the server should be started.

See Also:
Constant Field Values

CE_SERVER_STOP

public static final int CE_SERVER_STOP

This constant value specifies that the server should be stopped.

See Also:
Constant Field Values

CE_SERVER_RESTART

public static final int CE_SERVER_RESTART

This constant value specifies that the server should be restarted.

See Also:
Constant Field Values
Method Detail

getServerName

public java.lang.String getServerName()
                               throws SDKException

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

Returns:
A String containing the name of the host (machine) where the server is running.
Throws:
SDKException - This is thrown if the process is unsuccessful.

getServerDescriptor

public java.lang.String getServerDescriptor()
                                     throws SDKException

Returns the type of BusinessObjects Enterprise server.

Returns:
A String containing the type of the BusinessObjects Enterprise server.
Throws:
SDKException - This is thrown if the process is unsuccessful.

getServerID

public java.lang.String getServerID()
                             throws SDKException

Returns the Nameserver registered server ID.

Returns:
A String containing the Nameserver registered server ID.
Throws:
SDKException - This is thrown if the process is unsuccessful.

getServerKind

public 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.

Returns:
A String containing the registered server kind.
Throws:
SDKException - This is thrown if the process is unsuccessful.

getServerIOR

public java.lang.String getServerIOR()
                              throws SDKException

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

Returns:
A String containing the server's unique indentifier.
Throws:
SDKException - This is thrown if the process is unsuccessful.

getFriendlyName

public java.lang.String getFriendlyName()
                                 throws SDKException

Returns the BusinessObjects Enterprise Friendly Name of the server.

Returns:
A String containing the BusinessObjects Enterprise Friendly Name of the server.
Throws:
SDKException - This is thrown if the process is unsuccessful.

getName

public java.lang.String getName()
                         throws SDKException

Returns the SI_NAME.

Returns:
A String containing the name.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
CePropertyID.SI_NAME

isDisabled

public boolean isDisabled()
                   throws SDKException

Returns true if the server is disabled, and false otherwise.

Returns:
true if the server is disabled, false otherwise.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setDisabled

public void setDisabled(boolean b)
                 throws SDKException

Sets whether the server is disabled. This value should be true if the server is to be disabled, and false otherwise.

Parameters:
b - true if the server is disabled, false otherwise.
Throws:
SDKException - This is thrown if the process is unsuccessful.

isAlive

public boolean isAlive()
                throws SDKException

Returns true if the server is alive (running), and false otherwise.

Returns:
true if the server is alive (running), false otherwise.
Throws:
SDKException - This is thrown if the process is unsuccessful.

manageServer

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

Starts, stops, or restarts a server. Optional parameters include operating system user name and password to authenticate with a remote server, as well as a time-out for setting the length of time before the attempt to change the state of the service will fail. This method returns true if service is already on the requested state.

Parameters:
operation - The type of operation to perform on the server. This includes starting, stopping, and restarting. This value should be one of the constants CE_SERVER_START, CE_SERVER_STOP, or CE_SERVER_RESTART.
timeout - The amount of time, in seconds, before the attempt to change the state of the service will fail. This value is set by default to 20 seconds.
username - The operating system user name. The user must have the privileges to start or stop the related service. This parameter can be null if the SDK is on the Windows platform, which means the current user priviledges will be used.
password - The operating system password.
Returns:
true if service is already in the requested state.
Throws:
SDKException.InvalidOperation - if trying to stop a Windows server from a Unix SDK.
SDKException - This is thrown if the specified operation failed.
java.lang.IllegalArgumentException - if the operation argument is invalid.
java.lang.IllegalArgumentException - if the timeout argument is negative.

getServerAdmin

public java.lang.Object getServerAdmin()
                                throws SDKException

Returns the administrative object to manage the server. Each server kind will return a different object type specific to that server.

Returns:
An Object containing the administrative object to manage this server. The type that this Object can be cast as depends on the type of server. For example, if the current IServer object represents the CMS server, then the Object returned by this method can be cast as an ICMSAdmin object. Other possible values are ICacheServerAdmin, IEventServerAdmin, IFileServerAdmin, IJobServerAdmin, IPageServerAdmin, and IWebiServerAdmin.
Throws:
SDKException - This is thrown if the process is unsuccessful
See Also:
ICMSAdmin, ICacheServerAdmin, IPageServerAdmin, IEventServerAdmin, IFileServerAdmin, IJobServerAdmin, IWebiServerAdmin

getServerGeneralAdmin

public IServerGeneralMetrics getServerGeneralAdmin()
                                            throws SDKException

Returns the IServerGeneralMetrics object that is used to retrieve generic server metrics.

Returns:
An IServerGeneralMetrics object that is used to retrieve generic server metrics.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
IServerGeneralMetrics

getAuditAdmin

public java.lang.Object getAuditAdmin()
                               throws SDKException

Returns the administrative object to manage the auditing.

Returns:
An Object that represents the administrative instance.
Throws:
SDKException - This is thrown if the process is unsuccessful.

getSingleSignOnAdmin

public java.lang.Object getSingleSignOnAdmin()
                                      throws SDKException

Returns the administrative object that allows you to manage single sign-on (SSO) authentication.

Returns:
An Object that represents the administrative instance.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
ICMSAdmin, IWebiServerAdmin, IPageServerAdmin, IReportAppServerAdmin

getCommunicationProtocol

public int getCommunicationProtocol()
                             throws SDKException
Returns the communication protocol the server is running under

Returns:
An int of type CeCommunicationProtocol indicating communication protocol being used
Throws:
SDKException
See Also:
IServerBase.CeCommunicationProtocol