com.businessobjects.jsf.sdk.model
Interface IIdentity


public interface IIdentity

A bean that provides the capability to log on and log off Crystal Enterprise, and manages internal references to Crystal Enterprise.


Method Summary
 java.lang.String getCookieName()
          Gets the name of the cookie that is used to store session information in the browser.
 IEnterpriseSession getEnterpriseSession()
          Gets the Enterprise session data representing a user that has logged in to Crystal Enterprise.
 java.lang.String getErrorMsg()
          Gets the last error message.
 java.lang.String getID()
          Gets the unique identifier for an instance of an Identity bean.
 IInfoStore getInfoStore()
          Gets the IInfostore object associated with the enterprise session.
 java.util.Locale getLocale()
          Returns whether the user can see the User Folder.
 java.lang.String getPassword()
          Gets the password to use when logging in.
 java.lang.String getSelectedAuthentication()
          Gets the default authentication type to use when logging in.
 java.lang.String getSystem()
          Gets the name of the Crystal Enterprise system to log on to.
 java.lang.String getToken()
          Gets the Enterprise session token for the logged on user.
 int getTokenExpiry()
          Gets the number of minutes the Enterprise session token is valid before expiring.
 java.lang.String getUserName()
          Gets the name of the user to use when logging in.
 java.lang.String getUserRootFolder()
          Gets the user's root folder.
 java.lang.String[] getVisibleAuthentications()
          Gets the list of visible authentication types in the drop-down list.
 boolean isEnableAutoLogon()
          Gets a value indicating whether or not the Identity bean automatically logs in to Crystal Enterprise.
 boolean isLoggedOn()
          Gets the logged in status of the user.
 boolean isLoggedOnAuto()
          Gets whether the user was automatically logged on.
 void logoff()
          Logs a user off a Crystal Enterprise session.
 boolean logon()
          Logs the user on to the Crystal Enterprise session.
 boolean logon(java.lang.String name, java.lang.String password)
          Logs the user on to the Crystal Enterprise session.
 boolean logon(java.lang.String name, java.lang.String password, java.lang.String system)
          Logs the user on to the Crystal Enterprise session.
 boolean logon(java.lang.String name, java.lang.String password, java.lang.String system, java.lang.String authentication)
          Logs the user on to the Crystal Enterprise session.
 void setCookieName(java.lang.String value)
          Sets the name of the cookie that is used to store session information in the browser.
 void setEnableAutoLogon(boolean enableAutoLogon)
          Sets a value indicating whether or not the Identity bean automatically logs in to Crystal Enterprise.
 void setID(java.lang.String newId)
          Sets the unique identifier for an instance of an Identity bean.
 void setLocale(java.util.Locale value)
          Sets the locale to use for the user.
 void setPassword(java.lang.String password)
          Sets the password to use when logging in.
 void setSelectedAuthentication(java.lang.String auth)
          Sets the default authentication type to use when logging in.
 void setSystem(java.lang.String cms)
          Sets the name of the Crystal Enterprise system to log on to.
 void setTokenExpiry(int tokenExpiry)
          Sets the number of minutes the Enterprise session token is valid before expiring.
 void setUserName(java.lang.String user)
          Sets the name of the user to use when logging in.
 void setVisibleAuthentications(java.lang.String[] visibleAuthentications)
          Sets the list of visible authentication types in the drop-down list.
 

Method Detail

setID

public void setID(java.lang.String newId)

Sets the unique identifier for an instance of an Identity bean.

Parameters:
newId - a String that specifies the identifier for the Identity bean

getID

public java.lang.String getID()

Gets the unique identifier for an instance of an Identity bean.

Returns:
a String that specifies the unique identifier for the Identity bean

getSystem

public java.lang.String getSystem()

Gets the name of the Crystal Enterprise system to log on to.

Returns:
a String that specifies the name of the Crystal Enterprise system to log on to

setSystem

public void setSystem(java.lang.String cms)

Sets the name of the Crystal Enterprise system to log on to.

Parameters:
cms - a String that specifies the name of the Crystal Enterprise system to log on to

getUserName

public java.lang.String getUserName()

Gets the name of the user to use when logging in.

Returns:
a String that specifies the name of the user to use when logging in

setUserName

public void setUserName(java.lang.String user)

Sets the name of the user to use when logging in.

Parameters:
user - a String that specifies the name of the user to use when logging in

getSelectedAuthentication

public java.lang.String getSelectedAuthentication()

Gets the default authentication type to use when logging in.

Returns:
a String that specifies the default authentication type to use when logging in

setSelectedAuthentication

public void setSelectedAuthentication(java.lang.String auth)

Sets the default authentication type to use when logging in.

Parameters:
auth - a String that specifies the default authentication type to use when logging in

getPassword

public java.lang.String getPassword()

Gets the password to use when logging in.

Returns:
a String that specifies the password to use when logging in

setPassword

public void setPassword(java.lang.String password)

Sets the password to use when logging in.

