org.jasig.cas.authentication.principal

Class PersonDirectoryPrincipalResolver

java.lang.Object

org.jasig.cas.authentication.principal.PersonDirectoryPrincipalResolver

All Implemented Interfaces:

PrincipalResolver

public class PersonDirectoryPrincipalResolver
extends Object
implements PrincipalResolver

Resolves principals by querying a data source using the Jasig Person Directory API. The Principal.getAttributes() are populated by the results of the query and the principal ID may optionally be set by proving an attribute whose first non-null value is used; otherwise the credential ID is used for the principal ID.

Since:

4.0

Author:

Marvin S. Addison

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger Log instance.

Constructor Summary

Constructors

Constructor and Description
PersonDirectoryPrincipalResolver()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	extractPrincipalId(Credential credential) Extracts the id of the user from the provided credential.
Principal	resolve(Credential credential) Resolves a principal from the given credential using an arbitrary strategy.
void	setAttributeRepository(org.jasig.services.persondir.IPersonAttributeDao attributeRepository)
void	setPrincipalAttributeName(String attribute) Sets the name of the attribute whose first non-null value should be used for the principal ID.
void	setReturnNullIfNoAttributes(boolean returnNullIfNoAttributes)
boolean	supports(Credential credential) Determines whether this instance supports principal resolution from the given credential.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Log instance.

Constructor Detail

PersonDirectoryPrincipalResolver

public PersonDirectoryPrincipalResolver()

Method Detail

supports

public boolean supports(Credential credential)

Description copied from interface: PrincipalResolver

Determines whether this instance supports principal resolution from the given credential. This method SHOULD be called prior to PrincipalResolver.resolve(org.jasig.cas.authentication.Credential).

Specified by:

supports in interface PrincipalResolver

Parameters:

credential - The credential to check for support.

Returns:

True if credential is supported, false otherwise.

resolve

public final Principal resolve(Credential credential)

Description copied from interface: PrincipalResolver

Resolves a principal from the given credential using an arbitrary strategy.

Specified by:

resolve in interface PrincipalResolver

Parameters:

credential - Source credential.

Returns:

Resolved principal, or null if the principal could not be resolved.

setAttributeRepository

public final void setAttributeRepository(org.jasig.services.persondir.IPersonAttributeDao attributeRepository)

setReturnNullIfNoAttributes

public void setReturnNullIfNoAttributes(boolean returnNullIfNoAttributes)

setPrincipalAttributeName

public void setPrincipalAttributeName(String attribute)

Sets the name of the attribute whose first non-null value should be used for the principal ID.

Parameters:

attribute - Name of attribute containing principal ID.

extractPrincipalId

protected String extractPrincipalId(Credential credential)

Extracts the id of the user from the provided credential. This method should be overridded by subclasses to achieve more sophisticated strategies for producing a principal ID from a credential.

Parameters:

credential - the credential provided by the user.

Returns:

the username, or null if it could not be resolved.