Package net.shibboleth.idp.attribute.filter.policyrule.saml.impl

Class AbstractEntityAttributeRegexPolicyRule

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.idp.attribute.filter.policyrule.impl.AbstractPolicyRule

net.shibboleth.idp.attribute.filter.policyrule.saml.impl.AbstractEntityAttributePolicyRule

net.shibboleth.idp.attribute.filter.policyrule.saml.impl.AbstractEntityAttributeRegexPolicyRule

All Implemented Interfaces:

PolicyRequirementRule, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

Direct Known Subclasses:

IssuerEntityAttributeRegexPolicyRule, ProxiedRequesterEntityAttributeRegexPolicyRule, RequesterEntityAttributeRegexPolicyRule

public abstract class AbstractEntityAttributeRegexPolicyRule
extends AbstractEntityAttributePolicyRule

Matcher functor that checks entity attribute values via matching against a regular expression.

Nested Class Summary

Nested classes/interfaces inherited from interface net.shibboleth.idp.attribute.filter.PolicyRequirementRule

PolicyRequirementRule.Tristate

Field Summary

Fields

Modifier and Type	Field	Description
private Pattern	valueRegex	The value of the entity attribute the entity must have.

Fields inherited from interface net.shibboleth.idp.attribute.filter.PolicyRequirementRule

MATCHES_ALL, MATCHES_NONE, REQUIREMENT_RULE_FAILS

Constructor Summary

Constructors

Constructor	Description
AbstractEntityAttributeRegexPolicyRule()

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
protected boolean	entityAttributeValueMatches(Set<String> entityAttributeValues)	Checks whether the given entity attribute's values match for particular implementations of this functor.
Pattern	getValueRegex()	Gets the value of the entity attribute the entity must have.
void	setValueRegex(Pattern attributeValueRegex)	Sets the value of the entity attribute the entity must have.

Methods inherited from class net.shibboleth.idp.attribute.filter.policyrule.saml.impl.AbstractEntityAttributePolicyRule

getAttributeName, getEntityMetadata, getIgnoreUnmappedEntityAttributes, getNameFormat, matches, setAttributeName, setIgnoreUnmappedEntityAttributes, setNameFormat

Methods inherited from class net.shibboleth.idp.attribute.filter.policyrule.impl.AbstractPolicyRule

getLogPrefix

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

ensureId, getId, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.shared.component.IdentifiedComponent

getId

Field Details

valueRegex

@NonnullAfterInit
private Pattern valueRegex

The value of the entity attribute the entity must have.

Constructor Details

AbstractEntityAttributeRegexPolicyRule

public AbstractEntityAttributeRegexPolicyRule()

Method Details

getValueRegex

@NonnullAfterInit
public Pattern getValueRegex()

Gets the value of the entity attribute the entity must have.

Returns:

value of the entity attribute the entity must have

setValueRegex

public void setValueRegex(@Nullable
 Pattern attributeValueRegex)

Sets the value of the entity attribute the entity must have.

Parameters:

attributeValueRegex - value of the entity attribute the entity must have

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractEntityAttributePolicyRule

Throws:

ComponentInitializationException

entityAttributeValueMatches

protected boolean entityAttributeValueMatches(@Nonnull
 Set<String> entityAttributeValues)

Checks whether the given entity attribute's values match for particular implementations of this functor.

Specified by:

entityAttributeValueMatches in class AbstractEntityAttributePolicyRule

Parameters:

entityAttributeValues - the entity attribute values

Returns:

true if the value matches, false if not