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

Class EntityAttributesFilter

java.lang.Object

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

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

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 EntityAttributesFilter
extends net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
implements MetadataFilter

A filter that adds EntityAttributes extension content to entities in order to drive software behavior based on them.

The entities to annotate are identified with a Predicate, and multiple attributes can be associated with each.

As of 3.4.0, another predicate can be set to validate pre-existing extension content to better protect use cases of this component.

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.common.collect.Multimap<com.google.common.base.Predicate<EntityDescriptor>,Attribute>	applyMap Rules for adding attributes.
private com.google.common.base.Predicate<Attribute>	attributeFilter A condition to apply to pre-existing tags to determine their legitimacy.
private SAMLObjectBuilder<EntityAttributes>	entityAttributesBuilder Builder for EntityAttributes.
private SAMLObjectBuilder<Extensions>	extBuilder Builder for Extensions.
private Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
EntityAttributesFilter() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
private void	applyFilter(EntityDescriptor descriptor) Apply whitelist to metadata on input.
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	setAttributeFilter(com.google.common.base.Predicate<Attribute> condition) Set a condition to apply to any pre-existing extension attributes, such that failure causes their removal.
void	setRules(Map<com.google.common.base.Predicate<EntityDescriptor>,Collection<Attribute>> rules) Set the mappings from Predicate to Attribute 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 com.google.common.collect.Multimap<com.google.common.base.Predicate<EntityDescriptor>,Attribute> applyMap

Rules for adding attributes.

attributeFilter

@Nullable
private com.google.common.base.Predicate<Attribute> attributeFilter

A condition to apply to pre-existing tags to determine their legitimacy.

extBuilder

@Nonnull
private final SAMLObjectBuilder<Extensions> extBuilder

Builder for Extensions.

entityAttributesBuilder

@Nonnull
private final SAMLObjectBuilder<EntityAttributes> entityAttributesBuilder

Builder for EntityAttributes.

Constructor Detail

EntityAttributesFilter

public EntityAttributesFilter()

Constructor.

Method Detail

setRules

public void setRules(@Nonnull@NonnullElements
            Map<com.google.common.base.Predicate<EntityDescriptor>,Collection<Attribute>> rules)

Set the mappings from Predicate to Attribute collection to apply.

Parameters:

rules - rules to apply

setAttributeFilter

public void setAttributeFilter(@Nullable
                      com.google.common.base.Predicate<Attribute> condition)

Set a condition to apply to any pre-existing extension attributes, such that failure causes their removal.

If not set, then anything is allowed.

Parameters:

condition - condition to apply

Since:

3.4.0

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

applyFilter

@Nullable
private void applyFilter(@Nonnull
                        EntityDescriptor descriptor)

Apply whitelist to metadata on input.

Parameters:

descriptor - input to evaluate