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

Class NodeProcessingMetadataFilter

java.lang.Object

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

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

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

An implementation of MetadataFilter which applies a MetadataNodeProcessor to each element node in the metadata document tree. The node processors will be applied in the order of List provided by setNodeProcessors(List). The metadata document tree is traversed depth-first.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<MetadataNodeProcessor>	processors The ordered list of metadata node processors.

Constructor Summary

Constructors

Constructor and Description
NodeProcessingMetadataFilter() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doDestroy()
XMLObject	filter(XMLObject metadata) Filters the given metadata, perhaps to remove elements that are not wanted.
java.util.List<MetadataNodeProcessor>	getNodeProcessors() Get the list of metadata node processors.
protected void	processNode(XMLObject node) Process an individual metadata node.
void	setNodeProcessors(java.util.List<MetadataNodeProcessor> newProcessors) Set the list of metadata node processors.

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

destroy, doInitialize, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

processors

@Nonnull
 @NonnullElements
private java.util.List<MetadataNodeProcessor> processors

The ordered list of metadata node processors.

Constructor Detail

NodeProcessingMetadataFilter

public NodeProcessingMetadataFilter()

Constructor.

Method Detail

getNodeProcessors

@Nonnull
 @NonnullElements
 @Live
public java.util.List<MetadataNodeProcessor> getNodeProcessors()

Get the list of metadata node processors.

Returns:

the list of metadata node processors.

setNodeProcessors

public void setNodeProcessors(@Nonnull @NonnullElements
                              java.util.List<MetadataNodeProcessor> newProcessors)

Set the list of metadata node processors.

Parameters:

newProcessors - the new list of processors to set.

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

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

processNode

protected void processNode(XMLObject node)
                    throws FilterException

Process an individual metadata node.

Parameters:

node - the metadata node to process.

Throws:

FilterException - if a fatal error is encountered while processing a node