org.springframework.security.adapters

Class AuthByAdapterProvider

java.lang.Object

org.springframework.security.adapters.AuthByAdapterProvider

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, org.springframework.context.MessageSourceAware, AuthenticationProvider

public class AuthByAdapterProvider
extends java.lang.Object
implements org.springframework.beans.factory.InitializingBean, AuthenticationProvider, org.springframework.context.MessageSourceAware

An AuthenticationProvider implementation that can authenticate an AuthByAdapter.

Configured in the bean context with a key that should match the key used by adapters to generate AuthByAdapter instances. It treats as valid any such instance presenting a hash code that matches the AuthByAdapterProvider-configured key.

If the key does not match, a BadCredentialsException is thrown.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.support.MessageSourceAccessor	messages

Constructor Summary

Constructors

Constructor and Description
AuthByAdapterProvider()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
Authentication	authenticate(Authentication authentication) Performs authentication with the same contract as AuthenticationManager.authenticate(Authentication).
java.lang.String	getKey()
void	setKey(java.lang.String key)
void	setMessageSource(org.springframework.context.MessageSource messageSource)
boolean	supports(java.lang.Class authentication) Returns true if this AuthenticationProvider supports the indicated Authentication object.

Methods inherited from class java.lang.Object

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

Field Detail

messages

protected org.springframework.context.support.MessageSourceAccessor messages

Constructor Detail

AuthByAdapterProvider

public AuthByAdapterProvider()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception

authenticate

public Authentication authenticate(Authentication authentication)
                            throws AuthenticationException

Description copied from interface: AuthenticationProvider

Performs authentication with the same contract as AuthenticationManager.authenticate(Authentication).

Specified by:

authenticate in interface AuthenticationProvider

Parameters:

authentication - the authentication request object.

Returns:

a fully authenticated object including credentials. May return null if the AuthenticationProvider is unable to support authentication of the passed Authentication object. In such a case, the next AuthenticationProvider that supports the presented Authentication class will be tried.

Throws:

AuthenticationException - if authentication fails.

getKey

public java.lang.String getKey()

setKey

public void setKey(java.lang.String key)

setMessageSource

public void setMessageSource(org.springframework.context.MessageSource messageSource)

Specified by:

setMessageSource in interface org.springframework.context.MessageSourceAware

supports

public boolean supports(java.lang.Class authentication)

Description copied from interface: AuthenticationProvider

Returns true if this AuthenticationProvider supports the indicated Authentication object.

Returning true does not guarantee an AuthenticationProvider will be able to authenticate the presented instance of the Authentication class. It simply indicates it can support closer evaluation of it. An AuthenticationProvider can still return null from the AuthenticationProvider.authenticate(Authentication) method to indicate another AuthenticationProvider should be tried.

Selection of an AuthenticationProvider capable of performing authentication is conducted at runtime the ProviderManager.

Specified by:

supports in interface AuthenticationProvider

Parameters:

authentication - DOCUMENT ME!

Returns:

true if the implementation can more closely evaluate the Authentication class presented