net.shibboleth.metadata.pipeline
Class ItemMetadataFilterStage

java.lang.Object
  net.shibboleth.metadata.pipeline.AbstractComponent
      net.shibboleth.metadata.pipeline.BaseStage<Item<?>>
          net.shibboleth.metadata.pipeline.AbstractItemMetadataSelectionStage
              net.shibboleth.metadata.pipeline.ItemMetadataFilterStage

All Implemented Interfaces:

Component, Stage<Item<?>>

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

doExecute, getItemIdentifierStrategy, getSelectionRequirements, setIdentifierStrategy, setSelectionRequirements

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

execute

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

Field Detail

log

private final Logger log

Class logger.

Constructor Detail

ItemMetadataFilterStage

public ItemMetadataFilterStage()

Method Detail

doExecute

protected void doExecute(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