public class

CasAuthenticationProvider

extends Object
implements InitializingBean MessageSourceAware AuthenticationProvider
java.lang.Object
   ↳ org.springframework.security.cas.authentication.CasAuthenticationProvider

Class Overview

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

Summary

Fields
protected MessageSourceAccessor messages
Public Constructors
CasAuthenticationProvider()
Public Methods
void afterPropertiesSet()
Authentication authenticate(Authentication authentication)
Performs authentication with the same contract as authenticate(Authentication).
StatelessTicketCache getStatelessTicketCache()
void setAuthenticationUserDetailsService(AuthenticationUserDetailsService<CasAssertionAuthenticationToken> authenticationUserDetailsService)
void setAuthoritiesMapper(GrantedAuthoritiesMapper authoritiesMapper)
void setKey(String key)
void setMessageSource(MessageSource messageSource)
void setServiceProperties(ServiceProperties serviceProperties)
void setStatelessTicketCache(StatelessTicketCache statelessTicketCache)
void setTicketValidator(TicketValidator ticketValidator)
void setUserDetailsService(UserDetailsService userDetailsService)
boolean supports(Class<?> authentication)
Returns true if this AuthenticationProvider supports the indicated Authentication object.
Protected Methods
String getKey()
TicketValidator getTicketValidator()
UserDetails loadUserByAssertion(Assertion assertion)
Template method for retrieving the UserDetails based on the assertion.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.beans.factory.InitializingBean
From interface org.springframework.context.MessageSourceAware
From interface org.springframework.security.authentication.AuthenticationProvider

Fields

protected MessageSourceAccessor messages

Public Constructors

public CasAuthenticationProvider ()

Public Methods

public void afterPropertiesSet ()

Throws
Exception

public Authentication authenticate (Authentication authentication)

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

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

public StatelessTicketCache getStatelessTicketCache ()

public void setAuthenticationUserDetailsService (AuthenticationUserDetailsService<CasAssertionAuthenticationToken> authenticationUserDetailsService)

public void setAuthoritiesMapper (GrantedAuthoritiesMapper authoritiesMapper)

public void setKey (String key)

public void setMessageSource (MessageSource messageSource)

public void setServiceProperties (ServiceProperties serviceProperties)

public void setStatelessTicketCache (StatelessTicketCache statelessTicketCache)

public void setTicketValidator (TicketValidator ticketValidator)

public void setUserDetailsService (UserDetailsService userDetailsService)

public boolean supports (Class<?> authentication)

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 authenticate(Authentication) method to indicate another AuthenticationProvider should be tried.

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

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

Protected Methods

protected String getKey ()

protected TicketValidator getTicketValidator ()

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.