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

Class NotMatcher

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.idp.attribute.filter.matcher.logic.impl.NotMatcher

All Implemented Interfaces:

Matcher, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

@ThreadSafe
public final class NotMatcher
extends AbstractIdentifiableInitializableComponent
implements Matcher

Matcher that implements the negation of a matcher.

A given attribute value is considered to have matched if it is not returned by the composed Matcher. The predicate is the logical NOT of the composed Matcher. If the matcher fails then failure is returned.

Field Summary

Fields

Modifier and Type	Field	Description
private Matcher	negatedMatcher	The matcher we are negating.

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

MATCHER_FAILS, MATCHES_ALL, MATCHES_NONE

Constructor Summary

Constructors

Constructor	Description
NotMatcher()

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
Set<IdPAttributeValue>	getMatchingValues(IdPAttribute attribute, AttributeFilterContext filterContext)	A given attribute value is considered to have matched if it is not returned by the composed Matcher.
Matcher	getNegatedMatcher()	Get the matcher that is being negated.
void	setNegation(Matcher valueMatcher)	Constructor.
String	toString()

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, wait, wait, wait

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

getId

Field Details

negatedMatcher

@NonnullAfterInit
private Matcher negatedMatcher

The matcher we are negating.

Constructor Details

NotMatcher

public NotMatcher()

Method Details

setNegation

public void setNegation(@Nonnull
 Matcher valueMatcher)

Constructor.

Parameters:

valueMatcher - attribute value matcher to be negated

getNegatedMatcher

@Nonnull
public Matcher getNegatedMatcher()

Get the matcher that is being negated.

Returns:

matcher that is being negated

getMatchingValues

@Nullable
@Unmodifiable
@NotLive
public Set<IdPAttributeValue> getMatchingValues(@Nonnull
 IdPAttribute attribute,
 @Nonnull
 AttributeFilterContext filterContext)

A given attribute value is considered to have matched if it is not returned by the composed Matcher. Return those IdPAttributeValues which match this rule, or null if the matcher failed.

Specified by:

getMatchingValues in interface Matcher

Parameters:

attribute - the attribute under question.

filterContext - the filter context

Returns:

The result of this rule. Null if we failed.

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractIdentifiedInitializableComponent

Throws:

ComponentInitializationException

toString

public String toString()

Overrides:

toString in class Object