net.shibboleth.idp.authn.principal

Interface PrincipalEvalPredicate

All Superinterfaces:

com.google.common.base.Predicate<PrincipalSupportingComponent>

public interface PrincipalEvalPredicate
extends com.google.common.base.Predicate<PrincipalSupportingComponent>

A Predicate to evaluate a Principal that represents a requested form of authentication against a set of principals supported by a PrincipalSupportingComponent.

The predicate contains an additional method that makes available the actual Principal object that satisfied the predicate. In concrete terms, this represents the actual authentication method that was performed.

Method Summary

Methods

Modifier and Type	Method and Description
Principal	getMatchingPrincipal() Get the Principal object from the evaluated PrincipalSupportingComponent that actually satisfied the predicate, if any.

Methods inherited from interface com.google.common.base.Predicate

apply, equals

Method Detail

getMatchingPrincipal

@Nullable
Principal getMatchingPrincipal()

Get the Principal object from the evaluated PrincipalSupportingComponent that actually satisfied the predicate, if any.

Returns:

a custom principal, or null