net.shibboleth.metadata.dom

Class NamespacesStrippingStage

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

net.shibboleth.metadata.dom.NamespacesStrippingStage

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 NamespacesStrippingStage
extends AbstractNamespacesStrippingStage

A stage which removes all evidence of a given collection of XML namespaces from each metadata item. The stage can operate either to blacklist (the default) or whitelist the collection of namespaces. Elements, attributes and namespace prefix definitions associated with a given namespace will be removed or retained depending on the whitelisting property. Attributes without an explicit namespace prefix will never be removed by this stage.

Field Summary

Fields

Modifier and Type	Field and Description
private Set<String>	namespaces XML namespaces to whitelist or blacklist.
private boolean	whitelisting Whether we are whitelisting or blacklisting (default: blacklisting).

Constructor Summary

Constructors

Constructor and Description
NamespacesStrippingStage()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doDestroy()
Collection<String>	getNamespaces() Gets the collection of namespaces being blacklisted or whitelisted.
boolean	isWhitelisting() Indicate whether the stage is whitelisting namespaces or blacklisting (the default).
protected boolean	removingNamespace(String namespace) Determine whether a particular namespace should be stripped.
void	setNamespaces(Collection<String> nss) Sets the collection of namespaces to blacklist or whitelist.
void	setWhitelisting(boolean wl) Set whether the stage is whitelisting namespaces.

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

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, 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

namespaces

private final Set<String> namespaces

XML namespaces to whitelist or blacklist.

whitelisting

private boolean whitelisting

Whether we are whitelisting or blacklisting (default: blacklisting).

Constructor Detail

NamespacesStrippingStage

public NamespacesStrippingStage()

Method Detail

getNamespaces

@Nonnull
public Collection<String> getNamespaces()

Gets the collection of namespaces being blacklisted or whitelisted.

Returns:

collection of namespaces being removed

setNamespaces

public void setNamespaces(@Nonnull
                 Collection<String> nss)

Sets the collection of namespaces to blacklist or whitelist.

Parameters:

nss - collection of namespaces

isWhitelisting

public boolean isWhitelisting()

Indicate whether the stage is whitelisting namespaces or blacklisting (the default).

Returns:

true for whitelisting, false for blacklisting (the default)

setWhitelisting

public void setWhitelisting(boolean wl)

Set whether the stage is whitelisting namespaces.

Parameters:

wl - true for whitelisting, false for blacklisting

removingNamespace

protected boolean removingNamespace(String namespace)

Description copied from class: AbstractNamespacesStrippingStage

Determine whether a particular namespace should be stripped.

Specified by:

removingNamespace in class AbstractNamespacesStrippingStage

Parameters:

namespace - potentially stripped namespace

Returns:

true if this namespace should be stripped

doDestroy

protected void doDestroy()

Overrides:

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