|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The SSOToken
class represents a "single sign on"(SSO) token. It
contains SSO token-related information such as authentication method used
for authentication, authentication level of the authentication method,
host name of the client that sent the request (browser). It also contains
session-related information such as maximum session time, maximum session
idle time and session idle time.
Method Summary | |
void |
addSSOTokenListener(SSOTokenListener listener)
Adds an SSO token listener for the token change events. |
java.lang.String |
encodeURL(java.lang.String url)
Returns the encoded URL , rewritten to include the session id. |
int |
getAuthLevel()
Returns the authentication level of the authentication method used for authentication. |
java.lang.String |
getAuthType()
Returns the authentication method used for authentication. |
java.lang.String |
getHostName()
Returns the host name of the client (browser) that sent the request. |
long |
getIdleTime()
Returns the session idle time in seconds. |
java.net.InetAddress |
getIPAddress()
Returns the IP Address of the client (browser) that sent the request. |
long |
getMaxIdleTime()
Returns the maximum session idle time in minutes. |
long |
getMaxSessionTime()
Returns the maximum session time in minutes. |
java.security.Principal |
getPrincipal()
Returns the value of the property "Principal" set to the single sign on token. |
java.lang.String |
getProperty(java.lang.String name)
Gets the property stored in this token. |
long |
getTimeLeft()
Returns the time left in seconds on the session based on max session time. |
SSOTokenID |
getTokenID()
Returns single sign on token ID object. |
void |
setProperty(java.lang.String name,
java.lang.String value)
Sets a property for this token. |
Method Detail |
public java.security.Principal getPrincipal() throws SSOException
SSOException
- if the single sign on token is not valid or if
there are errors in getting the principalpublic java.lang.String getAuthType() throws SSOException
SSOException
- if the single sign on token is not valid or if
there are errors in getting the authentication methodpublic int getAuthLevel() throws SSOException
SSOException
- if the single sign on token is not valid or if
there are errors in getting the authentication levelpublic java.net.InetAddress getIPAddress() throws SSOException
SSOException
- if the single sign on token is not valid or if
there are errors in getting the IP Address of the clientpublic java.lang.String getHostName() throws SSOException
SSOException
- if the single sign on token is not valid or if
there are errors in getting the host name of the clientpublic long getTimeLeft() throws SSOException
SSOException
- if the single sign on token is not valid or if
there are errors in getting the maximum session time.public long getMaxSessionTime() throws SSOException
SSOException
- if the single sign on token is not valid or if
there are errors in getting the maximum session timepublic long getIdleTime() throws SSOException
SSOException
- if the single sign on token is not valid or if
there are errors in getting the session idle timepublic long getMaxIdleTime() throws SSOException
SSOException
- if the single sign on token is not valid or if
there are errors in getting the maximum idle timepublic SSOTokenID getTokenID()
public void setProperty(java.lang.String name, java.lang.String value) throws SSOException
name
- The property name.value
- The property value.SSOException
- if the single sign on token is not valid or if
there are errors in setting the property name and valuepublic java.lang.String getProperty(java.lang.String name) throws SSOException
name
- The property name.SSOException
- if the single sign on token is not valid or if
there are errors in getting the property valuepublic void addSSOTokenListener(SSOTokenListener listener) throws SSOException
listener
- A reference to an SSOTokenListener
object.SSOException
- if the token is not valid or if
there are errors in setting the SSO token listener.public java.lang.String encodeURL(java.lang.String url) throws SSOException
Encoded URL format if query string in the original URL passed is present will be :
protocol://server:port/path?queryString&cookieName=cookieValueEncoded URL format if query string in the original URL passed is not present will be:
protocol://server:port/path?cookieName=cookieValue
url
- the URL to be encodedSSOException
- if URL cannot be encoded.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |