org.jasig.cas.authentication.principal
Class AbstractPersonDirectoryCredentialsToPrincipalResolver

java.lang.Object
  org.jasig.cas.authentication.principal.AbstractPersonDirectoryCredentialsToPrincipalResolver

All Implemented Interfaces:

CredentialsToPrincipalResolver

Direct Known Subclasses:

UsernamePasswordCredentialsToPrincipalResolver

public abstract class AbstractPersonDirectoryCredentialsToPrincipalResolver
extends java.lang.Object
implements CredentialsToPrincipalResolver

Since:

3.1

Version:

$Revision: 1.1 $ $Date: 2005/08/19 18:27:17 $

Author:

Scott Battaglia

Field Summary

protected org.slf4j.Logger

log Log instance.

Constructor Summary

AbstractPersonDirectoryCredentialsToPrincipalResolver()

Method Summary

protected abstract java.lang.String	extractPrincipalId(Credentials credentials) Extracts the id of the user from the provided credentials.
Principal	resolvePrincipal(Credentials credentials) Turn Credentials into a Principal object by analyzing the information provided in the Credentials and constructing a Principal object based on that information or information derived from the Credentials object.
void	setAttributeRepository(org.jasig.services.persondir.IPersonAttributeDao attributeRepository)
void	setReturnNullIfNoAttributes(boolean returnNullIfNoAttributes)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jasig.cas.authentication.principal.CredentialsToPrincipalResolver

supports

Field Detail

log

protected final org.slf4j.Logger log

Log instance.

Constructor Detail

AbstractPersonDirectoryCredentialsToPrincipalResolver

public AbstractPersonDirectoryCredentialsToPrincipalResolver()

Method Detail

resolvePrincipal

public final Principal resolvePrincipal(Credentials credentials)

Description copied from interface: CredentialsToPrincipalResolver

Turn Credentials into a Principal object by analyzing the information provided in the Credentials and constructing a Principal object based on that information or information derived from the Credentials object.

Specified by:

resolvePrincipal in interface CredentialsToPrincipalResolver

Parameters:

credentials - from which to resolve Principal

Returns:

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

extractPrincipalId

protected abstract java.lang.String extractPrincipalId(Credentials credentials)

Extracts the id of the user from the provided credentials.

Parameters:

credentials - the credentials provided by the user.

Returns:

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

setAttributeRepository

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

setReturnNullIfNoAttributes

public void setReturnNullIfNoAttributes(boolean returnNullIfNoAttributes)