Package com.microstrategy.web.objects
Interface WebIServerSession
-
- All Superinterfaces:
CacheHint
,EnumWebPersistableState
,Persistable
,RegionalOptions
,RegionalValues
,ServerInfo
,WebSessionInfo
public interface WebIServerSession extends WebSessionInfo, RegionalOptions, ServerInfo
The WebIServerSession represents a MicroStrategy Intelligence Server session. It allows the user to set the server name, port and project, among others, to start an Intelligence Server session.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.utils.cache.CacheHint
ZERO_STATE_ID
-
Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
-
Fields inherited from interface com.microstrategy.web.objects.WebSessionInfo
DEFAULT_TIME_ZONE
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
checkUserPrivilege(int privilegeType)
Checks if the user has the particular privilege type at Intelligence Servervoid
clearToken()
Clears the token.WebIServerSession
createCopy()
Creates a newWebIServerSession
instance and copies into it data necessary to connect to the I-Server.void
createNewConfigSession(WebIServerSession existingActiveSession)
Creates a newWebIServerSession
configuration session from existing active session, and populates session idvoid
createNewProjectSession(WebIServerSession existingActiveSession, java.lang.String projectId)
Creates a newWebIServerSession
project session from existing active session for a given project DSS ID, and populates session idjava.lang.String
createUsherAccount(java.lang.String email)
void
deleteTrustToken(java.lang.String tokenString, java.lang.String severName)
Delete Trust Relationship between Web Server and Intelligence Server.java.lang.String
generateNewTrustToken(java.lang.String identifier)
Create Trust Relationship between Web Server and Intelligence Server.java.lang.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, fromEnumDSSXMLApplicationType
.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.java.lang.String
getClientID()
Returns the current value of the client ID identifier, which is used upon session creation to identify the client machine.java.lang.String
getClientVersion()
Returns the current value of the client version, which is used upon session creation to identify the client's version.java.lang.String
getExtraParams()
java.lang.String
getExtraProperty(java.lang.String name)
Get the extra property.org.ietf.jgss.GSSCredential
getGSSCredential()
Get GSS Delegation Credential for Kerberos Authentication modejava.lang.String
getKey()
Returns the unique key which identifies this session within its list.long
getLastAccessTime()
Returns the last access time of the session.java.lang.String
getLastMsgID()
java.lang.String
getLDAPDistinguishedName()
Get LDAP Distinguished Name for Single Sign on authentication modejava.lang.String
getMessageID()
java.lang.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.java.lang.String
getPartialURL()
Returns the partial url set bysetPartialURL(String)
java.lang.String
getProjectID()
Returns the project ID corresponding to the projectName that was set.java.lang.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.java.lang.String
getResultCode()
int
getSearchWorkingSetSize()
Returns the search working set size which is currently set on the object.java.lang.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.java.lang.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.java.lang.String
getSessionKey()
Get session key for mobile encryptionjava.lang.String
getTrustToken()
Get Trust Token for Single Sign on authentication modePreferences
getUserPreferences()
UsherSessionHelper
getUsherSessionHelper()
java.lang.String
getWebVersion()
Returns the version of the Web API which is being used.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
reconstructSymmetricClusterSessionId()
Under the symmetric workflows, creates sessions appropriate to the reuse mode.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.void
setAccessToken(java.lang.String accessToken)
Sets the access tokenvoid
setApplicationType(int applicationType)
Sets the application type to use when creating the session, fromEnumDSSXMLApplicationType
.}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
setClientID(java.lang.String clientID)
Sets the value of the client identifier, which tells the Intelligence Server upon login the identifier of the client machine.void
setClientVersion(java.lang.String clientVersion)
Sets the value of the client version, which tells the Intelligence Server upon login the version of the client.void
setConfSessionID(java.lang.String confSessionID)
Set the configuration session ID.void
setExtraParams(java.lang.String value)
void
setExtraProperty(java.lang.String name, java.lang.String value)
Set extra property on this session object.void
setGSSCredential(org.ietf.jgss.GSSCredential credential)
Set GSS Delegation Credential for Kerberos Authentication modevoid
setLastMsgID(java.lang.String lastMsgID)
set the last message IDvoid
setLDAPDistinguishedName(java.lang.String LDAPDN)
Set LDAP Distinguished Name for Single Sign on authentication modevoid
setOrgID(java.lang.String orgID)
Sets the Usher organization/network ID.void
setPartialURL(java.lang.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
setProjectID(java.lang.String dssID)
Sets the project DSS ID which will be logged into.void
setProjectName(java.lang.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(java.lang.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 fromEnumDSSXMLSessionFlags
.void
setSessionKey(java.lang.String sessionKey)
Set session key for mobile encryptionvoid
setToken(java.lang.Object token)
Sets the token.void
setTrustToken(java.lang.String token)
Set Trust Token for Single Sign on authentication modevoid
setTwoStepVerificationCode(java.lang.String twoStepVerificationCode)
Sets the two-step verification codevoid
updateSessionParameters()
Normally, the following parameters are established during session creation.-
Methods inherited from interface com.microstrategy.utils.cache.CacheHint
getCacheStateId, setCacheStateId
-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
Methods inherited from interface com.microstrategy.web.objects.localization.RegionalOptions
setDisplayLocale, setMessagesLocale, setMetadataLocale, setNumberLocale, setWarehouseDataLocale
-
Methods inherited from interface com.microstrategy.web.objects.localization.RegionalValues
getDisplayWebLocale, getMessagesWebLocale, getMetadataWebLocale, getNumberWebLocale, getWarehouseDataWebLocale
-
Methods inherited from interface com.microstrategy.web.objects.WebSessionInfo
canChangePassword, changePassword, changePassword, clone, closeSession, createIdentityToken, getDisplayLocale, getFactory, getLocale, getLocaleID, getLogin, getMasterSessionIdByRememberMeToken, getRememberMeTimeout, getRememberMeToken, getSessionID, getSessionID, getSessionList, getSessionType, getTimeZone, getTimeZoneID, getUserInfo, getUserInfo, isActive, isAlive, isDirty, isRestoredFromIdToken, isRestoredFromSessionRecovery, reconnect, refresh, restoreSessionState, restoreStateFromIdentityToken, saveSessionState, setActive, setDirty, setDisplayLocale, setLocale, setLocaleID, setLogin, setPassword, setRestoredFromIdToken, setRestoredFromSessionRecovery, setSessionID, setTimeZone, setTimeZoneID, updateRememberMeToken
-
-
-
-
Method Detail
-
getServerName
java.lang.String getServerName()
Returns the Intelligence Server name to be contacted when creating a session.- Specified by:
getServerName
in interfaceServerInfo
- Returns:
- The current Intelligence Server name.
- See Also:
setServerName(java.lang.String)
-
setServerName
void setServerName(java.lang.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.- See Also:
getServerName()
-
getServerPort
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.- Specified by:
getServerPort
in interfaceServerInfo
- Returns:
- The port which will be used upon contacting the Intelligence Server.
- See Also:
setServerPort(int)
-
setServerPort
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.- See Also:
getServerPort()
-
getProjectName
java.lang.String getProjectName()
Returns the project name which will be logged into.- Returns:
- The current setting of the projectName property.
- See Also:
setProjectName(java.lang.String)
-
getProjectID
java.lang.String getProjectID() throws WebObjectsException, java.lang.IllegalArgumentException
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:
java.lang.IllegalArgumentException
- if the projectName is not empty but invalidWebObjectsException
- Since:
- MicroStrategy Web 7.5.3
-
setProjectName
void setProjectName(java.lang.String projectName)
Sets the project name which will be logged into.- Parameters:
projectName
- The project to log into.- See Also:
getProjectName()
-
setProjectID
void setProjectID(java.lang.String dssID)
Sets the project DSS ID which will be logged into.- Parameters:
dssID
- The project to log into.- Since:
- MicroStrategy Web 9.0.0
-
getAuthMode
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:
- The current authMode setting, from
EnumDSSXMLAuthModes
. - See Also:
setAuthMode(int)
-
setAuthMode
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, fromEnumDSSXMLAuthModes
.- See Also:
getAuthMode()
-
getClientID
java.lang.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.
- See Also:
setClientID(java.lang.String)
-
setClientID
void setClientID(java.lang.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.- See Also:
getClientID()
-
getClientVersion
java.lang.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.
-
setClientVersion
void setClientVersion(java.lang.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.
-
getRegularWorkingSetSize
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.
- See Also:
setRegularWorkingSetSize(int)
-
setRegularWorkingSetSize
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.- See Also:
getRegularWorkingSetSize()
-
getSearchWorkingSetSize
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.
- See Also:
setSearchWorkingSetSize(int)
-
setSearchWorkingSetSize
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.- See Also:
getSearchWorkingSetSize()
-
getSessionFlags
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
EnumDSSXMLSessionFlags.DssXmlSessionDeleteReadMsgsOnClose
from the previous default of 0.- Returns:
- The current session flag value.
- See Also:
setSessionFlags(int)
-
setSessionFlags
void setSessionFlags(int newSessionFlags)
This value should be the bitwise or(|) of values fromEnumDSSXMLSessionFlags
. Sets the value to use for the session flags when creating a session (WebSessionInfo.getSessionID()
) or closing one (WebSessionInfo.closeSession()
). This setting may also be changed during a session viaupdateSessionParameters()
.- Parameters:
newSessionFlags
- The session flag value to be used.- See Also:
getSessionFlags()
-
getWebVersion
java.lang.String getWebVersion()
Returns the version of the Web API which is being used.- Returns:
- The version of the Web API.
-
getServerVersion
java.lang.String getServerVersion() throws WebObjectsException
Returns the version of the Intelligence Server specified by the serverName and port properties.- Returns:
- The version of the Intelligence Server.
- Throws:
WebObjectsException
- Thrown if an error occurs upon retrieving this information.
-
createCopy
WebIServerSession createCopy()
Creates a newWebIServerSession
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
-
getOutOfComplianceLicenses
SimpleList getOutOfComplianceLicenses(int[] levels) throws WebObjectsException
Returns the list of out of compliance licenses (of required compliance levels) for the current user session. The invalid licenses are returned asSimpleList
ofWebLicenseDetails
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
- Throws:
WebObjectsException
- if there was an error in IServer while validating the licenses.- Since:
- MicroStrategy Web 7.5.0
-
getApplicationType
int getApplicationType()
Returns the application type to be set on the session, fromEnumDSSXMLApplicationType
.- Returns:
- The current setting of the application type, from
EnumDSSXMLApplicationType
. - Since:
- MicroStrategy Web 7.5.2
-
setApplicationType
void setApplicationType(int applicationType)
Sets the application type to use when creating the session, fromEnumDSSXMLApplicationType
.}- Parameters:
applicationType
- The application type to use for the session, fromEnumDSSXMLApplicationType
.- Since:
- MicroStrategy Web 7.5.2
-
getKey
java.lang.String getKey()
Returns the unique key which identifies this session within its list. This key can be used with the getByKey method onWebIServerSessionList
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.
- Since:
- MicroStrategy Web 8.0.1
-
populate
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.- Since:
- MicroStrategy Web 8.0.1
-
isMDUser
boolean isMDUser() throws WebObjectsException
Returns a boolean to indicate whether the user that this session corresponds to is an actual user persisted in the metadata. In cases likeEnumDSSXMLAuthModes.DssXmlAuthLDAP
(where the LDAP user is not actually imported)EnumDSSXMLAuthModes.DssXmlAuthAnonymous
EnumDSSXMLAuthModes.DssXmlAuthWarehousePassthrough
- Returns:
- boolean to indicate whether the user that this session corresponds to is an actual user persisted in the metadata
- Throws:
WebObjectsException
- if there is an error while reading user information- Since:
- MicroStrategy Web 7.5.4
-
setToken
void setToken(java.lang.Object token)
Sets the token.- Parameters:
token
- The token value.- Since:
- MicroStrategy Web 8.0.1
-
clearToken
void clearToken()
Clears the token.- Since:
- MicroStrategy Web 8.0.1
-
getPartialURL
java.lang.String getPartialURL()
Returns the partial url set bysetPartialURL(String)
- Since:
- MicroStrategy Web 9.0.0
-
setPartialURL
void setPartialURL(java.lang.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- Parameters:
url
-- Since:
- MicroStrategy Web 9.0.0
-
getLDAPDistinguishedName
java.lang.String getLDAPDistinguishedName()
Get LDAP Distinguished Name for Single Sign on authentication mode- Returns:
- LDAP Distinguished Name for Single Sign on authentication mode
- Since:
- MicroStrategy Web 9.0.0
-
setLDAPDistinguishedName
void setLDAPDistinguishedName(java.lang.String LDAPDN)
Set LDAP Distinguished Name for Single Sign on authentication mode- Parameters:
LDAPDN
- LDAP Distinguished Name for Single Sign on authentication mode- Since:
- MicroStrategy Web 9.0.0
-
getTrustToken
java.lang.String getTrustToken()
Get Trust Token for Single Sign on authentication mode- Returns:
- Trust Token for Single Sign on authentication mode
- Since:
- MicroStrategy Web 9.0.0
-
setTrustToken
void setTrustToken(java.lang.String token)
Set Trust Token for Single Sign on authentication mode- Parameters:
token
- Trust Token for Single Sign on authentication mode- Since:
- MicroStrategy Web 9.0.0
-
generateNewTrustToken
java.lang.String generateNewTrustToken(java.lang.String identifier) throws WebObjectsException
Create Trust Relationship between Web Server and Intelligence Server.- Parameters:
identifier
- the web application name passed to Intelligence Server- Returns:
- Trust token for the create trust relationship
- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
deleteTrustToken
void deleteTrustToken(java.lang.String tokenString, java.lang.String severName) throws WebObjectsException
Delete Trust Relationship between Web Server and Intelligence Server.- Parameters:
tokenString
- token for the trust relationship to be deletedseverName
- the Web Server name for the Trust relationship- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
resolveLocalesOnly
void resolveLocalesOnly() throws WebObjectsException
Connects to the Intelligence Server to resolve the locales without creating a session.- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
resolveLocalesOnly
void resolveLocalesOnly(WebUserEntity oUserEntity) throws WebObjectsException
Connects to the Intelligence Server to resolve the locales without creating a session.- Parameters:
oUserEntity
- the user we want to apply- Throws:
WebObjectsException
-
updateSessionParameters
void updateSessionParameters() throws WebObjectsException
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)
)
- Throws:
WebObjectsException
- thrown if there was a problem readjusting.- Since:
- MicroStrategy Web 9.0.0
- Session flags (see
-
checkUserPrivilege
boolean checkUserPrivilege(int privilegeType) throws WebObjectsException
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 enumerationEnumDSSXMLPrivilegeTypes
- Returns:
- boolean value indicating if the specific privilege is available
- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
getGSSCredential
org.ietf.jgss.GSSCredential getGSSCredential()
Get GSS Delegation Credential for Kerberos Authentication mode- Returns:
- GSS Delegation Credential for Kerberos Authentication mode
- Since:
- MicroStrategy Web 9.0.1
-
setGSSCredential
void setGSSCredential(org.ietf.jgss.GSSCredential credential)
Set GSS Delegation Credential for Kerberos Authentication mode- Parameters:
credential
- GSS Delegation Credential for Kerberos Authentication mode- Since:
- MicroStrategy Web 9.0.1
-
setSessionKey
void setSessionKey(java.lang.String sessionKey)
Set session key for mobile encryption- Parameters:
sessionKey
- Session key for mobile encryption
-
getSessionKey
java.lang.String getSessionKey()
Get session key for mobile encryption- Returns:
- Session key for mobile encryption
-
setExtraParams
void setExtraParams(java.lang.String value)
-
getExtraParams
java.lang.String getExtraParams()
-
getMessageID
java.lang.String getMessageID()
-
getResultCode
java.lang.String getResultCode()
-
setExtraProperty
void setExtraProperty(java.lang.String name, java.lang.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 isEnumWebPersistableState.TYPICAL_STATE_INFO
or greater. Please carefully use this method, in case the session state is getting too long.- Parameters:
name
- property namevalue
- property value
-
getExtraProperty
java.lang.String getExtraProperty(java.lang.String name)
Get the extra property.- Parameters:
name
- property name- Returns:
- property value
-
getUserPreferences
Preferences getUserPreferences() throws WebObjectsException
- Throws:
WebObjectsException
-
getLastAccessTime
long getLastAccessTime()
Returns the last access time of the session.- Returns:
- The last access time of the session.
- Since:
- MicroStrategy Web Polaris
-
setLastMsgID
void setLastMsgID(java.lang.String lastMsgID)
set the last message ID- Parameters:
lastMsgID
-
-
getLastMsgID
java.lang.String getLastMsgID()
-
setAccessToken
void setAccessToken(java.lang.String accessToken)
Sets the access token- Parameters:
accessToken
-
-
getAccessToken
java.lang.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 withgetTrustToken()
, i.e. if access token is available, we ignore the trust token.- Returns:
- access token
-
setOrgID
void setOrgID(java.lang.String orgID)
Sets the Usher organization/network ID. This ID maybe different from the usher organization/network ID configured at Iserver side.- Parameters:
orgID
-
-
getOrgID
java.lang.String getOrgID()
Gets the Usher organization/network ID associated with this session.- Returns:
- Usher organization/network ID.
-
setTwoStepVerificationCode
void setTwoStepVerificationCode(java.lang.String twoStepVerificationCode)
Sets the two-step verification code- Parameters:
twoStepVerificationCode
-
-
getUsherSessionHelper
UsherSessionHelper getUsherSessionHelper()
-
createUsherAccount
java.lang.String createUsherAccount(java.lang.String email) throws WebObjectsException
- Throws:
WebObjectsException
-
setConfSessionID
void setConfSessionID(java.lang.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 toEnumDSSXMLAuthModes.DssXmlAuthSessionID
- Parameters:
confSessionID
-
-
createNewConfigSession
void createNewConfigSession(WebIServerSession existingActiveSession) throws WebObjectsException
Creates a newWebIServerSession
configuration session from existing active session, and populates session id- Throws:
WebObjectsException
-
createNewProjectSession
void createNewProjectSession(WebIServerSession existingActiveSession, java.lang.String projectId) throws WebObjectsException
Creates a newWebIServerSession
project session from existing active session for a given project DSS ID, and populates session id- Throws:
WebObjectsException
-
reconstructSymmetricClusterSessionId
void reconstructSymmetricClusterSessionId()
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
-
-