public class

WebIServerSessionProxy

extends Object
implements WebIServerSession
java.lang.Object
   ↳ com.microstrategy.web.objects.WebIServerSessionProxy

This class is deprecated.
use WebIServerSessionProxyFactory

Class Overview

Wrapper around a WebIServerSession that allows a proxy of the project DSSID to be changed, but not the actual project on the session. Optimization for retrieving link objects belonging to other projects different from the one logged into by the current session. Also overrides object equals and hashcode.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
[Expand]
Inherited Fields
From interface com.microstrategy.utils.cache.CacheHint
From interface com.microstrategy.web.objects.WebSessionInfo
Public Constructors
WebIServerSessionProxy(WebIServerSession session, String projectDSSID)
WebIServerSessionProxy(WebIServerSession session, WebUser user, String projectDSSID)
Public Methods
boolean canChangePassword()
Returns whether the password can be changed.
void changePassword(String oldPassword, String newPassword)
Changes the password for the session.
void changePassword(String newPassword)
Changes the password that will be used in the session.
boolean checkUserPrivilege(int privilegeType)
Checks if the user has the particular privilege type at Intelligence Server
void clearToken()
Clears the token.
void closeSession()
Closes the session used to communicate with the Intelligence Server.
WebIServerSession createCopy()
Creates a new WebIServerSession instance and copies into it data necessary to connect to the I-Server.
String createUsherAccount(String email)
void deleteTrustToken(String tokenString, String serverName)
Delete Trust Relationship between Web Server and Intelligence Server.
boolean equals(Object obj)
String generateNewTrustToken(String id)
Create Trust Relationship between Web Server and Intelligence Server.
String getAccessToken()
This access token (Usher, OAuth2) will be passed to the Intelligence Server for authentication.
int getApplicationType()
Returns the application type to be set on the session, from EnumDSSXMLApplicationType.
int getAuthMode()
Returns the current setting of the authMode property, which determines the type of credentials used upon creating a session to the Intelligence Server.
static String getCacheKey(WebIServerSession session)
Long getCacheStateId(String name)
Returns a value for the current state of the cache hint This value is used in maintaining cache consistency across different caches using the same hint object (for instance, session based cache across a web cluster where each machine in the cluster holds a copy of the cache) Whenever a change is made to the cached value in one cache, the stateId is incremented
String getClientID()
Returns the current value of the client ID identifier, which is used upon session creation to identify the client machine.
String getClientVersion()
Returns the current value of the client version, which is used upon session creation to identify the client's version.
Locale getDisplayLocale()
Returns the display locale, which is meant to be used for the strings that will displayed to the user.
WebLocale getDisplayWebLocale()
String getExtraParams()
String getExtraProperty(String name)
Get the extra property.
WebObjectsFactory getFactory()
Returns the WebObjectsFactory instance associated with the current WebSessionInfo instance.
GSSCredential getGSSCredential()
Get GSS Delegation Credential for Kerberos Authentication mode
String getKey()
Returns the unique key which identifies this session within its list.
String getLDAPDistinguishedName()
Get LDAP Distinguished Name for Single Sign on authentication mode
long getLastAccessTime()
Returns the last access time of the session.
Locale getLocale()
Returns the current locale setting used for number and date representations.
int getLocaleID()
Returns the current locale of this object in the format of a Windows locale ID.
String getLogin()
Returns the current login property.
String getMessageID()
WebLocale getMessagesWebLocale()
WebLocale getMetadataWebLocale()
WebLocale getNumberWebLocale()
String getOrgID()
Gets the Usher organization/network ID associated with this session.
SimpleList getOutOfComplianceLicenses(int[] levels)
Returns the list of out of compliance licenses (of required compliance levels) for the current user session.
String getPartialURL()
Returns the partial url set by setPartialURL(String)
String getProjectID()
Returns the project ID corresponding to the projectName that was set.
String getProjectName()
Returns the project name which will be logged into.
int getRegularWorkingSetSize()
Returns the regular working set size which is currently set on the object.
String getResultCode()
int getSearchWorkingSetSize()
Returns the search working set size which is currently set on the object.
String getServerName()
Returns the Intelligence Server name to be contacted when creating a session.
int getServerPort()
Returns the Intelligence Server port which will be connected to when sending a request.
String getServerVersion()
Returns the version of the Intelligence Server specified by the serverName and port properties.
int getSessionFlags()

Returns the flag settings which will be used upon calling createSession or closeSession.

