com.crystaldecisions.sdk.framework
Interface IEnterpriseSession

public interface IEnterpriseSession

IEnterpriseSession is the first object to be acquired. It precedes the creation of any other Enterprise components. It combines both the name service and the client-side security objects, and also provides the Service property that makes it possible for users to retrieve the object that gives them access to services on the CMS machine.

Nested Class Summary

static interface

IEnterpriseSession.CeEnterpriseVersion Constants for the BusinessObjects Enterprise Version

Field Summary

static int	CE_APS_VERSION_850 Deprecated. should use IEnterpriseSession.CeEnterpriseVersion.VERSION11_0 instead.
static int	CE_SERVICE_ADMIN_SERVICES Return only administration services.
static int	CE_SERVICE_ALL_SERVICES Return all available services.

Method Summary

java.lang.String	getAPSName() Deprecated. should use getCMSName() instead.
int	getAPSVersion() Deprecated. should use getEnterpriseVersion() instead.
java.lang.String[]	getClusterMembers() Returns a list of CMS machines in the cluster.
java.lang.String	getClusterName() Name of the cluster to which the user is connected.
java.lang.String	getCMSName() Returns the name of the CMS machine to which a connection is currently made.
int	getEnterpriseVersion() Returns the version number of the BusinessObjects Enterprise system to which a connection is currently made.
ILogonTokenMgr	getLogonTokenMgr() Retrieves the LogonTokenMgr object.
IPluginMgr	getPluginManager() Retrieves the PluginManager object.
java.lang.String	getSerializedSession() Gets a string of a serialized session.
java.lang.String[]	getServerNames() Returns a list of available servers.
java.lang.Object	getService(java.lang.String ServiceName) Returns an object to use a specific service exposed by the enterprise framework.
java.lang.Object	getService(java.lang.String ServerName, java.lang.String ServiceName) Returns an object to use a specific service exposed by a server.
java.lang.String[]	getServiceNames(java.lang.String ServerName, int type) Returns a list of available services on a particular server.
IProperties	getSystemInfoProperties() Returns a list of properties that describe the capabilities of the system you have installed.
IUserInfo	getUserInfo() Retrieves the UserInfo object, which has information about the user who created the session.
void	logoff() Logs the user off this current session.

Field Detail

CE_SERVICE_ALL_SERVICES

public static final int CE_SERVICE_ALL_SERVICES

Return all available services.

See Also:

Constant Field Values

CE_SERVICE_ADMIN_SERVICES

public static final int CE_SERVICE_ADMIN_SERVICES

Return only administration services.

See Also:

Constant Field Values

CE_APS_VERSION_850

public static final int CE_APS_VERSION_850

Deprecated. should use IEnterpriseSession.CeEnterpriseVersion.VERSION11_0 instead.

CMS Version 8.5.

See Also:

Constant Field Values

Method Detail

getAPSName

public java.lang.String getAPSName()

Deprecated. should use getCMSName() instead.

Returns the name of the CMS machine to which a connection is currently made.

Returns:

A String containing the CMS name.

getCMSName

public java.lang.String getCMSName()

Returns the name of the CMS machine to which a connection is currently made.

Returns:

A String containing the CMS name.

getEnterpriseVersion

public int getEnterpriseVersion()
                         throws SDKException

Returns the version number of the BusinessObjects Enterprise system to which a connection is currently made.

Returns:

An int containing the Enterprise version.

SDKException

getAPSVersion

public int getAPSVersion()
                  throws SDKException

Deprecated. should use getEnterpriseVersion() instead.

Returns the version number of the CMS machine to which a connection is currently made.

Returns:

An int containing the CMS version.

SDKException

getClusterMembers

public java.lang.String[] getClusterMembers()
                                     throws SDKException

Returns a list of CMS machines in the cluster.

Returns:

An array of String objects containing the CMS machines in the cluster.

SDKException

getClusterName

public java.lang.String getClusterName()

Name of the cluster to which the user is connected.

Returns:

A String containing the name of the cluster to which the user is connected.

getLogonTokenMgr

public ILogonTokenMgr getLogonTokenMgr()
                                throws SDKException

Retrieves the LogonTokenMgr object.

Returns:

The ILogonTokenMgr object.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getPluginManager

public IPluginMgr getPluginManager()
                            throws SDKException

Retrieves the PluginManager object.

Returns:

The IPluginMgr object.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getServerNames

public java.lang.String[] getServerNames()
                                  throws SDKException

Returns a list of available servers.

Returns:

An array of String objects containing a list of available servers.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getServiceNames

public java.lang.String[] getServiceNames(java.lang.String ServerName,
                                          int type)
                                   throws SDKException

Returns a list of available services on a particular server.

Parameters:

ServerName - A String containing the name of the server to retrieve the information from.

type - This value should be either 0 or 1. 0 denotes that all available services will be returned, while 1 denotes that only administrative services will be returned.

Returns:

An array of String objects containing a list of available services.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getService

public java.lang.Object getService(java.lang.String ServerName,
                                   java.lang.String ServiceName)
                            throws SDKException

Returns an object to use a specific service exposed by a server. If ServerName is empty, the current CMS will be used. This is currently implemented only for InfoStore service.

Parameters:

ServerName - A String specifying the name of the CMS server to connect to.

ServiceName - A String specifying the type of service to retrieve. Currently this can only be "InfoStore".

Returns:

An Object containing the requested service. Currently this object can only be of type IInfoStore.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getService

public java.lang.Object getService(java.lang.String ServiceName)
                            throws SDKException

Returns an object to use a specific service exposed by the enterprise framework. The services that can be retrieved by this overload are the ones exposed by the CMS server or available as global services.

Parameters:

ServiceName - A String specifying the type of service to retrieve. Currently this can only be "InfoStore".

Returns:

An Object containing the requested service. Currently this object can only be of type IInfoStore.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getSystemInfoProperties

public IProperties getSystemInfoProperties()
                                    throws SDKException

Returns a list of properties that describe the capabilities of the system you have installed.

Returns:

An IProperties object containing a list of properties that describe the capabilities of the system you have installed.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getUserInfo

public IUserInfo getUserInfo()
                      throws SDKException

Retrieves the UserInfo object, which has information about the user who created the session.

Returns:

The IUserInfo object.

Throws:

SDKException - This is thrown if the process is unsuccessful.

logoff

public void logoff()

Logs the user off this current session. This must be called once the session will no longer be used, otherwise, system resources will stay in use and the license use count on the CMS cluster will not be updated properly.

getSerializedSession

public java.lang.String getSerializedSession()
                                      throws SDKException

Gets a string of a serialized session.

Returns:

a string of a serialized session.

Throws:

SDKException - This is thrown if the process is unsuccessful.