net.shibboleth.metadata.dom

Class AbstractDOMTraversalStage

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.AbstractDOMTraversalStage

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:

AbstractDOMValidationStage, AbstractElementVisitingStage, CRDetectionStage

@ThreadSafe
public abstract class AbstractDOMTraversalStage
extends BaseStage<Element>

A DOM traversal class using the template method pattern.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractDOMTraversalStage.TraversalContext Context for a particular traversal.

Constructor Summary

Constructors

Constructor and Description
AbstractDOMTraversalStage()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addError(Item<Element> item, Element element, String error) Add an ErrorStatus to the given item, in respect of the given Element.
protected Element	ancestorEntity(Element element) Returns the Element representing the EntityDescriptor which is the closest-containing ancestor of the given element.
protected abstract boolean	applicable(Element element) Indicates whether the visitor should be applied to a particular Element.
protected void	doExecute(Collection<Item<Element>> itemCollection) Performs the stage processing on the given Item collection.
private void	traverse(Element element, AbstractDOMTraversalStage.TraversalContext context) Depth-first traversal of the DOM tree rooted in an element, applying the visitor when appropriate.
protected abstract void	visit(Element element, AbstractDOMTraversalStage.TraversalContext context) Visit a particular Element.

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

Constructor Detail

AbstractDOMTraversalStage

public AbstractDOMTraversalStage()

Method Detail

applicable

protected abstract boolean applicable(@Nonnull
                 Element element)

Indicates whether the visitor should be applied to a particular Element.

Parameters:

element - Element to which we may wish to apply the visitor

Returns:

true if the visitor should be applied to this Element.

visit

protected abstract void visit(@Nonnull
         Element element,
         @Nonnull
         AbstractDOMTraversalStage.TraversalContext context)
                       throws StageProcessingException

Visit a particular Element.

Parameters:

element - the Element to visit

context - the traversal context

Throws:

StageProcessingException - if errors occur during processing

traverse

private void traverse(@Nonnull
            Element element,
            @Nonnull
            AbstractDOMTraversalStage.TraversalContext context)
               throws StageProcessingException

Depth-first traversal of the DOM tree rooted in an element, applying the visitor when appropriate. The traversal snapshots the child elements at each level, so that the visitor could in principle reorder or delete them during processing.

Parameters:

element - Element to start from

context - context for the traversal

Throws:

StageProcessingException - if errors occur during processing

doExecute

protected void doExecute(Collection<Item<Element>> itemCollection)
                  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:

itemCollection - collection to be processed

Throws:

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

ancestorEntity

protected Element ancestorEntity(@Nonnull
                     Element element)

Returns the Element representing the EntityDescriptor which is the closest-containing ancestor of the given element.

Parameters:

element - Element to locate the ancestor Entity of.

Returns:

ancestor EntityDescriptor Element, or null.

addError

protected void addError(@Nonnull
            Item<Element> item,
            @Nonnull
            Element element,
            @Nonnull
            String error)

Add an ErrorStatus to the given item, in respect of the given Element. If the item is an EntitiesDescriptor, interpose an identifier for the individual EntityDescriptor.

Parameters:

item - Item to add the error to

element - Element the error reflects

error - error text