net.shibboleth.metadata.pipeline

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

Type Parameters:

T - type of metadata this stage, and its composed stages, operate 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 CompositeStage<T>
extends BaseStage<T>

A stage that is composed of other stages. This allows a collection of stages to be grouped together and for that composition to the be referenced and reused.

Field Summary

Fields

Modifier and Type	Field and Description
private List<Stage<T>>	composedStages Stages which compose this stage.

Constructor Summary

Constructors

Constructor and Description
CompositeStage()

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.
protected void	doInitialize()
List<Stage<T>>	getComposedStages() Gets an unmodifiable list the stages that compose this stage.
void	setComposedStages(List<Stage<T>> stages) Sets the list the stages that compose 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

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

composedStages

private List<Stage<T>> composedStages

Stages which compose this stage.

Constructor Detail

CompositeStage

public CompositeStage()

Method Detail

getComposedStages

@Nonnull
@NonnullElements
public List<Stage<T>> getComposedStages()

Gets an unmodifiable list the stages that compose this stage.

Returns:

list the stages that compose this stage, never null nor containing null elements

setComposedStages

public void setComposedStages(@Nullable@NullableElements
                     List<Stage<T>> stages)

Sets the list the stages that compose this stage.

Parameters:

stages - list the stages that compose this stage, may be null or contain null elements

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

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException