|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public void setID(java.lang.String newId)
Sets the unique identifier for an instance of an Identity bean.
newId
- a String
that specifies the identifier for the Identity beanpublic java.lang.String getID()
Gets the unique identifier for an instance of an Identity bean.
String
that specifies the unique identifier for the Identity beanpublic java.lang.String getSystem()
Gets the name of the Crystal Enterprise system to log on to.
String
that specifies the name of the Crystal Enterprise system to log on topublic void setSystem(java.lang.String cms)
Sets the name of the Crystal Enterprise system to log on to.
cms
- a String
that specifies the name of the Crystal Enterprise system to log on topublic java.lang.String getUserName()
Gets the name of the user to use when logging in.
String
that specifies the name of the user to use when logging inpublic void setUserName(java.lang.String user)
Sets the name of the user to use when logging in.
user
- a String
that specifies the name of the user to use when logging inpublic java.lang.String getSelectedAuthentication()
Gets the default authentication type to use when logging in.
String
that specifies the default authentication type to use when logging inpublic void setSelectedAuthentication(java.lang.String auth)
Sets the default authentication type to use when logging in.
auth
- a String
that specifies the default authentication type to use when logging inpublic java.lang.String getPassword()
Gets the password to use when logging in.
String
that specifies the password to use when logging inpublic void setPassword(java.lang.String password)
Sets the password to use when logging in.
password
- a String
that specifies the password to use when logging inpublic int getTokenExpiry()
Gets the number of minutes the Enterprise session token is valid before expiring.
int
that specifies the number of minutes the enterprise session token is valid before expiringpublic void setTokenExpiry(int tokenExpiry)
Sets the number of minutes the Enterprise session token is valid before expiring.
tokenExpiry
- an int
that specifies the number of minutes the enterprise session token is valid before expiringpublic boolean isEnableAutoLogon()
Gets a value indicating whether or not the Identity bean automatically logs in to Crystal Enterprise.
true
if the Identity bean will automatically log on using the supplied credentials, otherwise, false
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.
enableAutoLogon
- true
if the Identity bean will automatically log on using the supplied credentials, otherwise, false
public boolean isLoggedOn()
Gets the logged in status of the user.
public boolean isLoggedOnAuto()
Gets whether the user was automatically logged on.
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.
true
if the user can see the User Folder, otherwise false
public boolean isUserCanSeeUserFolders();
/**
Gets the locale to use for the user.
public void setLocale(java.util.Locale value)
Sets the locale to use for the user.
value
- a Locale
object that specifies the locale to usepublic java.lang.String getToken()
Gets the Enterprise session token for the logged on user.
String
that specifies the enterprise session tokenpublic java.lang.String getCookieName()
Gets the name of the cookie that is used to store session information in the browser.
String
that specifies the name of the cookiepublic void setCookieName(java.lang.String value)
Sets the name of the cookie that is used to store session information in the browser.
value
- a String
that specifies the cookie namepublic java.lang.String getErrorMsg()
Gets the last error message. The language of the error message returned is based on the locale.
String
that specifies the last error messagepublic IEnterpriseSession getEnterpriseSession()
Gets the Enterprise session data representing a user that has logged in to Crystal Enterprise.
IEnterpriseSession
object that represents a user that has logged in to Crystal Enterprisepublic IInfoStore getInfoStore() throws SDKException
Gets the IInfostore
object associated with the enterprise session.
IInfoStore
object
SDKException
public java.lang.String getUserRootFolder()
Gets the user's root folder.
String
that specifies the user's root folder IDpublic java.lang.String[] getVisibleAuthentications()
Gets the list of visible authentication types in the drop-down list.
String
array that specifies the visible authentication typespublic void setVisibleAuthentications(java.lang.String[] visibleAuthentications)
Sets the list of visible authentication types in the drop-down list.
visibleAuthentications
- a String
array containing the list of visible authentication typespublic boolean logon() throws SDKException
Logs the user on to the Crystal Enterprise session.
true
if successfully logged on to Crystal Enterprise, otherwise, false
SDKException
public boolean logon(java.lang.String name, java.lang.String password) throws SDKException
Logs the user on to the Crystal Enterprise session.
name
- a String
that specifies the user namepassword
- a String
that specifies the user's password
true
if successfully logged on to Crystal Enterprise, otherwise, false
SDKException
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.
name
- a String
that specifies the user namepassword
- a String
that specifies the user's passwordsystem
- a String
that specifies the name of the Crystal Enterprise system to log on to
true
if successfully logged on to Crystal Enterprise, otherwise, false
SDKException
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.
name
- a String
that specifies the user namepassword
- a String
that specifies the user's passwordsystem
- a String
that specifies the name of the Crystal Enterprise system to log on toauthentication
- a String
that specifies the authentication type
true
if successfully logged on to Crystal Enterprise, otherwise, false
SDKException
public void logoff() throws SDKException
Logs a user off a Crystal Enterprise session.
SDKException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |