org.acegisecurity.providers.cas

Class CasAuthenticationProvider

java.lang.Object

org.acegisecurity.providers.cas.CasAuthenticationProvider

All Implemented Interfaces:

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

public class CasAuthenticationProvider
extends Object
implements AuthenticationProvider, org.springframework.beans.factory.InitializingBean, org.springframework.context.MessageSourceAware

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 CasProcessingFilter.CAS_STATEFUL_IDENTIFIER or CasProcessingFilter.CAS_STATELESS_IDENTIFIER. It can also validate a previously created CasAuthenticationToken.

Version:

$Id: CasAuthenticationProvider.java 2634 2008-02-15 14:03:52Z luke_t $

Author:

Ben Alex

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.support.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).
CasAuthoritiesPopulator	getCasAuthoritiesPopulator()
CasProxyDecider	getCasProxyDecider()
String	getKey()
StatelessTicketCache	getStatelessTicketCache()
TicketValidator	getTicketValidator()
void	setCasAuthoritiesPopulator(CasAuthoritiesPopulator casAuthoritiesPopulator)
void	setCasProxyDecider(CasProxyDecider casProxyDecider)
void	setKey(String key)
void	setMessageSource(org.springframework.context.MessageSource messageSource)
void	setStatelessTicketCache(StatelessTicketCache statelessTicketCache)
void	setTicketValidator(TicketValidator ticketValidator)
boolean	supports(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

CasAuthenticationProvider

public CasAuthenticationProvider()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

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

Throws:

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.

getCasAuthoritiesPopulator

public CasAuthoritiesPopulator getCasAuthoritiesPopulator()

getCasProxyDecider

public CasProxyDecider getCasProxyDecider()

getKey

public String getKey()

getStatelessTicketCache

public StatelessTicketCache getStatelessTicketCache()

getTicketValidator

public TicketValidator getTicketValidator()

setCasAuthoritiesPopulator

public void setCasAuthoritiesPopulator(CasAuthoritiesPopulator casAuthoritiesPopulator)

setCasProxyDecider

public void setCasProxyDecider(CasProxyDecider casProxyDecider)

setKey

public void setKey(String key)

setMessageSource

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

Specified by:

setMessageSource in interface org.springframework.context.MessageSourceAware

setStatelessTicketCache

public void setStatelessTicketCache(StatelessTicketCache statelessTicketCache)

setTicketValidator

public void setTicketValidator(TicketValidator ticketValidator)

supports

public boolean supports(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