Package net.shibboleth.metadata.pipeline

Class AbstractIteratingStage<T>

java.lang.Object
net.shibboleth.shared.component.AbstractInitializableComponent
net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent
net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent
net.shibboleth.metadata.pipeline.AbstractStage<T>
net.shibboleth.metadata.pipeline.AbstractIteratingStage<T>
Type Parameters:
T - type of metadata this stage operates upon
All Implemented Interfaces:
Stage<T>, net.shibboleth.shared.component.Component, net.shibboleth.shared.component.DestructableComponent, net.shibboleth.shared.component.IdentifiableComponent, net.shibboleth.shared.component.IdentifiedComponent, net.shibboleth.shared.component.InitializableComponent
Direct Known Subclasses:
AbstractDOMTraversalStage, AbstractNamespacesStrippingStage, ContactPersonFilterStage, DuplicateEntityInAggregateCheckingStage, ElementStrippingStage, EmptyContainerStrippingStage, EntityAttributeFilteringStage, EntityDescriptorItemIdPopulationStage, GenerateIdStage, ItemIdTransformStage, ItemMetadataAddingStage, MultiOutputSerializationStage, PullUpCacheDurationStage, PullUpValidUntilStage, RegistrationAuthorityPopulationStage, RemoveOrganizationStage, SetCacheDurationStage, SetValidUntilStage, ValidateValidUntilStage, XMLSchemaValidationStage
@ThreadSafe public abstract class AbstractIteratingStage<T> extends AbstractStage<T>
Base class for Stage implementations that iterate over each Item in a collection and do something.
Since:
0.10.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractIteratingStage()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    doExecute(List<Item<T>> items)
    Iterates over each element of the Item collection and delegates the processing of that element to doExecute(Item).
    protected abstract void
    doExecute(Item<T> item)
    Processes a given Item.

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

    execute, getCollectionPredicate, setCollectionPredicate

    Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

    setId

    Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

    doInitialize, ensureId, getId, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException

    Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

    checkComponentActive, checkSetterPreconditions, 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.shared.component.DestructableComponent

    destroy, isDestroyed

    Methods inherited from interface net.shibboleth.shared.component.IdentifiedComponent

    getId

    Methods inherited from interface net.shibboleth.shared.component.InitializableComponent

    initialize, isInitialized

  • Constructor Details

    • AbstractIteratingStage

      public AbstractIteratingStage()

  • Method Details

    • doExecute

      protected void doExecute(@Nonnull @NonnullElements List<Item<T>> items) throws StageProcessingException
      Iterates over each element of the Item collection and delegates the processing of that element to doExecute(Item). 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 AbstractStage<T>
      Parameters:
      items - collection to be processed
      Throws:
      StageProcessingException - thrown if there is an unrecoverable problem when processing the stage

    • doExecute

      protected abstract void doExecute(@Nonnull Item<T> item) throws StageProcessingException
      Processes a given Item.
      Parameters:
      item - Item on which to operate
      Throws:
      StageProcessingException - thrown if there is a problem with the stage processing