Parameters:
password - a String that specifies the password to use when logging in

getTokenExpiry

public int getTokenExpiry()

Gets the number of minutes the Enterprise session token is valid before expiring.

Returns:
an int that specifies the number of minutes the enterprise session token is valid before expiring

setTokenExpiry

public void setTokenExpiry(int tokenExpiry)

Sets the number of minutes the Enterprise session token is valid before expiring.

Parameters:
tokenExpiry - an int that specifies the number of minutes the enterprise session token is valid before expiring

isEnableAutoLogon

public boolean isEnableAutoLogon()

Gets a value indicating whether or not the Identity bean automatically logs in to Crystal Enterprise.

Returns:
true if the Identity bean will automatically log on using the supplied credentials, otherwise, false

setEnableAutoLogon

public void setEnableAutoLogon(boolean enableAutoLogon)

Sets a value indicating whether or not the Identity bean automatically logs in to Crystal Enterprise. This method takes effect when both the enterprise session and the token are no longer valid. Set this method to true to attempt to re-logon using the existing user, system and password values.

Parameters:
enableAutoLogon - true if the Identity bean will automatically log on using the supplied credentials, otherwise, false

isLoggedOn

public boolean isLoggedOn()

Gets the logged in status of the user.


isLoggedOnAuto

public boolean isLoggedOnAuto()

Gets whether the user was automatically logged on.


getLocale

public java.util.Locale getLocale()

Returns whether the user can see the User Folder. The User Folder is the parent folder of the user's favorites folder.

Returns:
true if the user can see the User Folder, otherwise false public boolean isUserCanSeeUserFolders(); /**

Gets the locale to use for the user.


setLocale

public void setLocale(java.util.Locale value)

Sets the locale to use for the user.

Parameters:
value - a Locale object that specifies the locale to use

getToken

public java.lang.String getToken()

Gets the Enterprise session token for the logged on user.

Returns:
a String that specifies the enterprise session token

getCookieName

public java.lang.String getCookieName()

Gets the name of the cookie that is used to store session information in the browser.

Returns:
a String that specifies the name of the cookie

setCookieName

public void setCookieName(java.lang.String value)

Sets the name of the cookie that is used to store session information in the browser.

Parameters:
value - a String that specifies the cookie name

getErrorMsg

public java.lang.String getErrorMsg()

Gets the last error message. The language of the error message returned is based on the locale.

Returns:
a String that specifies the last error message

getEnterpriseSession

public IEnterpriseSession getEnterpriseSession()

Gets the Enterprise session data representing a user that has logged in to Crystal Enterprise.

Returns:
an IEnterpriseSession object that represents a user that has logged in to Crystal Enterprise

getInfoStore

public IInfoStore getInfoStore()
                        throws SDKException

Gets the IInfostore object associated with the enterprise session.

Returns:
an IInfoStore object
Throws:
SDKException

getUserRootFolder

public java.lang.String getUserRootFolder()

Gets the user's root folder.

Returns:
a String that specifies the user's root folder ID

getVisibleAuthentications

public java.lang.String[] getVisibleAuthentications()

Gets the list of visible authentication types in the drop-down list.

Returns:
a String array that specifies the visible authentication types

setVisibleAuthentications

public void setVisibleAuthentications(java.lang.String[] visibleAuthentications)

Sets the list of visible authentication types in the drop-down list.

Parameters:
visibleAuthentications - a String array containing the list of visible authentication types

logon

public boolean logon()
              throws SDKException

Logs the user on to the Crystal Enterprise session.

Returns:
true if successfully logged on to Crystal Enterprise, otherwise, false
Throws:
SDKException

logon

public boolean logon(java.lang.String name,
                     java.lang.String password)
              throws SDKException

Logs the user on to the Crystal Enterprise session.

Parameters:
name - a String that specifies the user name
password - a String that specifies the user's password
Returns:
true if successfully logged on to Crystal Enterprise, otherwise, false
Throws:
SDKException

logon

public boolean logon(java.lang.String name,
                     java.lang.String password,
                     java.lang.String system)
              throws SDKException

Logs the user on to the Crystal Enterprise session.

Parameters:
name - a String that specifies the user name
password - a String that specifies the user's password
system - a String that specifies the name of the Crystal Enterprise system to log on to
Returns:
true if successfully logged on to Crystal Enterprise, otherwise, false
Throws:
SDKException

logon

public boolean logon(java.lang.String name,
                     java.lang.String password,
                     java.lang.String system,
                     java.lang.String authentication)
              throws SDKException

Logs the user on to the Crystal Enterprise session.

Parameters:
name - a String that specifies the user name
password - a String that specifies the user's password
system - a String that specifies the name of the Crystal Enterprise system to log on to
authentication - a String that specifies the authentication type
Returns:
true if successfully logged on to Crystal Enterprise, otherwise, false
Throws:
SDKException

logoff

public void logoff()
            throws SDKException

Logs a user off a Crystal Enterprise session.

Throws:
SDKException