net.shibboleth.metadata.dom
Class XMLSchemaValidationStage

java.lang.Object
  net.shibboleth.utilities.java.support.component.AbstractDestructableInitializableComponent
      net.shibboleth.utilities.java.support.component.AbstractDestructableIdentifiableInitializableComponent
          net.shibboleth.metadata.pipeline.BaseStage<ItemType>
              net.shibboleth.metadata.pipeline.BaseIteratingStage<DomElementItem>
                  net.shibboleth.metadata.dom.XMLSchemaValidationStage

All Implemented Interfaces:

Stage<DomElementItem>, 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.InitializableComponent

@ThreadSafe
public class XMLSchemaValidationStage
extends BaseIteratingStage<DomElementItem>

A pipeline stage that XML schema validates the elements within the DomElementItem collection.

This stage requires the following properties be set prior to initialization:

• schemaResources

If DOM Elements are required to be valid, per isElementRequiredToBeSchemaValid() and an Element is found to be invalid than an ErrorStatus object is set on the element. If the Element is not required to be valid and an Element is found to be invalid than an WarningStatus is set on the Element.

Field Summary

private boolean	elementRequiredToBeSchemaValid Whether Elements are required to be schema valid.
private Logger	log Class logger.
private List<net.shibboleth.utilities.java.support.resource.Resource>	schemaResources Collection of schema resources.
private Schema	validationSchema Schema used to validate Elements.

Constructor Summary

XMLSchemaValidationStage()

Method Summary

protected void	doDestroy()
protected boolean	doExecute(DomElementItem item) Processes a given Item.
protected void	doInitialize()
List<net.shibboleth.utilities.java.support.resource.Resource>	getSchemaResources() Gets an unmodifiable list of schema resources against which Elements are validated.
boolean	isElementRequiredToBeSchemaValid() Gets whether Elements are required to be schema valid.
void	setElementRequiredToBeSchemaValid(boolean isRequired) Sets whether Elements are required to be schema valid.
void	setSchemaResources(List<net.shibboleth.utilities.java.support.resource.Resource> resources) Sets the schema resources against which Elements are validated.

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

doExecute

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

execute, setId

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

getId

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

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.utilities.java.support.component.DestructableComponent

destroy, isDestroyed

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

getId

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

initialize, isInitialized

Field Detail

log

private final Logger log

Class logger.

schemaResources

private List<net.shibboleth.utilities.java.support.resource.Resource> schemaResources

Collection of schema resources.

elementRequiredToBeSchemaValid

private boolean elementRequiredToBeSchemaValid

Whether Elements are required to be schema valid. Default value: true

validationSchema

private Schema validationSchema

Schema used to validate Elements.

Constructor Detail

XMLSchemaValidationStage

public XMLSchemaValidationStage()

Method Detail

getSchemaResources

@Nonnull
@NonnullElements
@Unmodifiable
public List<net.shibboleth.utilities.java.support.resource.Resource> getSchemaResources()

Gets an unmodifiable list of schema resources against which Elements are validated.

Returns:

unmodifiable list of schema resources against which Elements are validated

setSchemaResources

public void setSchemaResources(@Nullable@NullableElements
                               List<net.shibboleth.utilities.java.support.resource.Resource> resources)

Sets the schema resources against which Elements are validated.

Parameters:

resources - schema resources against which Elements are validated

isElementRequiredToBeSchemaValid

public boolean isElementRequiredToBeSchemaValid()

Gets whether Elements are required to be schema valid.

Returns:

whether Elements are required to be schema valid

setElementRequiredToBeSchemaValid

public void setElementRequiredToBeSchemaValid(boolean isRequired)

Sets whether Elements are required to be schema valid.

Parameters:

isRequired - whether Elements are required to be schema valid

doExecute

protected boolean doExecute(@Nonnull
                            DomElementItem item)
                     throws StageProcessingException

Processes a given Item.

Specified by:

doExecute in class BaseIteratingStage<DomElementItem>

Parameters:

item - Item on which to operate

Returns:

true if the Item should be retained in the collection, false if not

Throws:

StageProcessingException - thrown if there is a problem with the stage processing

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class net.shibboleth.utilities.java.support.component.AbstractDestructableInitializableComponent

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.component.AbstractDestructableIdentifiableInitializableComponent

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException