Class AuthenticationManagerImpl
java.lang.Object
org.craftercms.security.authentication.impl.AuthenticationManagerImpl
- All Implemented Interfaces:
AuthenticationManager
Default implementation of
AuthenticationManager
.- Author:
- avasquez
-
Field Summary
Modifier and TypeFieldDescriptionprotected AuthenticationCache
protected org.craftercms.profile.api.services.AuthenticationService
protected org.craftercms.profile.api.services.ProfileService
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionauthenticateUser
(String[] tenants, String username, String password) Authenticates a user.authenticateUser
(String tenant, String username, String password) Authenticates a user.authenticateUser
(org.craftercms.profile.api.Profile profile) Authenticates a user just with it's profile ID.authenticateUser
(org.craftercms.profile.api.Profile profile, boolean remembered) Authenticates a user just with it's profile ID.getAuthentication
(String ticket, boolean reloadProfile) Returns the authentication associated to the given ticket IDvoid
invalidateAuthentication
(Authentication authentication) Invalidates the given authentication.protected org.craftercms.profile.api.Profile
loadProfile
(String ticketId) void
setAuthenticationCache
(AuthenticationCache authenticationCache) void
setAuthenticationService
(org.craftercms.profile.api.services.AuthenticationService authenticationService) void
setProfileService
(org.craftercms.profile.api.services.ProfileService profileService)
-
Field Details
-
authenticationService
protected org.craftercms.profile.api.services.AuthenticationService authenticationService -
profileService
protected org.craftercms.profile.api.services.ProfileService profileService -
authenticationCache
-
-
Constructor Details
-
AuthenticationManagerImpl
public AuthenticationManagerImpl()
-
-
Method Details
-
setAuthenticationService
public void setAuthenticationService(org.craftercms.profile.api.services.AuthenticationService authenticationService) -
setProfileService
public void setProfileService(org.craftercms.profile.api.services.ProfileService profileService) -
setAuthenticationCache
-
authenticateUser
Description copied from interface:AuthenticationManager
Authenticates a user.- Specified by:
authenticateUser
in interfaceAuthenticationManager
- Parameters:
tenant
- the tenant's name the user profile belongs tousername
- the user's usernamepassword
- the user's password- Returns:
- the authentication object, which contains the ticket and the user's profile
-
authenticateUser
public Authentication authenticateUser(String[] tenants, String username, String password) throws AuthenticationException Description copied from interface:AuthenticationManager
Authenticates a user.- Specified by:
authenticateUser
in interfaceAuthenticationManager
- Parameters:
tenants
- the tenant chain to try authentication withusername
- the user's usernamepassword
- the user's password- Returns:
- the authentication object, which contains the ticket and the user's profile
- Throws:
AuthenticationException
-
authenticateUser
public Authentication authenticateUser(org.craftercms.profile.api.Profile profile) throws AuthenticationException Description copied from interface:AuthenticationManager
Authenticates a user just with it's profile ID. Use only when the user has already being identified.- Specified by:
authenticateUser
in interfaceAuthenticationManager
- Parameters:
profile
- the user's profile- Returns:
- the authentication object, which contains the ticket and the user's profile
- Throws:
AuthenticationException
-
authenticateUser
public Authentication authenticateUser(org.craftercms.profile.api.Profile profile, boolean remembered) throws AuthenticationException Description copied from interface:AuthenticationManager
Authenticates a user just with it's profile ID. Use only when the user has already being identified.- Specified by:
authenticateUser
in interfaceAuthenticationManager
- Parameters:
profile
- the user's profileremembered
- if the authentication was done through remember me.- Returns:
- the authentication object, which contains the ticket and the user's profile
- Throws:
AuthenticationException
-
getAuthentication
public Authentication getAuthentication(String ticket, boolean reloadProfile) throws AuthenticationException Description copied from interface:AuthenticationManager
Returns the authentication associated to the given ticket ID- Specified by:
getAuthentication
in interfaceAuthenticationManager
- Parameters:
ticket
- the authentication ticketreloadProfile
- if the cached profile should be reloaded- Returns:
- the authentication object associated to the ticket ID, or null if no authentication was found for the ticket ID (anonymous user)
- Throws:
AuthenticationException
-
invalidateAuthentication
Description copied from interface:AuthenticationManager
Invalidates the given authentication.- Specified by:
invalidateAuthentication
in interfaceAuthenticationManager
- Parameters:
authentication
- the authentication to invalidate
-
loadProfile
protected org.craftercms.profile.api.Profile loadProfile(String ticketId) throws AuthenticationException - Throws:
AuthenticationException
-