Class SingleSignOnEntry
java.lang.Object
org.apache.catalina.authenticator.SingleSignOnEntry
- All Implemented Interfaces:
- Serializable
A class that represents entries in the cache of authenticated users. This is necessary to make it available to
 
AuthenticatorBase subclasses that need it in order to perform reauthentications when SingleSignOn is in
 use.- Author:
- B Stansberry, based on work by Craig R. McClanahan
- See Also:
- 
Constructor SummaryConstructorsConstructorDescriptionSingleSignOnEntry(Principal principal, String authType, String username, String password) Creates a new SingleSignOnEntry
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddSession(SingleSignOn sso, String ssoId, Session session) Adds aSessionto the list of those associated with this SSO.Returns the HTTP Session identifiers associated with this SSO.Gets the name of the authentication type originally used to authenticate the user associated with the SSO.booleanGets whether the authentication type associated with the original authentication supports reauthentication.Gets the password credential (if any) associated with the SSO.Gets thePrincipalthat has been authenticated by the SSO.Gets the user name provided by the user as part of the authentication process.voidremoveSession(Session session) Removes the givenSessionfrom the list of those associated with this SSO.voidupdateCredentials(Principal principal, String authType, String username, String password) Updates the SingleSignOnEntry to reflect the latest security information associated with the caller.
- 
Constructor Details- 
SingleSignOnEntryCreates a new SingleSignOnEntry- Parameters:
- principal- the- Principalreturned by the latest call to- Realm.authenticate.
- authType- the type of authenticator used (BASIC, CLIENT_CERT, DIGEST or FORM)
- username- the username (if any) used for the authentication
- password- the password (if any) used for the authentication
 
 
- 
- 
Method Details- 
addSessionAdds aSessionto the list of those associated with this SSO.- Parameters:
- sso- The- SingleSignOnvalve that is managing the SSO session.
- ssoId- The ID of the SSO session.
- session- The- Sessionbeing associated with the SSO.
 
- 
removeSessionRemoves the givenSessionfrom the list of those associated with this SSO.- Parameters:
- session- the- Sessionto remove.
 
- 
findSessionsReturns the HTTP Session identifiers associated with this SSO.- Returns:
- The identifiers for the HTTP sessions that are current associated with this SSo entry
 
- 
getAuthTypeGets the name of the authentication type originally used to authenticate the user associated with the SSO.- Returns:
- "BASIC", "CLIENT_CERT", "DIGEST", "FORM" or "NONE"
 
- 
getCanReauthenticatepublic boolean getCanReauthenticate()Gets whether the authentication type associated with the original authentication supports reauthentication.- Returns:
- trueif- getAuthTypereturns "BASIC" or "FORM",- falseotherwise.
 
- 
getPasswordGets the password credential (if any) associated with the SSO.- Returns:
- the password credential associated with the SSO, or nullif the original authentication type does not involve a password.
 
- 
getPrincipalGets thePrincipalthat has been authenticated by the SSO.- Returns:
- The Principal that was created by the authentication that triggered the creation of the SSO entry
 
- 
getUsernameGets the user name provided by the user as part of the authentication process.- Returns:
- The user name that was authenticated as part of the authentication that triggered the creation of the SSO entry
 
- 
updateCredentialspublic void updateCredentials(Principal principal, String authType, String username, String password) Updates the SingleSignOnEntry to reflect the latest security information associated with the caller.- Parameters:
- principal- the- Principalreturned by the latest call to- Realm.authenticate.
- authType- the type of authenticator used (BASIC, CLIENT_CERT, DIGEST or FORM)
- username- the username (if any) used for the authentication
- password- the password (if any) used for the authentication
 
 
-