com.crystaldecisions.sdk.framework
Interface ISessionMgr

public interface ISessionMgr

This is the basic, top level client side object. This interface defines the ISessionMgr object, which includes the methods that must be called when a user attempts to access the BusinessObjects Enterprise system.

Method Summary

java.lang.String[]	getInstalledAuthIDs() Returns a collection of available authentication methods.
IEnterpriseSession	getSession(java.lang.String serializedSessionString) Constructs an enterprise session from a serialized session string.
IEnterpriseSession	logon(java.lang.String UserName, java.lang.String Password, java.lang.String CMSName, java.lang.String Authentication) Logs on to the specified CMS or Cluster.
IEnterpriseSession	logonWithToken(java.lang.String token) Logs on to the CMS using a previously obtained token.
java.lang.String	nameFromProgID(java.lang.String ProgId) Returns the localized friendly name for an authentication ProgId.
void	setSOCKSURI(java.lang.String SocksURI) Sets the SOCKsURI of the server which is being logged on to.

Method Detail

getInstalledAuthIDs

public java.lang.String[] getInstalledAuthIDs()

Returns a collection of available authentication methods.

Returns:

An array of String objects containing the available authentication methods.

logon

public IEnterpriseSession logon(java.lang.String UserName,
                                java.lang.String Password,
                                java.lang.String CMSName,
                                java.lang.String Authentication)
                         throws SDKException

Logs on to the specified CMS or Cluster. Cluster names start with the '@' character. Use getInstalledAuthProgIds for possible authentication values.

Parameters:

UserName - The user name to logon with.

Password - The password for the specified user name.

CMSName - The name of the CMS or cluster to log on to.

Authentication - The authentication method to use.

Returns:

The IEnterpriseSession obtained with the specified parameters.

Throws:

SDKException - This is thrown if the logon is unsuccessful.

logonWithToken

public IEnterpriseSession logonWithToken(java.lang.String token)
                                  throws SDKException

Logs on to the CMS using a previously obtained token.

Parameters:

token - A String containing the previously obtained token.

Returns:

The IEnterpriseSession obtained with the specified token.

Throws:

SDKException - This is thrown if the logon is unsuccessful.

See Also:

ILogonTokenMgr

nameFromProgID

public java.lang.String nameFromProgID(java.lang.String ProgId)

Returns the localized friendly name for an authentication ProgId.

Parameters:

ProgId - The ProgId for which the friendly name should be returned.

Returns:

A String containing the localized friendly name for the specified authentication ProgId.

setSOCKSURI

public void setSOCKSURI(java.lang.String SocksURI)

Sets the SOCKsURI of the server which is being logged on to. An empty string means there is no SOCKsURI.

Parameters:

SocksURI - The SOCKsURI as a String.

getSession

public IEnterpriseSession getSession(java.lang.String serializedSessionString)
                              throws SDKException

Constructs an enterprise session from a serialized session string.

Parameters:

serializedSessionString - Serialized session string

Returns:

An enterprise session

Throws:

SDKException - This is thrown if the process is unsuccessful.