Class SingleSignOnEntry
- java.lang.Object
-
- org.apache.catalina.authenticator.SingleSignOnEntry
-
- All Implemented Interfaces:
Serializable
public class SingleSignOnEntry extends Object implements Serializable
A 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 Summary
Constructors Constructor Description SingleSignOnEntry(Principal principal, String authType, String username, String password)Creates a new SingleSignOnEntry
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddSession(SingleSignOn sso, String ssoId, Session session)Adds aSessionto the list of those associated with this SSO.Set<SingleSignOnSessionKey>findSessions()Returns the HTTP Session identifiers associated with this SSO.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.StringgetPassword()Gets the password credential (if any) associated with the SSO.PrincipalgetPrincipal()Gets thePrincipalthat has been authenticated by the SSO.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(Principal principal, String authType, String username, String password)Updates the SingleSignOnEntry to reflect the latest security information associated with the caller.
-
-
-
Constructor Detail
-
SingleSignOnEntry
public SingleSignOnEntry(Principal principal, String authType, String username, String password)
Creates a new SingleSignOnEntry- Parameters:
principal- thePrincipalreturned by the latest call toRealm.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 authentication
-
-
Method Detail
-
addSession
public void addSession(SingleSignOn sso, String ssoId, Session session)
Adds aSessionto the list of those associated with this SSO.- Parameters:
sso- TheSingleSignOnvalve that is managing the SSO session.ssoId- The ID of the SSO session.session- TheSessionbeing associated with the SSO.
-
removeSession
public void removeSession(Session session)
Removes the givenSessionfrom the list of those associated with this SSO.- Parameters:
session- theSessionto remove.
-
findSessions
public 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
-
getAuthType
public 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"
-
getCanReauthenticate
public boolean getCanReauthenticate()
Gets whether the authentication type associated with the original authentication supports reauthentication.- Returns:
trueifgetAuthTypereturns "BASIC" or "FORM",falseotherwise.
-
getPassword
public 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.
-
getPrincipal
public 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
-
getUsername
public 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
-
updateCredentials
public 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- thePrincipalreturned by the latest call toRealm.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 authentication
-
-