InexactPrincipalEvalPredicateFactory (Shibboleth IdP :: Authentication Implementation 4.2.1 API)

java.lang.Object
- net.shibboleth.idp.authn.principal.impl.InexactPrincipalEvalPredicateFactory

All Implemented Interfaces:

PrincipalEvalPredicateFactory
```
public class InexactPrincipalEvalPredicateFactory
extends Object
implements PrincipalEvalPredicateFactory
```
PrincipalEvalPredicateFactory that implements inexact matching of principals, based on an arbitrary set of "matches" configured at runtime.
Matching is based on string equality between two principals via the Principal.getName() method.

This component implements essentially arbitrary comparison rules by being unaware of the actual semantics implied by a match. For example, a given instance of the component could be configured with rules for matching principals that are "at least as good as" or "better than" a candidate value, but the component doesn't know or care about that meaning.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

private class InexactPrincipalEvalPredicateFactory.InexactMatchPredicate
Implementation of an inexact-matching predicate.

Field Summary

Fields
Modifier and Type Field Description

private HashMultimap<String,String> matchingRules
Rules for matching.

Constructor Summary

Constructors
Constructor Description

InexactPrincipalEvalPredicateFactory()
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`(package private) Multimap<String,String>`	`getMatchingRules()`	Get the matching rules to apply.
`PrincipalEvalPredicate`	`getPredicate(Principal candidate)`
`void`	`setMatchingRules(Map<String,Collection<String>> rules)`	Set the matching rules to apply.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

matchingRules

@Nonnull
@NonnullElements
private final HashMultimap<String,String> matchingRules

Rules for matching.

Constructor Detail
- InexactPrincipalEvalPredicateFactory
```
InexactPrincipalEvalPredicateFactory()
```
  Constructor.

Method Detail

getMatchingRules
```
@Nonnull
@NonnullElements
@Live
Multimap<String,String> getMatchingRules()
```
Get the matching rules to apply.

Returns:

a mutable multimap of the matching rules to apply

setMatchingRules

public void setMatchingRules(@Nonnull @NonnullElements
                             Map<String,Collection<String>> rules)

Set the matching rules to apply.

The input is a map of sets for bean compatibility.

Parameters:: rules - matching rules

getPredicate

@Nonnull
public PrincipalEvalPredicate getPredicate(@Nonnull
                                           Principal candidate)

Specified by:: getPredicate in interface PrincipalEvalPredicateFactory