org.opensaml.saml.metadata.resolver.filter.impl

Class NameIDFormatFilter

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

org.opensaml.saml.metadata.resolver.filter.impl.NameIDFormatFilter

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, MetadataFilter

public class NameIDFormatFilter
extends net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
implements MetadataFilter

A filter that adds NameIDFormat content to entities in order to drive software behavior based on them. The entities to annotate are identified with a Predicate, and multiple formats can be associated with each.

Field Summary

Fields

Modifier and Type	Field and Description
private Multimap<Predicate<EntityDescriptor>,String>	applyMap Rules for adding formats.
private SAMLObjectBuilder<NameIDFormat>	formatBuilder Builder for NameIDFormat.
private Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
NameIDFormatFilter() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
org.opensaml.core.xml.XMLObject	filter(org.opensaml.core.xml.XMLObject metadata)
protected void	filterEntitiesDescriptor(EntitiesDescriptor descriptor) Filters entities descriptor.
protected void	filterEntityDescriptor(EntityDescriptor descriptor) Filters entity descriptor.
void	setRules(Map<Predicate<EntityDescriptor>,Collection<String>> rules) Set the mappings from Predicate to format collection to apply.

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, doInitialize, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

log

@Nonnull
private final Logger log

Class logger.

applyMap

@Nonnull
@NonnullElements
private Multimap<Predicate<EntityDescriptor>,String> applyMap

Rules for adding formats.

formatBuilder

@Nonnull
private final SAMLObjectBuilder<NameIDFormat> formatBuilder

Builder for NameIDFormat.

Constructor Detail

NameIDFormatFilter

public NameIDFormatFilter()

Constructor.

Method Detail

setRules

public void setRules(@Nonnull@NonnullElements
            Map<Predicate<EntityDescriptor>,Collection<String>> rules)

Set the mappings from Predicate to format collection to apply.

Parameters:

rules - rules to apply

filter

@Nullable
public org.opensaml.core.xml.XMLObject filter(@Nullable
                                              org.opensaml.core.xml.XMLObject metadata)
                                       throws FilterException

Specified by:

filter in interface MetadataFilter

Throws:

FilterException

filterEntityDescriptor

protected void filterEntityDescriptor(@Nonnull
                          EntityDescriptor descriptor)

Filters entity descriptor.

Parameters:

descriptor - entity descriptor to filter

filterEntitiesDescriptor

protected void filterEntitiesDescriptor(@Nonnull
                            EntitiesDescriptor descriptor)

Filters entities descriptor.

Parameters:

descriptor - entities descriptor to filter