String getSessionID()
Returns the session ID which is currently set on this object.
String getSessionID(boolean create)
Returns the session ID of this object.
String getSessionKey()
Get session key for mobile encryption
WebSessionInfoList getSessionList()
This method will return the WebSessionInfoList object that this session belongs to.
int getSessionType()
Returns the type of session for this WebSessionInfo object.
TimeZone getTimeZone()
Returns the current time zone settings of this object.
String getTimeZoneID()
Returns the current time zone settings of this object.
String getTrustToken()
Get Trust Token for Single Sign on authentication mode
WebObjectInfo getUserInfo()
Retrieves the WebObjectInfo information about the user corresponding to this session.
WebObjectInfo getUserInfo(boolean populate)
Retrieves the WebObjectInfo information about the user corresponding to this session.
Preferences getUserPreferences()
UsherSessionHelper getUsherSessionHelper()
WebLocale getWarehouseDataWebLocale()
String getWebVersion()
Returns the version of the Web API which is being used.
int hashCode()
boolean isActive()
This method will return whether the current session is the active session within its list.
boolean isAlive()
Returns true if the current session is alive on the I-Server.
boolean isDirty()
Returns true if the session state changed since last restoreState call.
boolean isMDUser()
Returns a boolean to indicate whether the user that this session corresponds to is an actual user persisted in the metadata.
void populate(WebIServerSession otherSession)
This method can be used to populate the current session with the information from the given session.
void reconnect()
Creates a new session regardless of whether the current session is alive or not.
void refresh()
If the current session is alive does nothing, otherwise creates a new session.
void resolveLocalesOnly()
Connects to the Intelligence Server to resolve the locales without creating a session.
void resolveLocalesOnly(WebUserEntity oUserEntity)
Connects to the Intelligence Server to resolve the locales without creating a session.
boolean restoreState(String state)
Restores a component based on its saved state.
boolean restoreState(SAXSupport parser, String uri, String localName, String qName, Attributes attrs)
Restores a component from an embedded XML during a SAX parsing.
void saveState(StringBuffer buf, int howMuchState)
Saves and stores a component's state into a StringBuffer.
void saveState(StringBuffer buf, int howMuchState, int stateFlag)
Saves and stores a component's state into a StringBuffer.
String saveState(int howMuchState)
Returns a java.lang.String representaion of a component.
String saveState()
Returns a java.lang.String representaion of a component.
void setAccessToken(String accessToken)
Sets the two-step verification code
void setActive()
This method will set the current session as the active session.
void setApplicationType(int applicationType)
Sets the application type to use when creating the session, from EnumDSSXMLApplicationType.}
void setAuthMode(int authMode)
Sets the current setting of the authMode property, which determines the type of credentials used upon creating a session to the Intelligence Server.
void setCacheStateId(String name, Long stateId)
Sets the stateId - see getCacheStateId(String).
void setClientID(String clientID)
Sets the value of the client identifier, which tells the Intelligence Server upon login the identifier of the client machine.
void setClientVersion(String clientVersion)
Sets the value of the client version, which tells the Intelligence Server upon login the version of the client.
void setConfSessionID(String confSessionID)
Set the configuration session ID.
void setDirty(boolean value)
Sets the dirty flag.
void setDisplayLocale(Locale displayLocale)
Configures a default locale to use should the resolution process not find a suitable preference setting.
void setExtraParams(String value)
void setExtraProperty(String name, String value)
Set extra property on this session object.
void setGSSCredential(GSSCredential credential)
Set GSS Delegation Credential for Kerberos Authentication mode
void setLDAPDistinguishedName(String ldapDN)
Set LDAP Distinguished Name for Single Sign on authentication mode
void setLastMsgID(String lastMsgID)
set the last message ID
void setLocale(Locale locale)
Configures the number and date locale setting of this object.
void setLocaleID(int localeID)
Configures the number and date locale setting of this object as a Windows locale ID.
void setLogin(String login)
Sets the login which will be used in any methods which require that parameter while communicating with the Intelligence Server.
void setMessagesLocale(Locale locale)
Configures a default locale to use should the resolution process not find a suitable preference setting.
void setMetadataLocale(Locale locale)
Configures a default locale to use should the resolution process not find a suitable preference setting.
void setNumberLocale(Locale locale)
Configures a default locale to use should the resolution process not find a suitable preference setting.
void setOrgID(String orgID)
Sets the Usher organization/network ID.
void setPartialURL(String url)
Defines partial url that will used to replace the {&WEBSERVER} macro whereever it is used The macro is used , for instance, in Report Services document.
void setPassword(String password)
Sets the user password which will be passed to the backend Server when creating a session.
void setProjectID(String dssID)
Sets the project DSS ID which will be logged into.
void setProjectName(String projectName)
Sets the project name which will be logged into.
void setRegularWorkingSetSize(int newRegularWorkingSetSize)
Sets the regular working set size.
void setSearchWorkingSetSize(int newSearchWorkingSetSize)
Sets the search working set size.
void setServerName(String serverName)
Sets the Intelligence Server name to be contacted when creating a session.
void setServerPort(int portNumber)
Sets the Intelligence Server port which will be connected to when sending a request.
void setSessionFlags(int newSessionFlags)
This value should be the bitwise or(|) of values from EnumDSSXMLSessionFlags.
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.
void setSessionKey(String sessionKey)
Set session key for mobile encryption
void setTimeZone(TimeZone timezone)
Sets the current time zone settings of this object.
void setTimeZoneID(String timezoneID)
Sets the current time zone settings of this object.
void setToken(Object token)
Sets the token.
void setTrustToken(String val)
Set Trust Token for Single Sign on authentication mode
void setTwoStepVerificationCode(String twoStepVerificationCode)
Sets the two-step verification code
void setWarehouseDataLocale(Locale locale)
Configures a default locale to use should the resolution process not find a suitable preference setting.
void updateSessionParameters()
Normally, the following parameters are established during session creation.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.microstrategy.utils.cache.CacheHint
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebIServerSession
From interface com.microstrategy.web.objects.WebSessionInfo
From interface com.microstrategy.web.objects.localization.RegionalOptions
From interface com.microstrategy.web.objects.localization.RegionalValues
From interface com.microstrategy.webapi.ServerInfo

