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

Class EntityAttributesFilter

java.lang.Object

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

All Implemented Interfaces:

MetadataFilter

public class EntityAttributesFilter
extends Object
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.

Constructor Summary

Constructors

Constructor and Description
EntityAttributesFilter() Constructor.

Method Summary

Modifier and Type	Method and Description
XMLObject	filter(XMLObject metadata) Filters the given metadata, perhaps to remove elements that are not wanted.
protected void	filterEntitiesDescriptor(EntitiesDescriptor descriptor) Filters entities descriptor.
protected void	filterEntityDescriptor(EntityDescriptor descriptor) Filters entity descriptor.
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 java.lang.Object

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

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

filter

@Nullable
public XMLObject filter(@Nullable
                                  XMLObject metadata)
                           throws FilterException

Filters the given metadata, perhaps to remove elements that are not wanted.

Specified by:

filter in interface MetadataFilter

Parameters:

metadata - the metadata to be filtered.

Returns:

the filtered XMLObject, which may or may not be the same as the XMLObject instance passed in to the method. Maybe be null, for example if the top-level element was removed by the filter.

Throws:

FilterException - thrown if an error occurs during the filtering process

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