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

IEnterprisePrincipal	authenticate(java.lang.String userName, java.lang.String password, java.lang.String cmsName, java.lang.String authentication, int validMinutes) Authenticates the session manager and returns the IEnterprisePrincipal.
IEnterpriseLogonInformation	createLogonInfo() Creates a new IEnterpriseLogonInformation object.
ITrustedPrincipal	createTrustedPrincipal(java.lang.String userName, java.lang.String cmsName) Creates a new ITrustedPrincipal trusted principal object.
ITrustedPrincipal	createTrustedPrincipal(java.lang.String userName, java.lang.String cmsName, java.lang.String sharedSecret) Creates a new ITrustedPrincipal object.
java.lang.String[]	getInstalledAuthIDs() Returns a collection of available authentication methods.
ILanguageMgr	getLanguageMgr() Creates a new ILanguageMgr object.
IEnterpriseSession	getSession(java.lang.String serializedSessionString) Constructs an enterprise session from a serialized session string
IEnterpriseSession	logon(org.ietf.jgss.GSSCredential UserCreds, org.ietf.jgss.GSSManager Manager, java.lang.String CMSName, java.lang.String Authentication) Logs on to the specified CMS or Cluster.
IEnterpriseSession	logon(org.ietf.jgss.GSSCredential UserCreds, org.ietf.jgss.GSSManager Manager, java.lang.String CMSName, java.lang.String Authentication, IEnterpriseLogonInformation LogonInfo) Logs on to the specified CMS or Cluster.
IEnterpriseSession	logon(java.security.Principal principal) Logs on to the CMS using the principal.
IEnterpriseSession	logon(java.security.Principal principal, IEnterpriseLogonInformation LogonInfo) Logs on to the CMS using the principal.
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	logonEx(java.lang.String UserName, java.lang.String Password, java.lang.String CMSName, java.lang.String Authentication, IEnterpriseLogonInformation LogonInfo) Logs on to the specified CMS or Cluster.
IEnterpriseSession	logonWithToken(java.lang.String token) Logs on to the CMS using a previously obtained token.
IEnterpriseSession	logonWithToken(java.lang.String trustedCMS, java.lang.String token) Logs on to a trusted CMS using a previously obtained token.
IEnterpriseSession	logonWithTokenEx(java.lang.String token, IEnterpriseLogonInformation LogonInfo) Logs on to the CMS using a previously obtained token.
IEnterpriseSession	logonWithTokenEx(java.lang.String trustedCMS, java.lang.String token, IEnterpriseLogonInformation LogonInfo) Logs on to a trusted CMS using a previously obtained token.
java.lang.String	nameFromProgID(java.lang.String ProgId) Returns the localized friendly name for an authentication ProgId.
void	release(java.security.Principal principal) Releases this principal from the Enterprise system.
void	setSOCKSURI(java.lang.String SocksURI) Sets the SOCKsURI of the server which is being logged on to.

Method Detail

getInstalledAuthIDs

java.lang.String[] getInstalledAuthIDs()

Returns a collection of available authentication methods.

Returns:

An array of String objects containing the available authentication methods.

logon

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.

logon

