net.shibboleth.metadata.dom

Class XPathFilteringStage

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

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

@ThreadSafe
public class XPathFilteringStage
extends BaseStage<Element>

Pipeline stage which allows filtering of @{link DomElementItem}s according to an XPath expression. Each DOMElementItem is removed if the XPath expression evaluates as true.

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

• xpathExpression
• namespaceContext

Field Summary

Fields

Modifier and Type	Field and Description
private Logger	log Class logger.
private NamespaceContext	namespaceContext The NamespaceContext to use in interpreting the XPath expression.
private String	xpathExpression The XPath expression to execute on each DOMElementItem.

Constructor Summary

Constructors

Constructor and Description
XPathFilteringStage()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doDestroy()
void	doExecute(Collection<Item<Element>> metadataCollection) Performs the stage processing on the given Item collection.
protected void	doInitialize()
NamespaceContext	getNamespaceContext() Gets the NamespaceContext to use in interpreting the XPath expression.
String	getXPathExpression() Gets the XPath expression to execute on each DOMElementItem.
void	setNamespaceContext(NamespaceContext context) Sets the NamespaceContext to use in interpreting the XPath expression.
void	setXPathExpression(String expression) Sets the XPath expression to execute on each DOMElementItem.

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

getId

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

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

getId

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

initialize, isInitialized

Field Detail

log

private final Logger log

Class logger.

xpathExpression

private String xpathExpression

The XPath expression to execute on each DOMElementItem.

namespaceContext

private NamespaceContext namespaceContext

The NamespaceContext to use in interpreting the XPath expression.

Constructor Detail

XPathFilteringStage

public XPathFilteringStage()

Method Detail

getXPathExpression

@Nullable
public String getXPathExpression()

Gets the XPath expression to execute on each DOMElementItem.

Returns:

XPath expression to execute on each DOMElementItem

setXPathExpression

public void setXPathExpression(@Nonnull@NotEmpty
                      String expression)

Sets the XPath expression to execute on each DOMElementItem.

Parameters:

expression - XPath expression to execute on each DOMElementItem

getNamespaceContext

@Nonnull
public NamespaceContext getNamespaceContext()

Gets the NamespaceContext to use in interpreting the XPath expression.

Returns:

NamespaceContext to use in interpreting the XPath expression

setNamespaceContext

public void setNamespaceContext(@Nullable
                       NamespaceContext context)

Sets the NamespaceContext to use in interpreting the XPath expression.

Parameters:

context - NamespaceContext to use in interpreting the XPath expression

doExecute

public void doExecute(@Nonnull@NonnullElements
             Collection<Item<Element>> metadataCollection)

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:

metadataCollection - collection to be processed

doDestroy

protected void doDestroy()

Overrides:

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

doInitialize

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

Overrides:

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

Throws:

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