net.shibboleth.metadata.dom.saml.mdattr

Class AbstractEntityAttributeMatcher

java.lang.Object

net.shibboleth.metadata.dom.saml.mdattr.AbstractEntityAttributeMatcher

All Implemented Interfaces:

com.google.common.base.Predicate<EntityAttributeFilteringStage.EntityAttributeContext>

Direct Known Subclasses:

AbstractExactValueMatcher, MultiPredicateMatcher

@ThreadSafe
public abstract class AbstractEntityAttributeMatcher
extends Object
implements com.google.common.base.Predicate<EntityAttributeFilteringStage.EntityAttributeContext>

Abstract implementation of Predicate over EntityAttributeFilteringStage.EntityAttributeContext using the template method pattern. The apply(net.shibboleth.metadata.dom.saml.mdattr.EntityAttributeFilteringStage.EntityAttributeContext) method is broken down into matches against the four components of the EntityAttributeFilteringStage.EntityAttributeContext. All four sub-matches must succeed for the Predicate to be true Where an implementation wishes to ignore a component (most commonly, EntityAttributeFilteringStage.EntityAttributeContext.getRegistrationAuthority()) it can simply return true in that template method.

Constructor Summary

Constructors

Constructor and Description
AbstractEntityAttributeMatcher()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	apply(EntityAttributeFilteringStage.EntityAttributeContext input)
protected abstract boolean	matchAttributeName(String inputName) Match the name component of the EntityAttributeFilteringStage.EntityAttributeContext.
protected abstract boolean	matchAttributeNameFormat(String inputNameFormat) Match the name format component of the EntityAttributeFilteringStage.EntityAttributeContext.
protected abstract boolean	matchAttributeValue(String inputValue) Match the attribute value component of the EntityAttributeFilteringStage.EntityAttributeContext.
protected abstract boolean	matchRegistrationAuthority(String inputRegistrationAuthority) Match the registration authority component of the EntityAttributeFilteringStage.EntityAttributeContext.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.base.Predicate

equals

Constructor Detail

AbstractEntityAttributeMatcher

public AbstractEntityAttributeMatcher()

Method Detail

matchAttributeValue

protected abstract boolean matchAttributeValue(@Nonnull
                          String inputValue)

Match the attribute value component of the EntityAttributeFilteringStage.EntityAttributeContext.

Parameters:

inputValue - value component of the input context

Returns:

true if and only if the value component matches

matchAttributeName

protected abstract boolean matchAttributeName(@Nonnull
                         String inputName)

Match the name component of the EntityAttributeFilteringStage.EntityAttributeContext.

Parameters:

inputName - name component of the input context

Returns:

true if and only if the name component matches

matchAttributeNameFormat

protected abstract boolean matchAttributeNameFormat(@Nonnull
                               String inputNameFormat)

Match the name format component of the EntityAttributeFilteringStage.EntityAttributeContext.

Parameters:

inputNameFormat - name format component of the input context

Returns:

true if and only if the name format component matches

matchRegistrationAuthority

protected abstract boolean matchRegistrationAuthority(@Nullable
                                 String inputRegistrationAuthority)

Match the registration authority component of the EntityAttributeFilteringStage.EntityAttributeContext.

Parameters:

inputRegistrationAuthority - registration authority component of the input context

Returns:

true if and only if the registration authority component matches

apply

public boolean apply(@Nonnull
            EntityAttributeFilteringStage.EntityAttributeContext input)

Specified by:

apply in interface com.google.common.base.Predicate<EntityAttributeFilteringStage.EntityAttributeContext>