# Uses of Interface
net.shibboleth.idp.attribute.filter.PolicyRequirementRule

Packages that use PolicyRequirementRule
Package
Description
net.shibboleth.idp.attribute.filter
This package contains a filtering engine for a collection of `IdPAttribute`s.
net.shibboleth.idp.attribute.filter.policyrule.filtercontext.impl
Implementation of the filter context matchers Matchers.
net.shibboleth.idp.attribute.filter.policyrule.impl
Classes which implement`PolicyRequirementRule`.
net.shibboleth.idp.attribute.filter.policyrule.logic.impl
Implementation of the logical Policy Rules.
net.shibboleth.idp.attribute.filter.policyrule.saml.impl
This is where the attribute policy rules that understand SAML live.
net.shibboleth.idp.attribute.filter.testing
Testing utility classes.

## Uses of PolicyRequirementRule in net.shibboleth.idp.attribute.filter

Classes in net.shibboleth.idp.attribute.filter that implement PolicyRequirementRule
Modifier and Type
Class
Description
`final class`
`PolicyFromMatcher`
Bridging class to go from a `Matcher` to a `PolicyRequirementRule`.
`final class`
`PolicyFromMatcherId`
Bridging class to go from a `Matcher` to a `PolicyRequirementRule`.
Fields in net.shibboleth.idp.attribute.filter declared as PolicyRequirementRule
Modifier and Type
Field
Description
`static final PolicyRequirementRule`
PolicyRequirementRule.`MATCHES_ALL`
A `PolicyRequirementRule` that returns true matched.
`static final PolicyRequirementRule`
PolicyRequirementRule.`MATCHES_NONE`
A `PolicyRequirementRule` that returns false as matched.
`static final PolicyRequirementRule`
PolicyRequirementRule.`REQUIREMENT_RULE_FAILS`
A `PolicyRequirementRule` that returns failed.
`private final PolicyRequirementRule`
AttributeFilterPolicy.`rule`
Criterion that must be met for this policy to be active for a given request.
`private final PolicyRequirementRule`
MatcherFromPolicy.`rule`
The rule we are shadowing.
Methods in net.shibboleth.idp.attribute.filter that return PolicyRequirementRule
Modifier and Type
Method
Description
`PolicyRequirementRule`
AttributeFilterPolicy.`getPolicyRequirementRule()`
Gets the MatchFunctor that must be met for this policy to be active for a given request.
`PolicyRequirementRule`
MatcherFromPolicy.`getPolicyRequirementRule()`
Testing support.
Constructors in net.shibboleth.idp.attribute.filter with parameters of type PolicyRequirementRule
Modifier
Constructor
Description
``
`AttributeFilterPolicy(String policyId, PolicyRequirementRule requirementRule, Collection<AttributeRule> attributeRules)`
Constructor.
``
`MatcherFromPolicy(PolicyRequirementRule theRule)`
Constructor.

## Uses of PolicyRequirementRule in net.shibboleth.idp.attribute.filter.policyrule.filtercontext.impl

Classes in net.shibboleth.idp.attribute.filter.policyrule.filtercontext.impl that implement PolicyRequirementRule
Modifier and Type
Class
Description
`class`
`AttributeIssuerPolicyRule`
Compare the attribute issuer's entity ID for this resolution with the provided name.
`class`
`AttributeIssuerRegexpPolicyRule`
Compare the attribute issuer's entity ID for this resolution with the provided regexp.
`class`
`AttributeRequesterPolicyRule`
Compare the attribute requester's entity ID for this resolution with the provided name.
`class`
`AttributeRequesterRegexpPolicyRule`
Compare the attribute requester's entity ID for this resolution with the provided regexp.
`class`
`NumOfAttributeValuesPolicyRule`
A policy rule that checks if the given attribute has more than the minimum number of values but less than the maximum.
`class`
`PredicatePolicyRule`
Call out to an externally define predicate.
`class`
`PrincipalNamePolicyRule`
Compare the principal name for this resolution with the provided string.
`class`
`PrincipalNameRegexpPolicyRule`
Compare the principal name for this resolution with the provided regexp.
`class`
`ProfilePolicyRule`
Compare the profile identifier for this resolution with the provided string.
`class`
`ProxiedRequesterPolicyRule`
Compare a proxied attribute requester's entity ID for this resolution with the provided name.
`class`
`ProxiedRequesterRegexpPolicyRule`
Compare a proxied attribute requester's entity ID for this resolution with the provided regexp.