Public Constructors

public WebIServerSessionProxy (WebIServerSession session, String projectDSSID)

public WebIServerSessionProxy (WebIServerSession session, WebUser user, String projectDSSID)

Public Methods

public boolean canChangePassword ()

Returns whether the password can be changed.

Returns

public 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

public void changePassword (String newPassword)

Changes the password that will be used in the session.

Parameters
newPassword The value of the new password.

public boolean checkUserPrivilege (int privilegeType)

Checks if the user has the particular privilege type at Intelligence Server

Parameters
privilegeType integer value specifying the type of privilege that is to be checked This is a value from the enumeration EnumDSSXMLPrivilegeTypes
Returns
  • boolean value indicating if the specific privilege is available

public void clearToken ()

Clears the token.

public void closeSession ()

Closes the session used to communicate with the Intelligence Server.

public WebIServerSession createCopy ()

Creates a new WebIServerSession instance and copies into it data necessary to connect to the I-Server.

The following fields are copied to the new object:

  • serverName;
  • portNumber;
  • projectName;
  • authMode;
  • login;
  • password;
  • regularWorkingSetSize;
  • searchWorkingSetSize;
  • sessionFlags;

Returns
  • new session instance

public String createUsherAccount (String email)

public void deleteTrustToken (String tokenString, String serverName)

Delete Trust Relationship between Web Server and Intelligence Server.

Parameters
tokenString token for the trust relationship to be deleted
serverName the Web Server name for the Trust relationship

public boolean equals (Object obj)

public String generateNewTrustToken (String id)

Create Trust Relationship between Web Server and Intelligence Server.

Parameters
id the web application name passed to Intelligence Server
Returns
  • Trust token for the create trust relationship

public String getAccessToken ()

This access token (Usher, OAuth2) will be passed to the Intelligence Server for authentication. Note that the access token takes precedence, and is mutually exclusive with getTrustToken(), i.e. if access token is available, we ignore the trust token.

Returns
  • access token

public int getApplicationType ()

Returns the application type to be set on the session, from EnumDSSXMLApplicationType.

Returns

public int getAuthMode ()

Returns the current setting of the authMode property, which determines the type of credentials used upon creating a session to the Intelligence Server.

Returns

public static String getCacheKey (WebIServerSession session)

public Long getCacheStateId (String name)

Returns a value for the current state of the cache hint This value is used in maintaining cache consistency across different caches using the same hint object (for instance, session based cache across a web cluster where each machine in the cluster holds a copy of the cache) Whenever a change is made to the cached value in one cache, the stateId is incremented

Parameters
name cache name
Returns
  • current state of the cache hint

public String getClientID ()

