Class StaticItemSourceStage<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.StaticItemSourceStage<T>
Type Parameters:
T - the type of item produced by this source
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

@ThreadSafe public class StaticItemSourceStage<T> extends AbstractStage<T>
A stage which adds a static collection of Items to a Item collection.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private List<Item<T>>
    Collection of static Items added to each Item collection by AbstractStage.execute(List).
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    doExecute(List<Item<T>> items)
    Performs the stage processing on the given Item collection.
    final List<Item<T>>
    Gets the collection of static Items added to the Item collection by this stage.
    void
    Sets the collection of Items added to the Item collection by this stage.

    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
  • Field Details

  • Constructor Details

    • StaticItemSourceStage

      public StaticItemSourceStage()
  • Method Details

    • getSourceItems

      @Nonnull @NonnullElements @Unmodifiable public final List<Item<T>> 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(@Nonnull @NonnullElements @Unmodifiable List<Item<T>> 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(@Nonnull @NonnullElements List<Item<T>> items) throws StageProcessingException
      Description copied from class: AbstractStage
      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