|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.iplanet.sso.SSOTokenManager
The class SSOTokenManager
is a final
class
that provides interfaces to create and validate SSOToken
s.
It is a
singleton class; an instance of this class can be obtained by
calling SSOTokenManager.getInstance()
.
Having obtained an instance of SSOTokenManager
,
its methods can be called to create SSOToken
, get
SSOToken
given the SSOTokenID
in string
format, and to validate SSOToken
s.
Field Summary | |
static Debug |
debug
|
Method Summary | |
SSOToken |
createSSOToken(javax.servlet.http.HttpServletRequest request)
Creates a single sign on token from HttpServletRequest |
SSOToken |
createSSOToken(java.security.Principal user,
java.lang.String password)
Deprecated. This method has been deprecated. Please use the regular LDAP authentication mechanism instead. More information on how to use the authentication programming interfaces as well as the code samples can be obtained from the "Authentication Service" chapter of the Access Manager Developer's Guide. |
SSOToken |
createSSOToken(java.lang.String tokenId)
Creates a single sign on token from the single sign on token ID. |
SSOToken |
createSSOToken(java.lang.String tokenId,
java.lang.String clientIP)
Creates a single sign on token from the single sign on token ID. |
void |
destroyToken(SSOToken token)
Destroys a single sign on token. |
void |
destroyToken(SSOToken destroyer,
SSOToken destroyed)
Destroys a single sign on token. |
static SSOTokenManager |
getInstance()
Returns the singleton instance of SSOTokenManager . |
java.util.Set |
getValidSessions(SSOToken requester,
java.lang.String server)
Returns a list of single sign on token objects which correspond to valid Sessions accessible to requester. |
boolean |
isValidToken(SSOToken token)
Returns true if a single sign on token is valid. |
void |
refreshSession(SSOToken token)
Refresh the Session corresponding to the single sign on token from the Session Server. |
void |
validateToken(SSOToken token)
Returns true if the single sign on token is valid. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static Debug debug
Method Detail |
public static SSOTokenManager getInstance() throws SSOException
SSOTokenManager
.SSOTokenManager
instanceSSOException
- if unable to get the singleton
SSOTokenManager
instance.public SSOToken createSSOToken(javax.servlet.http.HttpServletRequest request) throws java.lang.UnsupportedOperationException, SSOException
HttpServletRequest
request
- The HttpServletRequest
object which contains
the session string.SSOException
- if the single sign on token cannot be
created.java.lang.UnsupportedOperationException
- if this is an unsupported
operation.public SSOToken createSSOToken(java.security.Principal user, java.lang.String password) throws java.lang.UnsupportedOperationException, SSOException
getAuthType(), getHostName(), getIPAddress(), setProperty(String name, String value), getProperty(String name), isValid(), validate().
user
- Principal representing a user or servicepassword
- The password supplied for the principalSSOException
- if the single sign on token cannot be
created.java.lang.UnsupportedOperationException
- if this is an unsupported
operation.public SSOToken createSSOToken(java.lang.String tokenId) throws java.lang.UnsupportedOperationException, SSOException
creatSSOToken(String, String)
OR
createSSOToken(HttpServletRequest)
.tokenId
- Token ID of the single sign on tokenSSOException
- if the single sign on token cannot be
created.java.lang.UnsupportedOperationException
- public SSOToken createSSOToken(java.lang.String tokenId, java.lang.String clientIP) throws java.lang.UnsupportedOperationException, SSOException
tokenId
- Token ID of the single sign on tokenclientIP
- Client IP address. This must be the IP address of the
client/user who is accessing the application.SSOException
- if the single sign on token cannot be
created.java.lang.UnsupportedOperationException
- public boolean isValidToken(SSOToken token)
token
- The single sign on token object to be validated.public void validateToken(SSOToken token) throws SSOException
token
- The single sign on token object to be validated.SSOException
- if the single sign on token is not valid.public void destroyToken(SSOToken token) throws SSOException
token
- The single sign on token object to be destroyed.SSOException
- if there was an error while destroying
the token, or the corresponding session reached its maximum
session/idle time, or the session was destroyed.public void refreshSession(SSOToken token) throws SSOException
token
- single sign on tokenSSOException
- if the session reached its maximum
session time, or the session was destroyed, or there was
an error while refreshing the session.public void destroyToken(SSOToken destroyer, SSOToken destroyed) throws SSOException
destroyer
- The single sign on token object used to authorize the
operationdestroyed
- The single sign on token object to be destroyed.SSOException
- if the there was an error during communication
with session service.public java.util.Set getValidSessions(SSOToken requester, java.lang.String server) throws SSOException
requester
- The single sign on token object used to authorize the
operationserver
- The server for which the valid sessions are to be retrievedSSOException
- if the there was an error during
communication with session service.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |