|
|||||||||
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 principal name of the SSOToken. |
java.lang.String |
getProperty(java.lang.String name)
Gets the property stored in this token. |
long |
getTimeLeft()
Returns the time left on the session based on max session time |
SSOTokenID |
getTokenID()
Returns SSOTokenID 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
None
- an
- SSOException if the SSOToken is not valid or if
there are errors in getting the principalpublic java.lang.String getAuthType() throws SSOException
None
- an
- SSOException if the SSOToken is not valid or if
there are errors in getting the authentication methodpublic int getAuthLevel() throws SSOException
None
- an
- SSOException if the SSOToken is not valid or if
there are errors in getting the authentication levelpublic java.net.InetAddress getIPAddress() throws SSOException
None
- an
- SSOException if the SSOToken is not valid or if
there are errors in getting the IP Address of the clientpublic java.lang.String getHostName() throws SSOException
None
- an
- SSOException if the SSOToken is not valid or if
there are errors in getting the host name of the clientpublic long getTimeLeft() throws SSOException
None
- an
- SSOException if the SSOToken is not valid or if
there are errors in getting the maximum session timepublic long getMaxSessionTime() throws SSOException
None
- an
- SSOException if the SSOToken is not valid or if
there are errors in getting the maximum session timepublic long getIdleTime() throws SSOException
None
- an
- SSOException if the SSOToken is not valid or if
there are errors in getting the session idle timepublic long getMaxIdleTime() throws SSOException
None
- An
- SSOException is thrown if the SSOToken is not valid or if
there are errors in getting the maximum idle timepublic SSOTokenID getTokenID()
None
- public void setProperty(java.lang.String name, java.lang.String value) throws SSOException
name
- The property namevalue
- The property valuean
- SSOException if the SSOToken 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 namean
- SSOException if the SSOToken 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.an
- SSOException if the token is not valid or if
there are errors in setting the SSO token listenerpublic java.lang.String encodeURL(java.lang.String url) throws SSOException
url
- , the URL to be encoded
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |