Package org.craftercms.security.authentication.impl

Class AuthenticationManagerImpl

java.lang.Object

org.craftercms.security.authentication.impl.AuthenticationManagerImpl

All Implemented Interfaces:

AuthenticationManager

public class AuthenticationManagerImpl
extends Object
implements AuthenticationManager

Default implementation of AuthenticationManager.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
protected AuthenticationCache	authenticationCache
protected org.craftercms.profile.api.services.AuthenticationService	authenticationService
protected org.craftercms.profile.api.services.ProfileService	profileService

Constructor Summary

Constructors

Constructor	Description
AuthenticationManagerImpl()

Method Summary

Modifier and Type	Method	Description
Authentication	authenticateUser(String[] tenants, String username, String password)	Authenticates a user.
Authentication	authenticateUser(String tenant, String username, String password)	Authenticates a user.
Authentication	authenticateUser(org.craftercms.profile.api.Profile profile)	Authenticates a user just with it's profile ID.
Authentication	authenticateUser(org.craftercms.profile.api.Profile profile, boolean remembered)	Authenticates a user just with it's profile ID.
Authentication	getAuthentication(String ticket, boolean reloadProfile)	Returns the authentication associated to the given ticket ID
void	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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

authenticationService

protected org.craftercms.profile.api.services.AuthenticationService authenticationService

profileService

protected org.craftercms.profile.api.services.ProfileService profileService

authenticationCache

protected AuthenticationCache authenticationCache

Constructor Detail

AuthenticationManagerImpl

public AuthenticationManagerImpl()

Method Detail

setAuthenticationService

public void setAuthenticationService(org.craftercms.profile.api.services.AuthenticationService authenticationService)

setProfileService

public void setProfileService(org.craftercms.profile.api.services.ProfileService profileService)

setAuthenticationCache

public void setAuthenticationCache(AuthenticationCache authenticationCache)

authenticateUser

public Authentication authenticateUser(String tenant,
                                       String username,
                                       String password)

Description copied from interface: AuthenticationManager

Authenticates a user.

Specified by:

authenticateUser in interface AuthenticationManager

Parameters:

tenant - the tenant's name the user profile belongs to

username - the user's username

password - 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 interface AuthenticationManager

Parameters:

tenants - the tenant chain to try authentication with

username - the user's username

password - 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 interface AuthenticationManager

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 interface AuthenticationManager

Parameters:

profile - the user's profile

remembered - 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 interface AuthenticationManager

Parameters:

ticket - the authentication ticket

reloadProfile - 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

public void invalidateAuthentication(Authentication authentication)

Description copied from interface: AuthenticationManager

Invalidates the given authentication.

Specified by:

invalidateAuthentication in interface AuthenticationManager

Parameters:

authentication - the authentication to invalidate

loadProfile

protected org.craftercms.profile.api.Profile loadProfile(String ticketId)
                                                  throws AuthenticationException

Throws:

AuthenticationException