public interface

WebSessionInfo

implements CacheHint Persistable
com.microstrategy.web.objects.WebSessionInfo
Known Indirect Subclasses

Class Overview

The WebSessionInfo class represents the session used by this WebSessionInfo object.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Fields
public static final TimeZone DEFAULT_TIME_ZONE
[Expand]
Inherited Fields
From interface com.microstrategy.utils.cache.CacheHint
Public Methods
abstract boolean canChangePassword()
Returns whether the password can be changed.
abstract void changePassword(String oldPassword, String newPassword)
Changes the password for the session.
abstract void changePassword(String newPassword)
Changes the password that will be used in the session.
abstract void closeSession()
Closes the session used to communicate with the Intelligence Server.
abstract Locale getDisplayLocale()
Returns the display locale, which is meant to be used for the strings that will displayed to the user.
abstract WebObjectsFactory getFactory()
Returns the WebObjectsFactory instance associated with the current WebSessionInfo instance.
abstract Locale getLocale()
Returns the current locale setting used for number and date representations.
abstract int getLocaleID()
Returns the current locale of this object in the format of a Windows locale ID.
abstract String getLogin()
Returns the current login property.
abstract String getSessionID()
Returns the session ID which is currently set on this object.
abstract String getSessionID(boolean create)
Returns the session ID of this object.
abstract WebSessionInfoList getSessionList()
This method will return the WebSessionInfoList object that this session belongs to.
abstract int getSessionType()
Returns the type of session for this WebSessionInfo object.
abstract TimeZone getTimeZone()
Returns the current time zone settings of this object.
abstract String getTimeZoneID()
Returns the current time zone settings of this object.
abstract WebObjectInfo getUserInfo()
Retrieves the WebObjectInfo information about the user corresponding to this session.
abstract WebObjectInfo getUserInfo(boolean populate)
Retrieves the WebObjectInfo information about the user corresponding to this session.
abstract boolean isActive()
This method will return whether the current session is the active session within its list.
abstract boolean isAlive()
Returns true if the current session is alive on the I-Server.
abstract boolean isDirty()
Returns true if the session state changed since last restoreState call.
abstract void reconnect()
Creates a new session regardless of whether the current session is alive or not.
abstract void refresh()
If the current session is alive does nothing, otherwise creates a new session.
abstract void setActive()
This method will set the current session as the active session.
abstract void setDirty(boolean value)
Sets the dirty flag.
abstract void setDisplayLocale(Locale displayLocale)
Sets the display locale, which is meant to be used for the strings that will displayed to the user.
abstract void setLocale(Locale locale)
Configures the number and date locale setting of this object.
abstract void setLocaleID(int localeID)
Configures the number and date locale setting of this object as a Windows locale ID.
abstract void setLogin(String login)
Sets the login which will be used in any methods which require that parameter while communicating with the Intelligence Server.
abstract void setPassword(String password)
Sets the user password which will be passed to the backend Server when creating a session.
abstract void setSessionID(String sessionID)
Sets the sesssion ID, which will be used to tell the backend Server the credentials of the currently logged-in user.
abstract void setTimeZone(TimeZone timezone)
Sets the current time zone settings of this object.
abstract void setTimeZoneID(String timezoneID)
Sets the current time zone settings of this object.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.cache.CacheHint
From interface com.microstrategy.utils.serialization.Persistable

Fields

public static final TimeZone DEFAULT_TIME_ZONE

Public Methods

public abstract boolean canChangePassword ()

Returns whether the password can be changed.

Returns

public abstract void changePassword (String oldPassword, String newPassword)

Changes the password for the session. This new password will be propagated to any sessions in the list which are in the same cluster and have the same login.

Parameters
oldPassword The old password. The user should be prompted for this before allowing a password change, even if they are
Throws
WebObjectsException
WebObjectsException

public abstract void changePassword (String newPassword)

Changes the password that will be used in the session.

Parameters
newPassword The value of the new password.
Throws
WebObjectsException thrown if an error occured while changing the password.

public abstract void closeSession ()

Closes the session used to communicate with the Intelligence Server.

Throws
WebObjectsException thrown if the sessionID is invalid.

public abstract Locale getDisplayLocale ()

Returns the display locale, which is meant to be used for the strings that will displayed to the user. This is not the locale that is sent to the Intelligence Server when creating the session.

Returns
  • The current display locale.

public abstract WebObjectsFactory getFactory ()

Returns the WebObjectsFactory instance associated with the current WebSessionInfo instance. They are in one to one relationship.

Returns

public abstract Locale getLocale ()

Returns the current locale setting used for number and date representations.

Returns
  • The number and date java.util.Locale.
See Also

public abstract int getLocaleID ()

Returns the current locale of this object in the format of a Windows locale ID.

Returns
  • The Windows locale ID which corresponds to the current locale of this object.
See Also

public abstract String getLogin ()

Returns the current login property. However, this property is typically not saved and restored in the web application lifecycle, and therefore may not be be available in other web pages after logging in. This value will be used in any methods which require a login to communicate with the Intelligence Server.

Returns
  • The current login property.
See Also

