Package 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:

Component, DestructableComponent, InitializableComponent, MetadataFilter

public class NodeProcessingMetadataFilter
extends 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	Description
private List<MetadataNodeProcessor>	processors	The ordered list of metadata node processors.

Constructor Summary

Constructors

Constructor	Description
NodeProcessingMetadataFilter()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doDestroy()
XMLObject	filter(XMLObject metadata, MetadataFilterContext context)
List<MetadataNodeProcessor>	getNodeProcessors()	Get the list of metadata node processors.
protected void	processNode(XMLObject node)	Process an individual metadata node.
void	setNodeProcessors(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 List<MetadataNodeProcessor> processors

The ordered list of metadata node processors.

Constructor Detail

NodeProcessingMetadataFilter

public NodeProcessingMetadataFilter()

Constructor.

Method Detail

getNodeProcessors

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

Get the list of metadata node processors.

Returns:

the list of metadata node processors

setNodeProcessors

public void setNodeProcessors(@Nonnull @NonnullElements
                              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,
                        @Nonnull
                        MetadataFilterContext context)
                 throws FilterException

Specified by:

filter in interface MetadataFilter

Throws:

FilterException

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class 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