## Uses of PolicyRequirementRule in net.shibboleth.idp.attribute.filter.policyrule.impl

Classes in net.shibboleth.idp.attribute.filter.policyrule.impl that implement PolicyRequirementRule
Modifier and Type
Class
Description
`class`
`AbstractPolicyRule`
Basis of all implementations of `PolicyRequirementRule` which do some sort of comparison.
`class`
`AbstractRegexpPolicyRule`
General `Matcher` for regexp comparison of strings in Attribute Filters.
`class`
`AbstractStringPolicyRule`
General `PolicyRequirementRule` for `String` comparison of strings in Attribute Filters.
`class`
`DirectionPolicyRule`
General `PolicyRequirementRule` for testing the filtering direction.
`class`
`ScriptedPolicyRule`
A `PolicyRequirementRule` that delegates to a JSR-223 script for its actual processing.

## Uses of PolicyRequirementRule in net.shibboleth.idp.attribute.filter.policyrule.logic.impl

Classes in net.shibboleth.idp.attribute.filter.policyrule.logic.impl that implement PolicyRequirementRule
Modifier and Type
Class
Description
`class`
`AbstractComposedPolicyRule`
Base class for `PolicyRequirementRule` implementations that are compositions of other `PolicyRequirementRule`s.
`class`
`AndPolicyRule`
`PolicyRequirementRule` that implements the conjunction of Policy Rules.
`final class`
`NotPolicyRule`
`PolicyRequirementRule` that implements the negation of a matcher.
`class`
`OrPolicyRule`
`PolicyRequirementRule` that implements the disjunction of Policy Rules.
Fields in net.shibboleth.idp.attribute.filter.policyrule.logic.impl declared as PolicyRequirementRule
Modifier and Type
Field
Description
`private PolicyRequirementRule`
NotPolicyRule.`negatedRule`
The matcher we are negating.
Fields in net.shibboleth.idp.attribute.filter.policyrule.logic.impl with type parameters of type PolicyRequirementRule
Modifier and Type
Field
Description
`private List<PolicyRequirementRule>`
AbstractComposedPolicyRule.`rules`
The composed matchers.
Methods in net.shibboleth.idp.attribute.filter.policyrule.logic.impl that return PolicyRequirementRule
Modifier and Type
Method
Description
`PolicyRequirementRule`
NotPolicyRule.`getNegatedRule()`
Get the matcher that is being negated.
Methods in net.shibboleth.idp.attribute.filter.policyrule.logic.impl that return types with arguments of type PolicyRequirementRule
Modifier and Type
Method
Description
`List<PolicyRequirementRule>`
AbstractComposedPolicyRule.`getComposedRules()`
Get the composed matchers.
Methods in net.shibboleth.idp.attribute.filter.policyrule.logic.impl with parameters of type PolicyRequirementRule
Modifier and Type
Method
Description
`void`
NotPolicyRule.`setNegation(PolicyRequirementRule rule)`
Set the attribute value matcher to be negated.
Method parameters in net.shibboleth.idp.attribute.filter.policyrule.logic.impl with type arguments of type PolicyRequirementRule
Modifier and Type
Method
Description
`void`
AbstractComposedPolicyRule.`setSubsidiaries(List<PolicyRequirementRule> theRules)`
Set the rules to be composed.

## Uses of PolicyRequirementRule in net.shibboleth.idp.attribute.filter.policyrule.saml.impl