IEnterpriseSession logon(org.ietf.jgss.GSSCredential UserCreds,
                         org.ietf.jgss.GSSManager Manager,
                         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:

UserCreds - User's GSSCredential

Manager - GSSManager that accompanies UserCreds

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.

logon

IEnterpriseSession logon(org.ietf.jgss.GSSCredential UserCreds,
                         org.ietf.jgss.GSSManager Manager,
                         java.lang.String CMSName,
                         java.lang.String Authentication,
                         IEnterpriseLogonInformation LogonInfo)
                         throws SDKException

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

Parameters:

UserCreds - User's GSSCredential

Manager - GSSManager that accompanies UserCreds

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

Authentication - The authentication method to use.

LogonInfo - The information about current logon.

Returns:

The IEnterpriseSession obtained with the specified parameters.

Throws:

SDKException - This is thrown if the logon is unsuccessful.

Since:

4.0

logonEx

IEnterpriseSession logonEx(java.lang.String UserName,
                           java.lang.String Password,
                           java.lang.String CMSName,
                           java.lang.String Authentication,
                           IEnterpriseLogonInformation LogonInfo)
                           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.

LogonInfo - The information about current logon.

Returns:

The IEnterpriseSession obtained with the specified parameters.

Throws:

SDKException - This is thrown if the logon is unsuccessful.

logonWithToken

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

logonWithToken

IEnterpriseSession logonWithToken(java.lang.String trustedCMS,
                                  java.lang.String token)
                                  throws SDKException

Logs on to a trusted CMS using a previously obtained token.

Parameters:

trustedCMS - A String trusted cms name

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

logonWithTokenEx

IEnterpriseSession logonWithTokenEx(java.lang.String token,
                                    IEnterpriseLogonInformation LogonInfo)
                                    throws SDKException

Logs on to the CMS using a previously obtained token.

Parameters:

token - A String containing the previously obtained token.

LogonInfo - The information about current logon.

Returns:

The IEnterpriseSession obtained with the specified token.

Throws:

SDKException - This is thrown if the logon is unsuccessful.

See Also:

ILogonTokenMgr

logonWithTokenEx

IEnterpriseSession logonWithTokenEx(java.lang.String trustedCMS,
                                    java.lang.String token,
                                    IEnterpriseLogonInformation LogonInfo)
                                    throws SDKException

Logs on to a trusted CMS using a previously obtained token.

Parameters:

trustedCMS - A String trusted cms name

token - A String containing the previously obtained token.

LogonInfo - The information about current logon.

Returns:

The IEnterpriseSession obtained with the specified token.

Throws:

SDKException - This is thrown if the logon is unsuccessful.

See Also:

ILogonTokenMgr

nameFromProgID

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

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

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.

authenticate

IEnterprisePrincipal authenticate(java.lang.String userName,
                                  java.lang.String password,
                                  java.lang.String cmsName,
                                  java.lang.String authentication,
                                  int validMinutes)
                                  throws SDKException

Authenticates the session manager and returns the IEnterprisePrincipal.

Parameters:

userName - A String that represents the user name to be authenticated.

password - A String that represents the password for the specified user.

cmsName - A String that represents the name of the cms or cluster to authenticate to.

authentication - A String that represents the authentication method to use.

validMinutes - An int that represents the number of minutes that the principal will be valid for. It must be greater than zero but less than 24 hours (1440 minutes).

Returns:

An IEnterprisePrincipal that is constructed object upon authentication.

Throws:

SDKException

release

void release(java.security.Principal principal)
             throws SDKException

Releases this principal from the Enterprise system.

Parameters:

principal - A java.security.Principal object.

Throws:

SDKException - This is thrown if the process is unsuccessful.

logon

IEnterpriseSession logon(java.security.Principal principal)
                         throws SDKException

Logs on to the CMS using the principal.

Parameters:

principal - A java.security.Principal object.

Returns:

An IEnterprisePrincipal object that is constructed upon logon.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

ITrustedPrincipal

logon

IEnterpriseSession logon(java.security.Principal principal,
                         IEnterpriseLogonInformation LogonInfo)
                         throws SDKException

Logs on to the CMS using the principal.

Parameters:

principal - A java.security.Principal object.

LogonInfo - The information about current logon.

Returns:

An IEnterprisePrincipal object that is constructed upon logon.

Throws:

SDKException - This is thrown if the process is unsuccessful.

Since:

4.0

See Also:

ITrustedPrincipal

createTrustedPrincipal

ITrustedPrincipal createTrustedPrincipal(java.lang.String userName,
                                         java.lang.String cmsName)
                                         throws SDKException

Creates a new ITrustedPrincipal trusted principal object. The shared secret is loaded from a TrustedPrincipal.conf where its location is specified by the System property bobj.trustedauth.home, and can be set by:
System.setProperty("bobj.trustedauth.home", "c:\\location")
If bobj.trustedauth.home is not specified, then the config file is loaded from the BOE's bin dir. i.e. On windows, C:\Program Files\Business Objects\BusinessObjects Enterprise 12.0\win32_x86

Parameters:

userName - A String that contains the user name.

cmsName - A String that contains the CMS name.

Returns:

A new ITrustedPrincipal trusted principal object.

Throws:

SDKException - This is thrown if the process is unsuccessful.

createTrustedPrincipal

ITrustedPrincipal createTrustedPrincipal(java.lang.String userName,
                                         java.lang.String cmsName,
                                         java.lang.String sharedSecret)
                                         throws SDKException

Creates a new ITrustedPrincipal object.

Lets you set a sharedSecret through the SDK, without having to use the createTrustedPrincipal config file.

Note: New method added as of version 11.5.6.537 released July 4 2006.

Parameters:

userName - A String that contains the user name.

cmsName - A String that contains the CMS name.

sharedSecret - A String that contains a sharedSecret.

Returns:

A new ITrustedPrincipal trusted principal object.

Throws:

SDKException - This is thrown if the process is unsuccessful.

createLogonInfo

IEnterpriseLogonInformation createLogonInfo()

Creates a new IEnterpriseLogonInformation object.

Lets you set extra logon information like IP/Host of the client doing the logon, that will be used for auditing if enabled.

Returns:

A new IEnterpriseLogonInformation Enterprise Logon Information object.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getLanguageMgr

ILanguageMgr getLanguageMgr()

Creates a new ILanguageMgr object.

Lets you set retrieve language information that current installed or supported..

Returns:

A new ILanguageMgr Lanaguage Manager object.

Throws:

SDKException - This is thrown if the process is unsuccessful.