net.shibboleth.metadata.pipeline
Class StaticItemSourceStage<ItemType extends Item<?>>

java.lang.Object
  net.shibboleth.utilities.java.support.component.AbstractDestructableInitializableComponent
      net.shibboleth.utilities.java.support.component.AbstractDestructableIdentifiableInitializableComponent
          net.shibboleth.metadata.pipeline.BaseStage<ItemType>
              net.shibboleth.metadata.pipeline.StaticItemSourceStage<ItemType>

Type Parameters:

ItemType - the type of Item produced by this source

All Implemented Interfaces:

Stage<ItemType>, 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.InitializableComponent

@ThreadSafe
public class StaticItemSourceStage<ItemType extends Item<?>>
extends BaseStage<ItemType>

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

Field Summary

private Collection<ItemType>

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

Constructor Summary

StaticItemSourceStage()

Method Summary

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

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

execute, setId

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

doInitialize, getId

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

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

getId

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

initialize, isInitialized

Field Detail

source

private Collection<ItemType extends Item<?>> 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<ItemType> 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<ItemType> 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<ItemType> 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<ItemType extends Item<?>>

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