net.shibboleth.metadata.pipeline

Class ItemIdTransformStage<T>

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

net.shibboleth.metadata.pipeline.BaseIteratingStage<T>

net.shibboleth.metadata.pipeline.ItemIdTransformStage<T>

Type Parameters:

T - type of Item this stage operates upon

All Implemented Interfaces:

Stage<T>, 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 ItemIdTransformStage<T>
extends BaseIteratingStage<T>

A pipeline stage that, takes each ItemId associated with an Item, transforms its value using a set of registered transformers, and associates an additional ItemId (whose value is the result of the transform) with the element.

Field Summary

Fields

Modifier and Type	Field and Description
private Collection<Converter<String,String>>	idTransformers Transformers used on IDs.

Constructor Summary

Constructors

Constructor and Description
ItemIdTransformStage()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	doExecute(Item<T> item) Processes a given Item.
Collection<Converter<String,String>>	getIdTransformers() Gets the transforms used to produce the transformed entity IDs.
void	setIdTransformers(Collection<Converter<String,String>> transformers) Sets the transforms used to produce the transformed entity IDs.

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

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

idTransformers

private Collection<Converter<String,String>> idTransformers

Transformers used on IDs.

Constructor Detail

ItemIdTransformStage

public ItemIdTransformStage()

Method Detail

getIdTransformers

public Collection<Converter<String,String>> getIdTransformers()

Gets the transforms used to produce the transformed entity IDs.

Returns:

transforms used to produce the transformed entity IDs, never null

setIdTransformers

public void setIdTransformers(Collection<Converter<String,String>> transformers)

Sets the transforms used to produce the transformed entity IDs.

Parameters:

transformers - transforms used to produce the transformed entity IDs

doExecute

protected boolean doExecute(@Nonnull
                Item<T> item)
                     throws StageProcessingException

Processes a given Item.

Specified by:

doExecute in class BaseIteratingStage<T>

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