WebIServerSession

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

Clears the token.

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;

Creates a new WebIServerSession configuration session from existing active session, and populates session id

Creates a new WebIServerSession project session from existing active session for a given project DSS ID, and populates session id

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

Get the extra property.

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.

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.

Get session key for mobile encryption

Get Trust Token for Single Sign on authentication mode

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

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.

Under the symmetric workflows, creates sessions appropriate to the reuse mode. If mode is to reuse, then the currently set session id is used. If mode is to create a new session, then the currently set session id is used to create 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.

Sets the access token

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

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

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

Set session key for mobile encryption

Sets the token.

Set Trust Token for Single Sign on authentication mode

Sets the two-step verification code

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