public class SingleSignOnEntry extends Object implements Serializable
AuthenticatorBase subclasses that need it in order to perform
 reauthentications when SingleSignOn is in use.SingleSignOn, 
AuthenticatorBase.reauthenticateFromSSO(java.lang.String, org.apache.catalina.connector.Request), 
Serialized Form| Modifier and Type | Field and Description | 
|---|---|
| protected String | authType | 
| protected boolean | canReauthenticate | 
| protected String | password | 
| protected Principal | principal | 
| protected ConcurrentMap<SingleSignOnSessionKey,SingleSignOnSessionKey> | sessionKeys | 
| protected String | username | 
| Constructor and Description | 
|---|
| SingleSignOnEntry(Principal principal,
                 String authType,
                 String username,
                 String password)Creates a new SingleSignOnEntry | 
| Modifier and Type | Method and Description | 
|---|---|
| void | addSession(SingleSignOn sso,
          String ssoId,
          Session session)Adds a  Sessionto the list of those associated with
 this SSO. | 
| Set<SingleSignOnSessionKey> | findSessions()Returns the HTTP Session identifiers associated with this SSO. | 
| String | getAuthType()Gets the name of the authentication type originally used to authenticate
 the user associated with the SSO. | 
| boolean | getCanReauthenticate()Gets whether the authentication type associated with the original
 authentication supports reauthentication. | 
| String | getPassword()Gets the password credential (if any) associated with the SSO. | 
| Principal | getPrincipal()Gets the  Principalthat has been authenticated by the SSO. | 
| String | getUsername()Gets the user name provided by the user as part of the authentication
 process. | 
| void | removeSession(Session session)Removes the given  Sessionfrom the list of those
 associated with this SSO. | 
| void | updateCredentials(Principal principal,
                 String authType,
                 String username,
                 String password)Updates the SingleSignOnEntry to reflect the latest security
 information associated with the caller. | 
protected String authType
protected String password
protected transient Principal principal
protected ConcurrentMap<SingleSignOnSessionKey,SingleSignOnSessionKey> sessionKeys
protected String username
protected boolean canReauthenticate
public SingleSignOnEntry(Principal principal, String authType, String username, String password)
principal - the Principal returned 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 authenticationpassword - the password (if any) used for the authenticationpublic void addSession(SingleSignOn sso, String ssoId, Session session)
Session to the list of those associated with
 this SSO.sso - The SingleSignOn valve that is managing
                  the SSO session.ssoId - The ID of the SSO session.session - The Session being associated with the SSO.public void removeSession(Session session)
Session from the list of those
 associated with this SSO.session - the Session to remove.public Set<SingleSignOnSessionKey> findSessions()
public String getAuthType()
public boolean getCanReauthenticate()
true if getAuthType returns
          "BASIC" or "FORM", false otherwise.public String getPassword()
null if the original authentication type
          does not involve a password.public Principal getPrincipal()
Principal that has been authenticated by the SSO.public String getUsername()
public void updateCredentials(Principal principal, String authType, String username, String password)
principal - the Principal returned 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 authenticationpassword - the password (if any) used for the authenticationCopyright © 2000-2020 Apache Software Foundation. All Rights Reserved.