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

java.lang.Object
  net.shibboleth.metadata.pipeline.AbstractComponent
      net.shibboleth.metadata.pipeline.BaseStage<ItemType>

Type Parameters:

ItemType - type of Item this stage operates upon

All Implemented Interfaces:

Component, Stage<ItemType>

Direct Known Subclasses:

AbstractItemMetadataSelectionStage, AbstractXSLProcessingStage, BaseIteratingStage, DomFilesystemSourceStage, DomResourceSourceStage, EntitiesDescriptorAssemblerStage, EntitiesDescriptorDisassemblerStage, EntityPublisherPathFilterStage, PipelineDemultiplexerStage, PipelineMergeStage, PushDownCacheDurationStage, PushDownValidUntilStage, ScriptletStage, SerializationStage, SetPublicationInfo, SplitMergeStage, StaticItemSourceStage, XPathFilteringStage

public abstract class BaseStage<ItemType extends Item<?>>
extends AbstractComponent
implements Stage<ItemType>

A base class for Stage implementations.

Constructor Summary

BaseStage()

Method Summary

protected abstract void	doExecute(Collection<ItemType> itemCollection) Performs the stage processing on the given Item collection.
void	execute(Collection<ItemType> 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.

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

doInitialize, 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

Constructor Detail

BaseStage

public BaseStage()

Method Detail

execute

public void execute(Collection<ItemType> 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<ItemType extends Item<?>>

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

Performs the stage processing on the given Item collection.

Parameters:

itemCollection - collection to be processed

Throws:

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