net.shibboleth.metadata.pipeline

Class StaticItemSourceStage<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.StaticItemSourceStage<T>

Type Parameters:

T - the type of item produced by this source

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 StaticItemSourceStage<T>
extends BaseStage<T>

A stage which adds a static collection of Items to a Item collection.

Field Summary

Fields

Modifier and Type	Field and Description
private Collection<Item<T>>	source Collection of static Items added to each Item collection by BaseStage.execute(Collection).

Constructor Summary

Constructors

Constructor and Description
StaticItemSourceStage()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doDestroy()
protected void	doExecute(Collection<Item<T>> itemCollection) Performs the stage processing on the given Item collection.
Collection<Item<T>>	getSourceItems() Gets the collection of static Items added to the Item collection by this stage.
void	setSourceItems(Collection<Item<T>> items) Sets the collection of Items added to the Item collection by this stage.

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

source

private Collection<Item<T>> source

Collection of static Items added to each Item collection by BaseStage.execute(Collection).

Constructor Detail

StaticItemSourceStage

public StaticItemSourceStage()

Method Detail

getSourceItems

@Nonnull
@NonnullElements
@Unmodifiable
public Collection<Item<T>> getSourceItems()

Gets the collection of static Items added to the Item collection by this stage.

Returns:

collection of static Items added to the Item collection by this stage

setSourceItems

public void setSourceItems(@Nullable@NullableElements
                  Collection<Item<T>> items)

Sets the collection of Items added to the Item collection by this stage.

Parameters:

items - collection of Items added to the Item collection by this stage

doExecute

protected void doExecute(@Nonnull@NonnullElements
             Collection<Item<T>> itemCollection)
                  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<T>

Parameters:

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