Package net.shibboleth.idp.attribute.filter.matcher.impl

Class AbstractRegexpStringMatcher

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.idp.attribute.filter.matcher.impl.AbstractMatcher

net.shibboleth.idp.attribute.filter.matcher.impl.AbstractRegexpStringMatcher

All Implemented Interfaces:

Matcher, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

Direct Known Subclasses:

AttributeScopeRegexpMatcher, AttributeValueRegexpMatcher

public abstract class AbstractRegexpStringMatcher
extends AbstractMatcher

General Matcher for regexp comparison of strings in Attribute Filters.

Field Summary

Fields

Modifier and Type	Field	Description
private Pattern	pattern	Regular expression to match.

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

MATCHER_FAILS, MATCHES_ALL, MATCHES_NONE

Constructor Summary

Constructors

Constructor	Description
AbstractRegexpStringMatcher()

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
String	getRegularExpression()	Gets the regular expression to match.
protected boolean	regexpCompare(String value)	Matches the given value against the provided regular expression.
void	setPattern(Pattern thePattern)	Sets the Pattern for matching to match.

Methods inherited from class net.shibboleth.idp.attribute.filter.matcher.impl.AbstractMatcher

compareAttributeValue, getLogPrefix, getMatchingValues

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

pattern

@NonnullAfterInit
private Pattern pattern

Regular expression to match.

Constructor Details

AbstractRegexpStringMatcher

public AbstractRegexpStringMatcher()

Method Details

getRegularExpression

@NonnullAfterInit
public String getRegularExpression()

Gets the regular expression to match.

Returns:

the regular expression

setPattern

public void setPattern(@Nonnull
 Pattern thePattern)

Sets the Pattern for matching to match.

Parameters:

thePattern - the pattern to match

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractMatcher

Throws:

ComponentInitializationException

regexpCompare

protected boolean regexpCompare(@Nullable
 String value)

Matches the given value against the provided regular expression.

Parameters:

value - the value to evaluate

Returns:

true if the value matches the given match string, false if not