public abstract String getSessionID ()

Returns the session ID which is currently set on this object. When there is no session ID exists on this object, a new session ID will be created. The session ID is an identifier which is used in most communications to the server which tells the server the credentials of the user currently logged in. This value can be set manually by calling setSessionID, or will be automatically created from user's credentials provided in this object.

Returns
  • The currently set session ID.
Throws
WebObjectsException Thrown when error occurs during get the session id.
See Also

public abstract String getSessionID (boolean create)

Returns the session ID of this object. If create is set to false, this object will return its session ID as it is; if create is set to true, and there is no session ID exists, this object will create a new ID and return it. The session ID is an identifier which is used in most communications to the server which tells the server the credentials of the user currently logged in. This value can be set manually by calling setSessionID, or will be automatically created from user's credentials provided in this object.

Returns
  • The currently set session ID.
Throws
WebObjectsException Thrown when error occurs during get the session id.
See Also

public abstract WebSessionInfoList getSessionList ()

This method will return the WebSessionInfoList object that this session belongs to. Every session has a 1:1 relationship with a session list object.

Returns

public abstract int getSessionType ()

Returns the type of session for this WebSessionInfo object.

Returns
  • The type of session corresponding to EnumWebSessionType.

public abstract TimeZone getTimeZone ()

Returns the current time zone settings of this object. This time zone will be used to format any time related string.

Returns
  • A TimeZone object for current time zone setting.

public abstract String getTimeZoneID ()

Returns the current time zone settings of this object. This time zone will be used to format any time related string.

Returns
  • An int number, which represents current time zone ID. The available ID list can be retrieved by calling getAvailableTimeZoneIDs() from DateTimeConverter object.

public abstract WebObjectInfo getUserInfo ()

Retrieves the WebObjectInfo information about the user corresponding to this session. Equivalent to getUserInfo(boolean) with populate parameter of true.

Throws
WebObjectsException if the user information retrieval ended in an error condition on the I-Server.

public abstract WebObjectInfo getUserInfo (boolean populate)

Retrieves the WebObjectInfo information about the user corresponding to this session. If uninitialized, and populate is false, null will be returned.

Parameters
populate whether to make a round trip to the Intelligence Server
Throws
WebObjectsException if the user information retrieval ended in an error condition on the I-Server.

public abstract boolean isActive ()

This method will return whether the current session is the active session within its list. The active session will be the session that is used for all Intelligence Server requests.

Returns
  • True if this session is the active session, false otherwise.

public abstract boolean isAlive ()

Returns true if the current session is alive on the I-Server. Resolution is as follows:

  1. If no session ID exists, return false - no further action.
  2. Otherwise, check to see if we're connected to the I-Server. If not, we may connect if auto-connect is configured.
  3. Test connection to I-Server.
  4. If no error was encountered, we return true.

Returns
  • true if the current session is alive on the I-Server.
Throws
WebObjectsException

public abstract boolean isDirty ()

Returns true if the session state changed since last restoreState call.

Returns
  • true if the session state changed since last restoreState call.

public abstract void reconnect ()

Creates a new session regardless of whether the current session is alive or not.

Throws
WebObjectsException

public abstract void refresh ()

If the current session is alive does nothing, otherwise creates a new session.

Throws
WebObjectsException

public abstract void setActive ()

This method will set the current session as the active session. This means that any requests to the Intelligence Server within the WebObjectsFactory linked with the owner WebSessionInfoList object will be sent using this session's information.

public abstract void setDirty (boolean value)

Sets the dirty flag.

Parameters
value the flag value.

public abstract void setDisplayLocale (Locale displayLocale)

Sets the display locale, which is meant to be used for the strings that will displayed to the user. This is not the locale that is sent to the Intelligence Server when creating the session.

Parameters
displayLocale The java.util.Locale object representing the display locale.

public abstract void setLocale (Locale locale)

Configures the number and date locale setting of this object.

Parameters
locale The locale of the current object.
See Also

public abstract void setLocaleID (int localeID)

Configures the number and date locale setting of this object as a Windows locale ID.

Parameters
localeID The locale ID of the current locale.
See Also

public abstract void setLogin (String login)

Sets the login which will be used in any methods which require that parameter while communicating with the Intelligence Server.

Parameters
login The login to use when communicating with the Intelligence Server.
See Also

public abstract void setPassword (String password)

Sets the user password which will be passed to the backend Server when creating a session.

Parameters
password The password to use when contacting the backend Server.

public abstract void setSessionID (String sessionID)

Sets the sesssion ID, which will be used to tell the backend Server the credentials of the currently logged-in user.

Parameters
sessionID The session ID to be used when communicating with the server.
See Also

public abstract void setTimeZone (TimeZone timezone)

Sets the current time zone settings of this object. This time zone will be used to format any time related string.

Parameters
timezone The time zone to set.

public abstract void setTimeZoneID (String timezoneID)

Sets the current time zone settings of this object. This time zone will be used to format any time related string.

Parameters
timezoneID The ID for the time zone. The available time zone ID list can be retrieved by calling getAvailableTimeZoneIDs() from DateTimeConverter object.