org.apereo.cas.authentication.principal.resolvers

Class ChainingPrincipalResolver

java.lang.Object

org.apereo.cas.authentication.principal.resolvers.ChainingPrincipalResolver

All Implemented Interfaces:

org.apereo.cas.authentication.principal.PrincipalResolver

public class ChainingPrincipalResolver
extends java.lang.Object
implements org.apereo.cas.authentication.principal.PrincipalResolver

Delegates to one or more principal resolves in series to resolve a principal. The input to first configured resolver is the authenticated credential; for every subsequent resolver, the input is a Credential whose ID is the resolved principal ID of the previous resolver.

A common use case for this component is resolving a temporary principal ID from an X.509 credential followed by a search (e.g. LDAP, database) for the final principal based on the temporary ID.

Since:

4.0.0

Constructor Summary

Constructors

Constructor and Description
ChainingPrincipalResolver()

Method Summary

Modifier and Type	Method and Description
org.apereo.services.persondir.IPersonAttributeDao	getAttributeRepository()
org.apereo.cas.authentication.principal.Principal	resolve(org.apereo.cas.authentication.Credential credential, org.apereo.cas.authentication.principal.Principal principal, org.apereo.cas.authentication.AuthenticationHandler handler) Resolves a credential by delegating to each of the configured resolvers in sequence.
void	setChain(java.util.List<org.apereo.cas.authentication.principal.PrincipalResolver> chain) Sets the resolver chain.
void	setChain(org.apereo.cas.authentication.principal.PrincipalResolver... chain)
boolean	supports(org.apereo.cas.authentication.Credential credential) Determines whether the credential is supported by this component by delegating to the first configured resolver in the chain.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apereo.cas.authentication.principal.PrincipalResolver

resolve, resolve

Constructor Detail

ChainingPrincipalResolver

public ChainingPrincipalResolver()

Method Detail

setChain

public void setChain(java.util.List<org.apereo.cas.authentication.principal.PrincipalResolver> chain)

Sets the resolver chain. The resolvers other than the first one MUST be capable of performing resolution on the basis of Credential.getId() alone; PersonDirectoryPrincipalResolver notably meets that requirement.

Parameters:

chain - List of delegate resolvers that are invoked in a chain.

setChain

public void setChain(org.apereo.cas.authentication.principal.PrincipalResolver... chain)

resolve

public org.apereo.cas.authentication.principal.Principal resolve(org.apereo.cas.authentication.Credential credential,
                                                                 org.apereo.cas.authentication.principal.Principal principal,
                                                                 org.apereo.cas.authentication.AuthenticationHandler handler)

Resolves a credential by delegating to each of the configured resolvers in sequence. Note that the final principal is taken from the first resolved principal in the chain, yet attributes are merged.

Specified by:

resolve in interface org.apereo.cas.authentication.principal.PrincipalResolver

Parameters:

credential - Authenticated credential.

principal - Authenticated principal, if any.

Returns:

The principal from the last configured resolver in the chain.

supports

public boolean supports(org.apereo.cas.authentication.Credential credential)

Determines whether the credential is supported by this component by delegating to the first configured resolver in the chain.

Specified by:

supports in interface org.apereo.cas.authentication.principal.PrincipalResolver

Parameters:

credential - The credential to check for support.

Returns:

True if the first configured resolver in the chain supports the credential, false otherwise.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getAttributeRepository

public org.apereo.services.persondir.IPersonAttributeDao getAttributeRepository()

Specified by:

getAttributeRepository in interface org.apereo.cas.authentication.principal.PrincipalResolver