org.springframework.security.cas.authentication

Class CasAuthenticationProvider

java.lang.Object

org.springframework.security.cas.authentication.CasAuthenticationProvider

All Implemented Interfaces:

AuthenticationProvider

public class CasAuthenticationProvider
extends java.lang.Object
implements AuthenticationProvider

An AuthenticationProvider implementation that integrates with JA-SIG Central Authentication Service (CAS).

This AuthenticationProvider is capable of validating UsernamePasswordAuthenticationToken requests which contain a principal name equal to either CasAuthenticationFilter.CAS_STATEFUL_IDENTIFIER or CasAuthenticationFilter.CAS_STATELESS_IDENTIFIER. It can also validate a previously created CasAuthenticationToken.

Field Summary

Fields

Modifier and Type	Field and Description
protected MessageSourceAccessor	messages

Constructor Summary

Constructors

Constructor and Description
CasAuthenticationProvider()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
Authentication	authenticate(Authentication authentication) Performs authentication with the same contract as AuthenticationManager.authenticate(Authentication) .
protected java.lang.String	getKey()
StatelessTicketCache	getStatelessTicketCache()
protected TicketValidator	getTicketValidator()
protected UserDetails	loadUserByAssertion(Assertion assertion) Template method for retrieving the UserDetails based on the assertion.
void	setAuthenticationUserDetailsService(AuthenticationUserDetailsService<CasAssertionAuthenticationToken> authenticationUserDetailsService)
void	setAuthoritiesMapper(GrantedAuthoritiesMapper authoritiesMapper)
void	setKey(java.lang.String key)
void	setMessageSource(MessageSource messageSource)
void	setServiceProperties(ServiceProperties serviceProperties)
void	setStatelessTicketCache(StatelessTicketCache statelessTicketCache)
void	setTicketValidator(TicketValidator ticketValidator)
void	setUserDetailsService(UserDetailsService userDetailsService)
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 MessageSourceAccessor messages

Constructor Detail

CasAuthenticationProvider

public CasAuthenticationProvider()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

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.

loadUserByAssertion

protected UserDetails loadUserByAssertion(Assertion assertion)

Template method for retrieving the UserDetails based on the assertion. Default is to call configured userDetailsService and pass the username. Deployers can override this method and retrieve the user based on any criteria they desire.

Parameters:

assertion - The CAS Assertion.

Returns:

the UserDetails.

setUserDetailsService

public void setUserDetailsService(UserDetailsService userDetailsService)

setAuthenticationUserDetailsService

public void setAuthenticationUserDetailsService(AuthenticationUserDetailsService<CasAssertionAuthenticationToken> authenticationUserDetailsService)

setServiceProperties

public void setServiceProperties(ServiceProperties serviceProperties)

getKey

protected java.lang.String getKey()

setKey

public void setKey(java.lang.String key)

getStatelessTicketCache

public StatelessTicketCache getStatelessTicketCache()

getTicketValidator

protected TicketValidator getTicketValidator()

setMessageSource

public void setMessageSource(MessageSource messageSource)

setStatelessTicketCache

public void setStatelessTicketCache(StatelessTicketCache statelessTicketCache)

setTicketValidator

public void setTicketValidator(TicketValidator ticketValidator)

setAuthoritiesMapper

public void setAuthoritiesMapper(GrantedAuthoritiesMapper authoritiesMapper)

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

Returns:

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