Returns the current value of the client ID identifier, which is used upon session creation to identify the client machine.

Returns
  • The client ID value which will be used.

public String getClientVersion ()

Returns the current value of the client version, which is used upon session creation to identify the client's version.

Returns
  • The client version value which will be used.

public 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 WebLocale getDisplayWebLocale ()

public String getExtraParams ()

public String getExtraProperty (String name)

Get the extra property.

Parameters
name property name
Returns
  • property value

public WebObjectsFactory getFactory ()

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

Returns

public GSSCredential getGSSCredential ()

Get GSS Delegation Credential for Kerberos Authentication mode

Returns
  • GSS Delegation Credential for Kerberos Authentication mode

public String getKey ()

Returns the unique key which identifies this session within its list. This key can be used with the getByKey method on WebIServerSessionList to retrieve this session. The key is not parsable and will only be consistent within a single collection, but the key is guaranteed to remain the same for an indefinite number of save/restore state operations.

Returns
  • A key which can be used to refer to this session within the collection.

public String getLDAPDistinguishedName ()

Get LDAP Distinguished Name for Single Sign on authentication mode

Returns
  • LDAP Distinguished Name for Single Sign on authentication mode

public long getLastAccessTime ()

Returns the last access time of the session.

Returns
  • The last access time of the session.

public Locale getLocale ()

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

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

public 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.

public 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.

public String getMessageID ()

public WebLocale getMessagesWebLocale ()

public WebLocale getMetadataWebLocale ()

public WebLocale getNumberWebLocale ()

public String getOrgID ()

Gets the Usher organization/network ID associated with this session.

Returns
  • Usher organization/network ID.

public SimpleList getOutOfComplianceLicenses (int[] levels)

Returns the list of out of compliance licenses (of required compliance levels) for the current user session. The invalid licenses are returned as SimpleList of WebLicenseDetails objects. If the returned list is of length 0, the licenses are valid.

Parameters
levels An integer array of compliance levels to be filtered on.
Returns
  • list of invalid licenses

public String getPartialURL ()

Returns the partial url set by setPartialURL(String)

public String getProjectID ()

Returns the project ID corresponding to the projectName that was set. If the projectName is not set, then null is returned

Returns
  • The current setting of the projectID property.
Throws
IllegalArgumentException
WebObjectsException

public String getProjectName ()

Returns the project name which will be logged into.

Returns
  • The current setting of the projectName property.

public int getRegularWorkingSetSize ()

Returns the regular working set size which is currently set on the object. The regular working set size tells how many report/document executions which are not saved to inbox are kept alive on the Intelligence Server before deleting older ones.

Returns
  • The current value of the regular working set size.

public String getResultCode ()

public int getSearchWorkingSetSize ()

Returns the search working set size which is currently set on the object. The search working set size tells how many searches to keep alive on the Intelligence Server before deleting older ones.

Returns
  • The current value of the search working set size.

public String getServerName ()

Returns the Intelligence Server name to be contacted when creating a session.

Returns
  • The current Intelligence Server name.

public int getServerPort ()

Returns the Intelligence Server port which will be connected to when sending a request. If this value is 0, then the default port of 0x8888(34952 decimal) will be used.

Returns
  • The port which will be used upon contacting the Intelligence Server.

public String getServerVersion ()

Returns the version of the Intelligence Server specified by the serverName and port properties.

Returns
  • The version of the Intelligence Server.

public int getSessionFlags ()

Returns the flag settings which will be used upon calling createSession or closeSession. This value will be the bitwise or(|) of values from EnumDSSXMLSessionFlags.

Note that the default value for this has changed in 8.0.2 to DssXmlSessionDeleteReadMsgsOnClose from the previous default of 0.

Returns
  • The current session flag value.

public 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.

public 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.

public String getSessionKey ()

Get session key for mobile encryption

Returns
  • Session key for mobile encryption

public 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 int getSessionType ()

Returns the type of session for this WebSessionInfo object.

Returns
  • The type of session corresponding to EnumWebSessionType.

public 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 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 String getTrustToken ()

Get Trust Token for Single Sign on authentication mode

Returns
  • Trust Token for Single Sign on authentication mode

public WebObjectInfo getUserInfo ()

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

public 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

public Preferences getUserPreferences ()

public UsherSessionHelper getUsherSessionHelper ()

public WebLocale getWarehouseDataWebLocale ()

public String getWebVersion ()

Returns the version of the Web API which is being used.

Returns
  • The version of the Web API.

public int hashCode ()

public 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 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.

