net.shibboleth.metadata.dom

Class ElementStrippingStage

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

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 ElementStrippingStage
extends BaseStage<Element>

A stage which removes all instances of the specified element from DOM metadata.

Field Summary

Fields

Modifier and Type	Field and Description
private String	elementName Name of the element to strip.
private String	elementNamespace Namespace of the element to strip.

Constructor Summary

Constructors

Constructor and Description
ElementStrippingStage()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doDestroy()
protected void	doExecute(Collection<Item<Element>> items) Performs the stage processing on the given Item collection.
protected void	doInitialize()
String	getElementName() Get the name of the element to strip.
String	getElementNamespace() Get the namespace of the element to strip.
void	setElementName(String name) Set the name of the element to strip.
void	setElementNamespace(String namespace) Set the namespace of the element to strip.

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

elementNamespace

private String elementNamespace

Namespace of the element to strip.

elementName

private String elementName

Name of the element to strip.

Constructor Detail

ElementStrippingStage

public ElementStrippingStage()

Method Detail

getElementNamespace

@Nullable
public String getElementNamespace()

Get the namespace of the element to strip.

Returns:

namespace of the element to strip

setElementNamespace

public void setElementNamespace(@Nonnull@NotEmpty
                       String namespace)

Set the namespace of the element to strip.

Parameters:

namespace - namespace of the element to strip

getElementName

@Nullable
public String getElementName()

Get the name of the element to strip.

Returns:

the name of the element to strip

setElementName

public void setElementName(@Nonnull@NotEmpty
                  String name)

Set the name of the element to strip.

Parameters:

name - the name of the element to strip

doExecute

protected void doExecute(@Nonnull@NonnullElements
             Collection<Item<Element>> items)
                  throws StageProcessingException

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:

items - collection to be processed

Throws:

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

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