Package net.shibboleth.metadata.dom

Class AbstractElementVisitingValidationStage<V,N>

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.metadata.pipeline.AbstractStage<T>

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

net.shibboleth.metadata.dom.AbstractDOMTraversalStage<C>

net.shibboleth.metadata.dom.AbstractDOMValidationStage<V,DOMTraversalContext>

net.shibboleth.metadata.dom.AbstractElementVisitingValidationStage<V,N>

Type Parameters:

V - type of the values to be validated

N - type of node being visited during the traversal

All Implemented Interfaces:

Stage<Element>, net.shibboleth.shared.component.Component, net.shibboleth.shared.component.DestructableComponent, net.shibboleth.shared.component.IdentifiableComponent, net.shibboleth.shared.component.IdentifiedComponent, net.shibboleth.shared.component.InitializableComponent

Direct Known Subclasses:

AbstractAttributeValidationStage, AbstractElementValidationStage

public abstract class AbstractElementVisitingValidationStage<V,N>
extends AbstractDOMValidationStage<V,DOMTraversalContext>

Abstract parent class for validation of DOM nodes within a DOM traversal.

Note that the nodes being validated may be either elements or attributes; this class is parameterised by that type and a subclass must implement an appropriate conversion.

This class manages the set of Element names for the traversal.

Field Summary

Fields

Modifier and Type	Field	Description
private Set<QName>	elementNames	Collection of element names for those elements we will be visiting.

Constructor Summary

Constructors

Constructor	Description
AbstractElementVisitingValidationStage()

Method Summary

Modifier and Type	Method	Description
protected boolean	applicable(Element e, DOMTraversalContext context)	Indicates whether the visitor should be applied to a particular Element.
protected DOMTraversalContext	buildContext(Item<Element> item)	Build the context for a particular traversal.
protected abstract V	convert(N node)	Convert the visited Node to the type to be validated.
protected void	doInitialize()
final Collection<QName>	getElementNames()	Gets the collection of element names to visit.
final void	setElementName(QName name)	Sets a single element name to be visited.
final void	setElementNames(Collection<QName> names)	Sets the collection of element names to visit.

Methods inherited from class net.shibboleth.metadata.dom.AbstractDOMValidationStage

applyValidators, doDestroy, getValidators, setValidators

Methods inherited from class net.shibboleth.metadata.dom.AbstractDOMTraversalStage

addError, doExecute, errorPrefix, visit

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

doExecute

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

execute, getCollectionPredicate, setCollectionPredicate

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

ensureId, getId, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, 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.shared.component.DestructableComponent

destroy, isDestroyed

Methods inherited from interface net.shibboleth.shared.component.IdentifiedComponent

getId

Methods inherited from interface net.shibboleth.shared.component.InitializableComponent

initialize, isInitialized

Field Details

elementNames

@NonnullElements
@Unmodifiable
@Nonnull
private Set<QName> elementNames

Collection of element names for those elements we will be visiting.

Constructor Details

AbstractElementVisitingValidationStage

public AbstractElementVisitingValidationStage()

Method Details

getElementNames

@Nonnull
public final Collection<QName> getElementNames()

Gets the collection of element names to visit.

Returns:

collection of element names to visit.

setElementNames

public final void setElementNames(@Nonnull
 Collection<QName> names)

Sets the collection of element names to visit.

Parameters:

names - collection of element names to visit.

setElementName

public final void setElementName(@Nonnull
 QName name)

Sets a single element name to be visited.

Shorthand for setElementNames(java.util.Collection<javax.xml.namespace.QName>) with a singleton set.

Parameters:

name - QName for the element to be visited.

buildContext

@Nonnull
protected DOMTraversalContext buildContext(@Nonnull
 Item<Element> item)

Description copied from class: AbstractDOMTraversalStage

Build the context for a particular traversal.

Specified by:

buildContext in class AbstractDOMTraversalStage<DOMTraversalContext>

Parameters:

item - the Item we are traversing

Returns:

an appropriate context

applicable

protected boolean applicable(@Nonnull
 Element e,
 @Nonnull
 DOMTraversalContext context)

Description copied from class: AbstractDOMTraversalStage

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

Specified by:

applicable in class AbstractDOMTraversalStage<DOMTraversalContext>

Parameters:

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

context - DOMTraversalContext implementation being used to manage the traversal

Returns:

true if the visitor should be applied to this Element.

convert

@Nonnull
protected abstract V convert(@Nonnull
 N node)

Convert the visited Node to the type to be validated.

Parameters:

node - node being validated

Returns:

converted value

doInitialize

protected void doInitialize()
                     throws net.shibboleth.shared.component.ComponentInitializationException

Overrides:

doInitialize in class AbstractDOMValidationStage<V,DOMTraversalContext>

Throws:

net.shibboleth.shared.component.ComponentInitializationException