com.addc.server.commons.security

Class ServerAuthenticationProvider

java.lang.Object

com.addc.server.commons.security.ServerAuthenticationProvider

All Implemented Interfaces:

org.springframework.security.authentication.AuthenticationProvider

public class ServerAuthenticationProvider
extends Object
implements org.springframework.security.authentication.AuthenticationProvider

The ServerAuthenticationProvider supplies the Authentication provider for all servers. This class wraps whatever provider you wish to use and integrates an AuthorizationMapper so that Authetication will create a current user object in the Spring Framework with fully mapped roles/autorities in a transparent manner.

Constructor Summary

Constructors

Constructor and Description
ServerAuthenticationProvider(org.springframework.security.authentication.AuthenticationProvider wrappedAuthenticationProvider) Create a new ServerAuthenticationProvider using a DefaultAuthorizationMapper
ServerAuthenticationProvider(AuthorizationMapper authorizationMapper, org.springframework.security.authentication.AuthenticationProvider wrappedAuthenticationProvider) Create a new ServerAuthenticationProvider
ServerAuthenticationProvider(AuthorizationMapper authorizationMapper, org.springframework.security.authentication.AuthenticationProvider wrappedAuthenticationProvider, List<String> requiredRoles) Create new ServerAuthenticationProvider

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.security.core.Authentication	authenticate(org.springframework.security.core.Authentication authentication) Authenticate the user using the wrapped authentication provider, map any roles and check that the user has the required roles.
org.springframework.security.core.Authentication	authenticate(org.springframework.security.core.Authentication authentication, boolean checkRequired) Authenticate the user using the wrapped authentication provider, map any roles and optionally check that the user has the required roles.
void	setRequiredRoles(List<String> requiredRoles) Set the roles a user must have to be successfully authenticated
boolean	supports(Class<?> authentication)

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerAuthenticationProvider

public ServerAuthenticationProvider(org.springframework.security.authentication.AuthenticationProvider wrappedAuthenticationProvider)

Create a new ServerAuthenticationProvider using a DefaultAuthorizationMapper

Parameters:

wrappedAuthenticationProvider - The wrapped AuthenticationProvider

ServerAuthenticationProvider

public ServerAuthenticationProvider(AuthorizationMapper authorizationMapper,
                            org.springframework.security.authentication.AuthenticationProvider wrappedAuthenticationProvider)

Create a new ServerAuthenticationProvider

Parameters:

authorizationMapper - The AuthorizationMapper to use

wrappedAuthenticationProvider - The wrapped AuthenticationProvider

ServerAuthenticationProvider

public ServerAuthenticationProvider(AuthorizationMapper authorizationMapper,
                            org.springframework.security.authentication.AuthenticationProvider wrappedAuthenticationProvider,
                            List<String> requiredRoles)

Create new ServerAuthenticationProvider

Parameters:

authorizationMapper - The AuthorizationMapper to use

wrappedAuthenticationProvider - The wrapped AuthenticationProvider

requiredRoles - A list of roles. If not empty the user must have one of these roles to authenticated

Method Detail

setRequiredRoles

public void setRequiredRoles(List<String> requiredRoles)

Set the roles a user must have to be successfully authenticated

Parameters:

requiredRoles - the roles a user must have to be successfully authenticated

authenticate

public org.springframework.security.core.Authentication authenticate(org.springframework.security.core.Authentication authentication)
                                                              throws org.springframework.security.core.AuthenticationException

Authenticate the user using the wrapped authentication provider, map any roles and check that the user has the required roles.

Specified by:

authenticate in interface org.springframework.security.authentication.AuthenticationProvider

Parameters:

authentication - The Authentication to validate

Throws:

org.springframework.security.core.AuthenticationException - Can be thrown by the underlying wrapped authentication provider

authenticate

public org.springframework.security.core.Authentication authenticate(org.springframework.security.core.Authentication authentication,
                                                            boolean checkRequired)
                                                              throws org.springframework.security.core.AuthenticationException

Authenticate the user using the wrapped authentication provider, map any roles and optionally check that the user has the required roles.

Parameters:

authentication - The Authentication to validate

checkRequired - If true check the reuired roles if any

Returns:

A UsernamePasswordAuthenticationToken if the user was authenticated otherwise null.

Throws:

org.springframework.security.core.AuthenticationException - Can be thrown by the underlying wrapped authentication provider

supports

public boolean supports(Class<?> authentication)

Specified by:

supports in interface org.springframework.security.authentication.AuthenticationProvider