org.jasig.cas.authentication.principal

Interface PrincipalResolver

All Known Implementing Classes:

BasicPrincipalResolver, ChainingPrincipalResolver, PersonDirectoryPrincipalResolver

public interface PrincipalResolver

Resolves a Principal from a Credential using an arbitrary strategy. Since a Principal requires an identifier at a minimum, the simplest strategy to produce a principal is to simply copy Credential.getId() onto Principal.getId(). Resolvers commonly query one or more data sources to obtain attributes such as affiliations, group membership, display name, and email. The data source(s) may also provide an alternate identifier mapped by the credential identifier.

Since:

4.0

Author:

Scott Battaglia, Marvin S. Addison

See Also:

Principal, Credential

Method Summary

Methods

Modifier and Type	Method and Description
Principal	resolve(Credential credential) Resolves a principal from the given credential using an arbitrary strategy.
boolean	supports(Credential credential) Determines whether this instance supports principal resolution from the given credential.

Method Detail

resolve

Principal resolve(Credential credential)

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

Parameters:

credential - Source credential.

Returns:

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

supports

boolean supports(Credential credential)

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

Parameters:

credential - The credential to check for support.

Returns:

True if credential is supported, false otherwise.