Class SingleSignOnEntry
- java.lang.Object
- 
- org.apache.catalina.authenticator.SingleSignOnEntry
 
- 
- All Implemented Interfaces:
- java.io.Serializable
 
 public class SingleSignOnEntry extends java.lang.Object implements java.io.SerializableA class that represents entries in the cache of authenticated users. This is necessary to make it available toAuthenticatorBasesubclasses 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:
- SingleSignOn,- AuthenticatorBase.reauthenticateFromSSO(java.lang.String, org.apache.catalina.connector.Request), Serialized Form
 
- 
- 
Constructor SummaryConstructors Constructor Description SingleSignOnEntry(java.security.Principal principal, java.lang.String authType, java.lang.String username, java.lang.String password)Creates a new SingleSignOnEntry
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddSession(SingleSignOn sso, java.lang.String ssoId, Session session)Adds aSessionto the list of those associated with this SSO.java.util.Set<SingleSignOnSessionKey>findSessions()Returns the HTTP Session identifiers associated with this SSO.java.lang.StringgetAuthType()Gets the name of the authentication type originally used to authenticate the user associated with the SSO.booleangetCanReauthenticate()Gets whether the authentication type associated with the original authentication supports reauthentication.java.lang.StringgetPassword()Gets the password credential (if any) associated with the SSO.java.security.PrincipalgetPrincipal()Gets thePrincipalthat has been authenticated by the SSO.java.lang.StringgetUsername()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(java.security.Principal principal, java.lang.String authType, java.lang.String username, java.lang.String password)Updates the SingleSignOnEntry to reflect the latest security information associated with the caller.
 
- 
- 
- 
Constructor Detail- 
SingleSignOnEntrypublic SingleSignOnEntry(java.security.Principal principal, java.lang.String authType, java.lang.String username, java.lang.String password)Creates 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 Detail- 
addSessionpublic void addSession(SingleSignOn sso, java.lang.String ssoId, Session session) Adds 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.
 
 - 
removeSessionpublic void removeSession(Session session) Removes the givenSessionfrom the list of those associated with this SSO.- Parameters:
- session- the- Sessionto remove.
 
 - 
findSessionspublic java.util.Set<SingleSignOnSessionKey> findSessions() Returns the HTTP Session identifiers associated with this SSO.- Returns:
- The identifiers for the HTTP sessions that are current associated with this SSo entry
 
 - 
getAuthTypepublic java.lang.String getAuthType() Gets 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.
 
 - 
getPasswordpublic java.lang.String getPassword() Gets 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.
 
 - 
getPrincipalpublic java.security.Principal getPrincipal() Gets thePrincipalthat has been authenticated by the SSO.- Returns:
- The Principal that was created by the authentication that triggered the creation of the SSO entry
 
 - 
getUsernamepublic java.lang.String getUsername() Gets 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(java.security.Principal principal, java.lang.String authType, java.lang.String username, java.lang.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
 
 
- 
 
-