Package com.microstrategy.web.objects
Interface UsherSessionHelper
-
public interface UsherSessionHelper
Usher related information can be obtained from the Intelligence Server configured in the underlyingWebIServerSession
.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
SESSION_TAG
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
clear()
java.lang.String
getClientId()
java.lang.String
getOrgId()
java.lang.String
getUsherBaseURL()
java.lang.String
getUsherDevice()
To get the USHER_SSO_DEVICEjava.lang.String
getUsherSession()
java.lang.String
getUsherSessionState()
java.lang.String
getUsherToken()
WebIServerSession
getWebIServerSession()
boolean
hasUsherConfiguration()
boolean
is2ndFactorEnabled()
boolean
isEqual(UsherSessionHelper other)
void
populate()
If thisWebIServerSession
does not define a server, a search will be made of the connected servers to find one with Usher configured.void
populate(RequestKeys keys)
void
populate(java.lang.String usherSessionState)
void
setUsherDevice(java.lang.String usherSSODevice)
To set the USHER_SSO_DEVICE id of the clientvoid
setUsherSession(java.lang.String usherSSOSession)
-
-
-
Field Detail
-
SESSION_TAG
static final java.lang.String SESSION_TAG
- See Also:
- Constant Field Values
-
-
Method Detail
-
getWebIServerSession
WebIServerSession getWebIServerSession()
-
getOrgId
java.lang.String getOrgId() throws WebObjectsException
- Throws:
WebObjectsException
-
getClientId
java.lang.String getClientId() throws WebObjectsException
- Throws:
WebObjectsException
-
getUsherToken
java.lang.String getUsherToken() throws WebObjectsException
- Throws:
WebObjectsException
-
is2ndFactorEnabled
boolean is2ndFactorEnabled() throws WebObjectsException
- Throws:
WebObjectsException
-
getUsherBaseURL
java.lang.String getUsherBaseURL() throws WebObjectsException
- Throws:
WebObjectsException
-
hasUsherConfiguration
boolean hasUsherConfiguration() throws WebObjectsException
- Throws:
WebObjectsException
-
isEqual
boolean isEqual(UsherSessionHelper other) throws WebObjectsException
- Throws:
WebObjectsException
-
getUsherSession
java.lang.String getUsherSession()
-
getUsherDevice
java.lang.String getUsherDevice()
To get the USHER_SSO_DEVICE- Returns:
- String
-
setUsherSession
void setUsherSession(java.lang.String usherSSOSession)
-
setUsherDevice
void setUsherDevice(java.lang.String usherSSODevice)
To set the USHER_SSO_DEVICE id of the client- Parameters:
usherSSODevice
-
-
getUsherSessionState
java.lang.String getUsherSessionState()
-
populate
void populate() throws WebObjectsException
If thisWebIServerSession
does not define a server, a search will be made of the connected servers to find one with Usher configured. ThisWebIServerSession
will then be updated with the server and port. Useful for login first functionality where a server has not yet been elected.- Throws:
WebObjectsException
-
populate
void populate(java.lang.String usherSessionState) throws WebObjectsException
- Throws:
WebObjectsException
- See Also:
populate()
-
populate
void populate(RequestKeys keys) throws WebObjectsException
- Throws:
WebObjectsException
- See Also:
populate()
-
clear
void clear()
-
-