de.hybris.platform.spring.security

Class CoreAuthenticationProvider

java.lang.Object

de.hybris.platform.spring.security.CoreAuthenticationProvider

Direct Known Subclasses:

BackofficeAuthenticationProvider, CockpitAuthenticationProvider, InstoreAuthenticationProvider

public class CoreAuthenticationProvider
extends Object

A base AuthenticationProvider which is designed to respond to UsernamePasswordAuthenticationToken and RememberMeAuthenticationToken authentication requests.

Upon successful validation, a UsernamePasswordAuthenticationToken or RememberMeAuthenticationToken will be created and returned to the caller. The token will include as its principal either a String representation of the username, or the CoreUserDetails that was returned from the authentication repository. Using String is appropriate if a container adapter is being used, as it expects String representations of the username. Using CoreUserDetails is appropriate if you require access to additional properties of the authenticated user, such as email addresses, human-friendly names etc. As container adapters are not recommended to be used, and CoreUserDetails implementations provide additional flexibility, by default a CoreUserDetails is returned.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CoreAuthenticationProvider.CoreAuthenticationException

Field Summary

Fields

Modifier and Type	Field and Description
protected MessageSourceAccessor	messages

Constructor Summary

Constructors

Constructor and Description
CoreAuthenticationProvider()

Method Summary

Modifier and Type	Method and Description
protected void	additionalAuthenticationChecks(UserDetails details, AbstractAuthenticationToken authentication)
void	afterPropertiesSet()
Authentication	authenticate(Authentication authentication)
protected Authentication	createSuccessAuthentication(Authentication authentication, UserDetails user) Creates a successful Authentication object.
UserDetailsChecker	getPreAuthenticationChecks()
UserDetailsService	getUserDetailsService()
protected UserDetails	retrieveUser(String username)
void	setMessageSource(MessageSource messageSource)
void	setPreAuthenticationChecks(UserDetailsChecker preAuthenticationChecks)
void	setUserDetailsService(UserDetailsService userDetailsService)
boolean	supports(Class authentication)

Methods inherited from class java.lang.Object

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

Field Detail

messages

protected MessageSourceAccessor messages

Constructor Detail

CoreAuthenticationProvider

public CoreAuthenticationProvider()

Method Detail

setMessageSource

public void setMessageSource(MessageSource messageSource)

afterPropertiesSet

public final void afterPropertiesSet()
                              throws Exception

Throws:

Exception

setPreAuthenticationChecks

public void setPreAuthenticationChecks(UserDetailsChecker preAuthenticationChecks)

getPreAuthenticationChecks

public UserDetailsChecker getPreAuthenticationChecks()

authenticate

public Authentication authenticate(Authentication authentication)
                            throws AuthenticationException

Throws:

AuthenticationException

getUserDetailsService

public UserDetailsService getUserDetailsService()

setUserDetailsService

public void setUserDetailsService(UserDetailsService userDetailsService)

additionalAuthenticationChecks

protected void additionalAuthenticationChecks(UserDetails details,
                                              AbstractAuthenticationToken authentication)
                                       throws AuthenticationException

Throws:

AuthenticationException

supports

public boolean supports(Class authentication)

retrieveUser

protected final UserDetails retrieveUser(String username)
                                  throws AuthenticationException

Throws:

AuthenticationException

createSuccessAuthentication

protected Authentication createSuccessAuthentication(Authentication authentication,
                                                     UserDetails user)

Creates a successful Authentication object.

Protected so subclasses can override.

Subclasses will usually store the original credentials the user supplied (not salted or encoded passwords) in the returned Authentication object.

Parameters:

authentication - that was presented to the provider for validation

user - that was loaded by the implementation

Returns:

the successful authentication token