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

Class PredicateFilter

java.lang.Object

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

All Implemented Interfaces:

MetadataFilter

public class PredicateFilter
extends Object
implements MetadataFilter

A filter that removes any EntityDescriptor that does or does not match a Predicate, thus a whitelist or blacklist.

If an EntitiesDescriptor does not contain any children after filtering it may, optionally, be removed as well. If the root element of the metadata document is an @link EntitiesDescriptor}, it will never be removed, regardless of of whether it still has children.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PredicateFilter.Direction Whether matching means to include or exclude an entity.

Constructor Summary

Constructors

Constructor and Description
PredicateFilter(PredicateFilter.Direction dir, com.google.common.base.Predicate<EntityDescriptor> theCondition) 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.
com.google.common.base.Predicate<EntityDescriptor>	getCondition() Get the predicate to be applied.
PredicateFilter.Direction	getDirection() Get the direction of filtering.
boolean	getRemoveEmptyEntitiesDescriptors() Get whether to remove an entities descriptor if it does not contain any entity descriptor or entities descriptors.
void	setRemoveEmptyEntitiesDescriptors(boolean remove) Set whether to remove an entities descriptor if it does not contain any entity descriptor or entities descriptors.

Methods inherited from class java.lang.Object

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

Constructor Detail

PredicateFilter

public PredicateFilter(@Nonnull
                       PredicateFilter.Direction dir,
                       @Nonnull
                       com.google.common.base.Predicate<EntityDescriptor> theCondition)

Constructor.

Parameters:

dir - whether to whitelist or blacklist

theCondition - the predicate to apply to determine inclusion or exclusion

Method Detail

getDirection

@Nonnull
public PredicateFilter.Direction getDirection()

Get the direction of filtering.

Returns:

filtering direction

getCondition

@Nonnull
public com.google.common.base.Predicate<EntityDescriptor> getCondition()

Get the predicate to be applied.

Returns:

the predicate to be applied

getRemoveEmptyEntitiesDescriptors

public boolean getRemoveEmptyEntitiesDescriptors()

Get whether to remove an entities descriptor if it does not contain any entity descriptor or entities descriptors.

Returns:

whether to remove an entities descriptor if it does not contain any entity descriptor or entities descriptors

setRemoveEmptyEntitiesDescriptors

public void setRemoveEmptyEntitiesDescriptors(boolean remove)

Set whether to remove an entities descriptor if it does not contain any entity descriptor or entities descriptors.

Parameters:

remove - whether to remove an entities descriptor if it does not contain any entity descriptor or entities descriptors

filter

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

filterEntitiesDescriptor

protected void filterEntitiesDescriptor(@Nonnull
                                        EntitiesDescriptor descriptor)

Filters entities descriptor.

Parameters:

descriptor - entities descriptor to filter