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

Class AbstractMatchesShibMDScopeMatcher

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.idp.attribute.filter.matcher.saml.impl.AbstractMatchesShibMDScopeMatcher

All Implemented Interfaces:

Matcher, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

Direct Known Subclasses:

AttributeScopeMatchesShibMDScope, AttributeValueMatchesShibMDScope

public abstract class AbstractMatchesShibMDScopeMatcher
extends AbstractIdentifiableInitializableComponent
implements Matcher

Base class for filters which rely on the issuer's <shibmd:scope> extensions.

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.slf4j.Logger	LOG	Class logger.
private String	logPrefix	The String used to prefix log message.

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

MATCHER_FAILS, MATCHES_ALL, MATCHES_NONE

Constructor Summary

Constructors

Constructor	Description
AbstractMatchesShibMDScopeMatcher()

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
protected abstract String	getCompareString(IdPAttributeValue value)	Return the string we want to compare with for the provided value.
protected String	getLogPrefix()	Return a string which is to be prepended to all log messages.
Set<IdPAttributeValue>	getMatchingValues(IdPAttribute attribute, AttributeFilterContext filterContext)	Return those IdPAttributeValues which match this rule, or null if the matcher failed.

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

LOG

@Nonnull
private static final org.slf4j.Logger LOG

Class logger.

logPrefix

@Nullable
private String logPrefix

The String used to prefix log message.

Constructor Details

AbstractMatchesShibMDScopeMatcher

public AbstractMatchesShibMDScopeMatcher()

Method Details

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractIdentifiedInitializableComponent

Throws:

ComponentInitializationException

getMatchingValues

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

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.

getCompareString

@Nullable
@NotEmpty
protected abstract String getCompareString(@Nonnull
 IdPAttributeValue value)

Return the string we want to compare with for the provided value.

Parameters:

value - the vaue we are interested.

Returns:

the string, or null if empty of not relevant.

getLogPrefix

@Nonnull
protected String getLogPrefix()

Return a string which is to be prepended to all log messages.

Returns:

"Attribute Filter '<filterID>' :"