net.shibboleth.metadata.dom

Class AbstractNamespacesStrippingStage

java.lang.Object

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

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

net.shibboleth.metadata.pipeline.BaseStage<Element>

net.shibboleth.metadata.dom.AbstractNamespacesStrippingStage

All Implemented Interfaces:

Stage<Element>, net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent

Direct Known Subclasses:

NamespacesStrippingStage, NamespaceStrippingStage

@ThreadSafe
public abstract class AbstractNamespacesStrippingStage
extends BaseStage<Element>

An abstract stage which removes all evidence of given XML namespaces from each metadata item. Determining the affected namespaces is delegated to subclasses. Elements, attributes and namespace prefix definitions associated with a given namespace will be removed or retained as determined by the removingNamespace(java.lang.String) function. Attributes without an explicit namespace prefix will never be removed.

Field Summary

Fields

Modifier and Type	Field and Description
private Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
AbstractNamespacesStrippingStage()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doExecute(Collection<Item<Element>> items) Performs the stage processing on the given Item collection.
private void	processAttributes(Element element) Process the attributes on an element.
private void	processElement(Element element, int depth) Process an individual DOM element.
private void	processItem(Item<Element> item) Processes the given Item.
protected abstract boolean	removingNamespace(String namespace) Determine whether a particular namespace should be stripped.

Methods inherited from class net.shibboleth.metadata.pipeline.BaseStage

execute, getCollectionPredicate, setCollectionPredicate

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

setId

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

doInitialize, getId

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

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.utilities.java.support.component.DestructableComponent

destroy, isDestroyed

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Detail

log

private final Logger log

Class logger.

Constructor Detail

AbstractNamespacesStrippingStage

public AbstractNamespacesStrippingStage()

Method Detail

removingNamespace

protected abstract boolean removingNamespace(String namespace)

Determine whether a particular namespace should be stripped.

Parameters:

namespace - potentially stripped namespace

Returns:

true if this namespace should be stripped

processItem

private void processItem(@Nonnull
               Item<Element> item)

Processes the given Item.

Parameters:

item - Item to process.

processAttributes

private void processAttributes(@Nonnull
                     Element element)

Process the attributes on an element. Assumes that the element itself does not reside in the target namespace, and that all child elements have already been processed.

Parameters:

element - the Element to process

processElement

private void processElement(@Nonnull
                  Element element,
                  int depth)

Process an individual DOM element.

Parameters:

element - element to process

depth - processing depth, starting with 0 for the document element.

doExecute

protected void doExecute(@Nonnull@NonnullElements
             Collection<Item<Element>> items)
                  throws StageProcessingException

Description copied from class: BaseStage

Performs the stage processing on the given Item collection.

The stage is guaranteed to be have been initialized and not destroyed when this is invoked.

Specified by:

doExecute in class BaseStage<Element>

Parameters:

items - collection to be processed

Throws:

StageProcessingException - thrown if there is an unrecoverable problem when processing the stage