net.shibboleth.metadata.dom

Class CRDetectionStage

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

net.shibboleth.metadata.dom.CRDetectionStage

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

public class CRDetectionStage
extends AbstractDOMTraversalStage

A stage to examine all the text in Element-based Items (text nodes and attributes) and mark them as being in error if a CR character appears. This can only be the case if the XML document contained an explicit character reference such as 
. This stage is specifically intended to detect metadata which would trigger the SSPCPP-684 issue in the Shibboleth SP.

See Also:

SSPCPP-684

Nested Class Summary

Nested classes/interfaces inherited from class net.shibboleth.metadata.dom.AbstractDOMTraversalStage

AbstractDOMTraversalStage.TraversalContext

Field Summary

Fields

Modifier and Type	Field and Description
private static char	CR Character value we are looking for.

Constructor Summary

Constructors

Constructor and Description
CRDetectionStage()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	applicable(Element element) Indicates whether the visitor should be applied to a particular Element.
protected void	visit(Element element, AbstractDOMTraversalStage.TraversalContext context) Visit a particular Element.

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

addError, ancestorEntity, doExecute

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

CR

private static final char CR

Character value we are looking for.

See Also:

Constant Field Values

Constructor Detail

CRDetectionStage

public CRDetectionStage()

Method Detail

applicable

protected boolean applicable(Element element)

Description copied from class: AbstractDOMTraversalStage

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

Specified by:

applicable in class AbstractDOMTraversalStage

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 void visit(Element element,
         AbstractDOMTraversalStage.TraversalContext context)
              throws StageProcessingException

Description copied from class: AbstractDOMTraversalStage

Visit a particular Element.

Specified by:

visit in class AbstractDOMTraversalStage

Parameters:

element - the Element to visit

context - the traversal context

Throws:

StageProcessingException - if errors occur during processing