Classes in net.shibboleth.idp.attribute.filter.policyrule.saml.impl that implement PolicyRequirementRule
Modifier and Type
Class
Description
`class`
`AbstractEntityAttributeExactPolicyRule`
Matcher that checks, via an exact match, for an entity attribute with a given value.
`class`
`AbstractEntityAttributePolicyRule`
Base class for matchers that check whether a particular entity attribute is present and contains a given value.
`class`
`AbstractEntityAttributeRegexPolicyRule`
Matcher functor that checks entity attribute values via matching against a regular expression.
`class`
`AbstractEntityGroupPolicyRule`
A matcher that evaluates to true if an entity's metadata matches the provided entity group name, or a valid metadata-sourced affiliation of entities.
`class`
`AbstractNameIDFormatExactPolicyRule`
Checks if the attribute issuer supports the required NameID format.
`class`
`AbstractProtocolSupportPolicyRule`
Base class for Policy Rules that check whether a particular protocol is available for the supplied role.
`class`
`AbstractRegistrationAuthorityPolicyRule`
Base class for rules operating on the RPI extension in metadata.
`class`
`IssuerEntityAttributeExactPolicyRule`
Policy Rule that checks, via an exact match, if the attribute issuer contains an entity attribute with a given value.
`class`
`IssuerEntityAttributeRegexPolicyRule`
Matcher that checks, via regex, if the attribute issuer contains an entity attribute with a given value.
`class`
`IssuerInEntityGroupPolicyRule`
A matcher that evaluates to true if attribute issuer's metadata matches the provided entity group name, or a valid metadata-sourced affiliation of entities.
`class`
`IssuerNameIDFormatExactPolicyRule`
Checks if the attribute issuer supports the required NameID format.
`class`
`IssuerProtocolSupportPolicyRule`
Concrete implementation of a Policy Rule to match against the Issuer's role's supported protocols.
`class`
`IssuerRegistrationAuthorityPolicyRule`
Rule based on RPI extension in attribute issuer's metadata.
`class`
`ProxiedRequesterEntityAttributeExactPolicyRule`
Matcher that checks, via an exact match, if the proxied requester's metadata contains an entity attribute with a given value.
`class`
`ProxiedRequesterEntityAttributeRegexPolicyRule`
Matcher that checks, via regex, if the proxied attribute requester's metadata contains an entity attribute with a given value.
`class`
`ProxiedRequesterInEntityGroupPolicyRule`
A matcher that evaluates to true if proxied requester's metadata matches the provided entity group name, or a valid metadata-sourced affiliation of entities.
`class`
`ProxiedRequesterProtocolSupportPolicyRule`
Concrete implementation of a Policy Rule to match against the Proxied Requestor's role's supported protocols.
`class`
`ProxiedRequesterRegistrationAuthorityPolicyRule`
Rule based on RPI extension in proxied requester's metadata.
`class`
`RequesterEntityAttributeExactPolicyRule`
Matcher that checks, via an exact match, if the attribute requester's metadata contains an entity attribute with a given value.
`class`
`RequesterEntityAttributeRegexPolicyRule`
Matcher that checks, via regex, if the attribute requester's metadata contains an entity attribute with a given value.
`class`
`RequesterInEntityGroupPolicyRule`
A matcher that evaluates to true if attribute requester's metadata matches the provided entity group name, or a valid metadata-sourced affiliation of entities.
`class`
`RequesterNameIDFormatExactPolicyRule`
Checks if the attribute requester supports the required NameID format.
`class`
`RequesterProtocolSupportPolicyRule`
Concrete implementation of a Policy Rule to match against the Requestor's role's supported protocols.
`class`
`RequesterRegistrationAuthorityPolicyRule`
Rule based on RPI extension in attribute requester's metadata.

## Uses of PolicyRequirementRule in net.shibboleth.idp.attribute.filter.testing

Classes in net.shibboleth.idp.attribute.filter.testing that implement PolicyRequirementRule
Modifier and Type
Class
Description
`class`
`MockPolicyRequirementRule`
A simple, mock implementation of `Matcher`.