WebIServerSessionProxy

Returns whether the password can be changed.

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.

Changes the password that will be used in the session.

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

Clears the token.

Closes the session used to communicate with the Intelligence Server.

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;

Delete Trust Relationship between Web Server and Intelligence Server.

Create Trust Relationship between Web Server and Intelligence Server.

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 the application type to be set on the session, from EnumDSSXMLApplicationType.

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

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

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

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

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.

Get the extra property.

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

Get GSS Delegation Credential for Kerberos Authentication mode

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.

Get LDAP Distinguished Name for Single Sign on authentication mode

Returns the last access time of the session.

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

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

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.

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

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.

Returns the partial url set by setPartialURL(String)

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

Returns the project name which will be logged into.

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 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 Intelligence Server name to be contacted when creating a session.

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 version of the Intelligence Server specified by the serverName and port properties.

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

Get session key for mobile encryption

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 the type of session for this WebSessionInfo object.

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

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

Get Trust Token for Single Sign on authentication mode

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

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

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

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 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 session state changed since last restoreState call.

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

• DssXmlAuthLDAP (where the LDAP user is not actually imported)
• DssXmlAuthAnonymous
• DssXmlAuthWarehousePassthrough

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.

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

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

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

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

Restores a component based on its saved state.

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

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.

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.

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

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

Sets the two-step verification code

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.

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

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

Sets the stateId - see getCacheStateId(String).

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

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

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

Sets the dirty flag.

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

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.

Set GSS Delegation Credential for Kerberos Authentication mode

Set LDAP Distinguished Name for Single Sign on authentication mode

set the last message ID

Configures the number and date locale setting of this object.

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

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

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

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

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

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

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

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

Sets the project DSS ID which will be logged into.

Sets the project name which will be logged into.

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.

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.

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

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.

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().

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

Set session key for mobile encryption

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

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

Sets the token.

Set Trust Token for Single Sign on authentication mode

Sets the two-step verification code

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

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.

• Session flags (see setSessionFlags(int))
• Regular working set (see setRegularWorkingSetSize(int))
• Search working set (see setSearchWorkingSetSize(int))