net.shibboleth.metadata.pipeline
Class ItemMetadataFilterStage

java.lang.Object
  net.shibboleth.utilities.java.support.component.AbstractDestructableInitializableComponent
      net.shibboleth.utilities.java.support.component.AbstractDestructableIdentifiableInitializableComponent
          net.shibboleth.metadata.pipeline.BaseStage<Item<?>>
              net.shibboleth.metadata.pipeline.AbstractItemMetadataSelectionStage
                  net.shibboleth.metadata.pipeline.ItemMetadataFilterStage

All Implemented Interfaces:

Stage<Item<?>>, 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.InitializableComponent

@ThreadSafe
public class ItemMetadataFilterStage
extends AbstractItemMetadataSelectionStage

A Stage that filters out Item if they have a specific type of ItemMetadata attached to them. This is useful, for example, in removing all Item elements which have an associated ErrorStatus.

Field Summary

private Logger

log Class logger.

Constructor Summary

ItemMetadataFilterStage()

Method Summary

protected void

doExecute(Collection<Item<?>> itemCollection, Item<?> matchingItem, Map<Class<? extends ItemMetadata>,List<? extends ItemMetadata>> matchingMetadata) Performs the stage's logic on the given item that contained metadata of the given type.

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

doDestroy, doExecute, getItemIdentifierStrategy, getSelectionRequirements, setIdentifierStrategy, setSelectionRequirements

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

execute, setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractDestructableIdentifiableInitializableComponent

doInitialize, getId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractDestructableInitializableComponent

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.IdentifiableComponent

getId

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Detail

log

private final Logger log

Class logger.

Constructor Detail

ItemMetadataFilterStage

public ItemMetadataFilterStage()

Method Detail

doExecute

protected void doExecute(@Nonnull@NonnullElements
                         Collection<Item<?>> itemCollection,
                         Item<?> matchingItem,
                         Map<Class<? extends ItemMetadata>,List<? extends ItemMetadata>> matchingMetadata)
                  throws StageProcessingException

Performs the stage's logic on the given item that contained metadata of the given type.

Specified by:

doExecute in class AbstractItemMetadataSelectionStage

Parameters:

itemCollection - current item collection

matchingItem - matching item

matchingMetadata - all the ItemMetadata instances that match a selection criteria

Throws:

StageProcessingException - thrown if there is a problem processing the item