public 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 boolean isMDUser ()

Returns a boolean to indicate whether the user that this session corresponds to is an actual user persisted in the metadata. In cases like

this method will return false.

Returns
  • boolean to indicate whether the user that this session corresponds to is an actual user persisted in the metadata

public void populate (WebIServerSession otherSession)

This method can be used to populate the current session with the information from the given session. This means that all properties of the given session will be copied into the given session. This method is primarily used when it is necessary to add a session to the list which comes from another list or an external source (such as an External Security Module). In this case, the foreign session can be added to the list by creating a new session in the list and calling populate on the new session, passing the foreign session. Note that when this method is called, all properties of the session it is called upon will be discarded.

Parameters
otherSession The session whose properties will be copied into the current session.

public void reconnect ()

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

public void refresh ()

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

public void resolveLocalesOnly ()

Connects to the Intelligence Server to resolve the locales without creating a session.

public void resolveLocalesOnly (WebUserEntity oUserEntity)

Connects to the Intelligence Server to resolve the locales without creating a session.

Parameters
oUserEntity the user we want to apply

public boolean restoreState (String state)

Restores a component based on its saved state.

Parameters
state the state of a component
Returns
  • true if restoration succeeds.

public boolean restoreState (SAXSupport parser, String uri, String localName, String qName, Attributes attrs)

Restores a component from an embedded XML during a SAX parsing.

Parameters
parser a SAX parser processing the XML representation of a state
uri The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed
localName The local name (without prefix), or the empty string if Namespace processing is not being performed
qName The qualified name (with prefix), or the empty string if qualified names are not available
attrs The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object
Returns
  • true to indicate a successful restoration. Otherwise, false will be returned.

public void saveState (StringBuffer buf, int howMuchState)

Saves and stores a component's state into a StringBuffer. The returned state should be HTML friendly.

There are generally two formats of the saved state: flat state and XML representation. The minimum state is saved in flat state format, while the typical and maximum states are saved in XML string representation.

Parameters
buf a StringBuffer to store the saved state.
howMuchState how much state information to save (EnumWebPersistableState).
Throws
UnsupportedOperationException

public void saveState (StringBuffer buf, int howMuchState, int stateFlag)

Saves and stores a component's state into a StringBuffer. The returned state should be HTML friendly.

There are generally two formats of the saved state: flat state and XML representation. The minimum state is saved in flat state format, while the typical and maximum states are saved in XML string representation.

Parameters
buf a StringBuffer to store the saved state.
howMuchState how much state information to save (EnumWebPersistableState).
stateFlag bit-wise flag to indicate additional information about the state (EnumWebStateFlags).
Throws
UnsupportedOperationException

public String saveState (int howMuchState)

Returns a java.lang.String representaion of a component. The returned state should be HTML friendly. This method call is equivalent to call saveState(new StringBuffer(), howMuchState).

Parameters
howMuchState how much state information to save (EnumWebPersistableState).
Returns
  • the serialized state of a component.

public String saveState ()

Returns a java.lang.String representaion of a component. The returned state should be HTML friendly. This method call is equivalent to call saveState(EnumWebPersistableState.TYPICAL_STATE_INFO).

Returns
  • the serialized state of a component.

public void setAccessToken (String accessToken)

Sets the two-step verification code

public 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 void setApplicationType (int applicationType)

Sets the application type to use when creating the session, from EnumDSSXMLApplicationType.}

Parameters
applicationType The application type to use for the session, from EnumDSSXMLApplicationType.

public void setAuthMode (int authMode)

Sets the current setting of the authMode property, which determines the type of credentials used upon creating a session to the Intelligence Server.

Parameters
authMode The authMode setting to use, from EnumDSSXMLAuthModes.

public void setCacheStateId (String name, Long stateId)

Sets the stateId - see getCacheStateId(String).

Parameters
name cache name
stateId new cache state id

public void setClientID (String clientID)

Sets the value of the client identifier, which tells the Intelligence Server upon login the identifier of the client machine.

Parameters
clientID The value of client ID to send to the Server.

public void setClientVersion (String clientVersion)

Sets the value of the client version, which tells the Intelligence Server upon login the version of the client.

Parameters
clientVersion The value of client version to send to the Server.

public void setConfSessionID (String confSessionID)

Set the configuration session ID. This configuration session ID will be used to create project session without user name and password, when auth mode is set to DssXmlAuthSessionID

public void setDirty (boolean value)

Sets the dirty flag.

