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

java.lang.Object
  net.shibboleth.metadata.pipeline.AbstractComponent
      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:

Component, Stage<ItemType>

@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	doExecute(Collection<ItemType> itemCollection) Performs the stage processing on the given Item collection.
protected void	doInitialize() Do the initialization of the component.
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

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

equals, getId, getInitializationInstant, hashCode, initialize, isInitialized, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.shibboleth.metadata.pipeline.Component

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

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(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(Collection<ItemType> itemCollection)
                  throws StageProcessingException

Performs the stage processing on the given Item collection.

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

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Do the initialization of the component. Default implementation of this method is a no-op. Extending classes should override this method to perform any initialization logic necessary.

Overrides:

doInitialize in class AbstractComponent

Throws:

ComponentInitializationException - throw if there is a problem initializing the component