net.shibboleth.metadata.pipeline

Class BaseStage<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>

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

Direct Known Subclasses:

AbstractDOMTraversalStage, AbstractItemMetadataSelectionStage, AbstractNamespacesStrippingStage, AbstractXSLProcessingStage, BaseIteratingStage, CompositeStage, DOMFilesystemSourceStage, DOMResourceSourceStage, ElementStrippingStage, EmptyContainerStrippingStage, EntitiesDescriptorAssemblerStage, EntitiesDescriptorDisassemblerStage, EntityAttributeFilteringStage, MultiOutputSerializationStage, PipelineDemultiplexerStage, PipelineMergeStage, RegistrationAuthorityPopulationStage, ScriptletStage, SerializationStage, SplitMergeStage, StaticItemSourceStage, XPathFilteringStage

@ThreadSafe
public abstract class BaseStage<T>
extends net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent
implements Stage<T>

A base class for Stage implementations.

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.common.base.Predicate<Collection<Item<T>>>	collectionPredicate The Predicate applied to the supplied item collection to determine whether the stage will be executed.

Constructor Summary

Constructors

Constructor and Description
BaseStage()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	doExecute(Collection<Item<T>> itemCollection) Performs the stage processing on the given Item collection.
void	execute(Collection<Item<T>> itemCollection) Creates an ComponentInfo, delegates actual work on the collection to doExecute(Collection), adds the ComponentInfo to all the resultant Item elements and then sets its completion time.
com.google.common.base.Predicate<Collection<Item<T>>>	getCollectionPredicate() Gets the Predicate being applied to the supplied item collection to determine whether the stage will be executed.
void	setCollectionPredicate(com.google.common.base.Predicate<Collection<Item<T>>> pred) Sets the Predicate applied to the supplied item collection to determine whether the stage will be executed.

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

collectionPredicate

@Nonnull
private com.google.common.base.Predicate<Collection<Item<T>>> collectionPredicate

The Predicate applied to the supplied item collection to determine whether the stage will be executed. Default value: always true.

Constructor Detail

BaseStage

public BaseStage()

Method Detail

setCollectionPredicate

public void setCollectionPredicate(@Nonnull
                          com.google.common.base.Predicate<Collection<Item<T>>> pred)

Sets the Predicate applied to the supplied item collection to determine whether the stage will be executed.

Parameters:

pred - the Predicate applied to the supplied item collection to determine whether the stage will be executed

getCollectionPredicate

@Nonnull
public com.google.common.base.Predicate<Collection<Item<T>>> getCollectionPredicate()

Gets the Predicate being applied to the supplied item collection to determine whether the stage will be executed.

Returns:

the Predicate being applied to the supplied item collection to determine whether the stage will be executed.

execute

public void execute(@Nonnull@NonnullElements
           Collection<Item<T>> itemCollection)
             throws StageProcessingException

Creates an ComponentInfo, delegates actual work on the collection to doExecute(Collection), adds the ComponentInfo to all the resultant Item elements and then sets its completion time. Transforms the given input data.

Specified by:

execute in interface Stage<T>

Parameters:

itemCollection - the data to be transformed

Throws:

StageProcessingException - thrown if there is a problem running this stage on the given input

doExecute

protected abstract 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.

Parameters:

itemCollection - collection to be processed

Throws:

StageProcessingException - thrown if there is an unrecoverable problem when processing the stage