io.oasp.module.security.common.base.accesscontrol

Class AbstractAccessControlBasedAuthenticationProvider<U extends org.springframework.security.core.userdetails.UserDetails,P extends Principal>

java.lang.Object

org.springframework.security.authentication.dao.AbstractUserDetailsAuthenticationProvider

io.oasp.module.security.common.base.accesscontrol.AbstractAccessControlBasedAuthenticationProvider<U,P>

Type Parameters:

U - is the generic type of the UserDetails implementation used to bridge with spring-security.

P - is the generic type of the Principal for internal user representation to bridge with PrincipalAccessControlProvider.

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.MessageSourceAware, org.springframework.security.authentication.AuthenticationProvider

Direct Known Subclasses:

SimpleAccessControlBasedAuthenticationProvider

public abstract class AbstractAccessControlBasedAuthenticationProvider<U extends org.springframework.security.core.userdetails.UserDetails,P extends Principal>
extends org.springframework.security.authentication.dao.AbstractUserDetailsAuthenticationProvider

This is an implementation of AbstractUserDetailsAuthenticationProvider based on PrincipalAccessControlProvider and AccessControlProvider.

Author:

hohwille

Field Summary

Fields

Modifier and Type	Field and Description
private AccessControlProvider	accessControlProvider
private static org.slf4j.Logger	LOG The Logger instance.
private PrincipalAccessControlProvider<P>	principalAccessControlProvider

Fields inherited from class org.springframework.security.authentication.dao.AbstractUserDetailsAuthenticationProvider

hideUserNotFoundExceptions, logger, messages

Constructor Summary

Constructors

Constructor and Description
AbstractAccessControlBasedAuthenticationProvider() The constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	additionalAuthenticationChecks(org.springframework.security.core.userdetails.UserDetails userDetails, org.springframework.security.authentication.UsernamePasswordAuthenticationToken authentication) Here the actual authentication has to be implemented.
protected abstract U	createUser(String username, String password, P principal, Set<org.springframework.security.core.GrantedAuthority> authorities) Creates an instance of UserDetails that represent the user with the given username.
protected abstract P	retrievePrincipal(String username, org.springframework.security.authentication.UsernamePasswordAuthenticationToken authentication) Retrieves the internal Principal object representing the user.
protected org.springframework.security.core.userdetails.UserDetails	retrieveUser(String username, org.springframework.security.authentication.UsernamePasswordAuthenticationToken authentication)
void	setAccessControlProvider(AccessControlProvider accessControlProvider)
void	setPrincipalAccessControlProvider(PrincipalAccessControlProvider<P> principalAccessControlProvider)

Methods inherited from class org.springframework.security.authentication.dao.AbstractUserDetailsAuthenticationProvider

afterPropertiesSet, authenticate, createSuccessAuthentication, doAfterPropertiesSet, getPostAuthenticationChecks, getPreAuthenticationChecks, getUserCache, isForcePrincipalAsString, isHideUserNotFoundExceptions, setAuthoritiesMapper, setForcePrincipalAsString, setHideUserNotFoundExceptions, setMessageSource, setPostAuthenticationChecks, setPreAuthenticationChecks, setUserCache, supports

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

The Logger instance.

principalAccessControlProvider

private PrincipalAccessControlProvider<P extends Principal> principalAccessControlProvider

accessControlProvider

private AccessControlProvider accessControlProvider

Constructor Detail

AbstractAccessControlBasedAuthenticationProvider

public AbstractAccessControlBasedAuthenticationProvider()

The constructor.

Method Detail

setPrincipalAccessControlProvider

@Inject
public void setPrincipalAccessControlProvider(PrincipalAccessControlProvider<P> principalAccessControlProvider)

Parameters:

principalAccessControlProvider - the PrincipalAccessControlProvider to Inject.

setAccessControlProvider

@Inject
public void setAccessControlProvider(AccessControlProvider accessControlProvider)

Parameters:

accessControlProvider - the AccessControlProvider to Inject.

additionalAuthenticationChecks

protected void additionalAuthenticationChecks(org.springframework.security.core.userdetails.UserDetails userDetails,
                                  org.springframework.security.authentication.UsernamePasswordAuthenticationToken authentication)
                                       throws org.springframework.security.core.AuthenticationException

Here the actual authentication has to be implemented.

Specified by:

additionalAuthenticationChecks in class org.springframework.security.authentication.dao.AbstractUserDetailsAuthenticationProvider

Throws:

org.springframework.security.core.AuthenticationException

createUser

protected abstract U createUser(String username,
           String password,
           P principal,
           Set<org.springframework.security.core.GrantedAuthority> authorities)

Creates an instance of UserDetails that represent the user with the given username.

Parameters:

username - is the login of the user to create.

password - the password of the user.

principal - is the internal Principal that has been provided by retrievePrincipal(String, UsernamePasswordAuthenticationToken).

authorities - are the granted authorities or in other words the permissions of the user.

Returns:

the new user object.

retrievePrincipal

protected abstract P retrievePrincipal(String username,
                  org.springframework.security.authentication.UsernamePasswordAuthenticationToken authentication)

Retrieves the internal Principal object representing the user. This can be any object implementing Principal and can contain additional user details such as profile data. This object is used to retrieve the (top-level) AccessControls that have been granted to the user.

Parameters:

username - is the login of the user.

authentication - is the UsernamePasswordAuthenticationToken.

Returns:

the Principal.

retrieveUser

protected org.springframework.security.core.userdetails.UserDetails retrieveUser(String username,
                                                                     org.springframework.security.authentication.UsernamePasswordAuthenticationToken authentication)
                                                                          throws org.springframework.security.core.AuthenticationException

Specified by:

retrieveUser in class org.springframework.security.authentication.dao.AbstractUserDetailsAuthenticationProvider

Throws:

org.springframework.security.core.AuthenticationException