Parameters
value the flag value.

public void setDisplayLocale (Locale displayLocale)

Configures a default locale to use should the resolution process not find a suitable preference setting.

Parameters
displayLocale a default web display locale.

public void setExtraParams (String value)

public void setExtraProperty (String name, String value)

Set extra property on this session object. The properties are only present on web server side and will never be sent to backend. NOTE: the properties set here will be serialized to the state if the persistent level is EnumWebPersistableState.TYPICAL_STATE_INFO or greater. Please carefully use this method, in case the session state is getting too long.

Parameters
name property name
value property value

public void setGSSCredential (GSSCredential credential)

Set GSS Delegation Credential for Kerberos Authentication mode

Parameters
credential GSS Delegation Credential for Kerberos Authentication mode

public void setLDAPDistinguishedName (String ldapDN)

Set LDAP Distinguished Name for Single Sign on authentication mode

Parameters
ldapDN LDAP Distinguished Name for Single Sign on authentication mode

public void setLastMsgID (String lastMsgID)

set the last message ID

public void setLocale (Locale locale)

Configures the number and date locale setting of this object.

Parameters
locale The locale of the current object.

public 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.

public 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.

public void setMessagesLocale (Locale locale)

Configures a default locale to use should the resolution process not find a suitable preference setting.

Parameters
locale Intelligence Server messages locale.

public void setMetadataLocale (Locale locale)

Configures a default locale to use should the resolution process not find a suitable preference setting.

Parameters
locale a default metadata locale.

public void setNumberLocale (Locale locale)

Configures a default locale to use should the resolution process not find a suitable preference setting.

Parameters
locale a default number and date-time locale

public void setOrgID (String orgID)

Sets the Usher organization/network ID. This ID maybe different from the usher organization/network ID configured at Iserver side.

public void setPartialURL (String url)

Defines partial url that will used to replace the {&WEBSERVER} macro whereever it is used The macro is used , for instance, in Report Services document. The partial url is not maintained in the state It needs to be set for every instance of the session

public 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 void setProjectID (String dssID)

Sets the project DSS ID which will be logged into.

Parameters
dssID The project to log into.

public void setProjectName (String projectName)

Sets the project name which will be logged into.

Parameters
projectName The project to log into.

public void setRegularWorkingSetSize (int newRegularWorkingSetSize)

Sets the regular working set size. The regular working set size tells how many report/document executions which are not saved to inbox are kept alive on the Intelligence Server before deleting older ones. To reconfigure this setting after a session has already obtained, updateSessionParameters() needs to be called.

Parameters
newRegularWorkingSetSize The new value for the regular working set size.

public void setSearchWorkingSetSize (int newSearchWorkingSetSize)

Sets the search working set size. The search working set size tells how many search executions are kept alive on the Intelligence Server before deleting older ones. To reconfigure this setting after a session has already obtained, updateSessionParameters() needs to be called.

Parameters
newSearchWorkingSetSize The new value for the search working set size.

public void setServerName (String serverName)

Sets the Intelligence Server name to be contacted when creating a session.

Parameters
serverName The name of the Intelligence Server to be contacted.

public void setServerPort (int portNumber)

Sets the Intelligence Server port which will be connected to when sending a request. If this value is 0, then the default port of 0x8888(34952 decimal) will be used.

Parameters
portNumber The port which should be used upon contacting the Intelligence Server.

public void setSessionFlags (int newSessionFlags)

This value should be the bitwise or(|) of values from EnumDSSXMLSessionFlags. Sets the value to use for the session flags when creating a session (getSessionID()) or closing one (closeSession()). This setting may also be changed during a session via updateSessionParameters().

Parameters
newSessionFlags The session flag value to be used.

public 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.

public void setSessionKey (String sessionKey)

Set session key for mobile encryption

Parameters
sessionKey Session key for mobile encryption

public 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 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.

public void setToken (Object token)

Sets the token.

Parameters
token The token value.

public void setTrustToken (String val)

Set Trust Token for Single Sign on authentication mode

Parameters
val Trust Token for Single Sign on authentication mode

public void setTwoStepVerificationCode (String twoStepVerificationCode)

Sets the two-step verification code

public void setWarehouseDataLocale (Locale locale)

Configures a default locale to use should the resolution process not find a suitable preference setting.

Parameters
locale a default warehouse data locale.

public void updateSessionParameters ()

Normally, the following parameters are established during session creation. This method must be called if they are modified after session creation in order for the Intelligence Server to recognize the updated values.