net.shibboleth.metadata.pipeline

Class ItemMetadataAddingStage<T>

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

net.shibboleth.metadata.pipeline.BaseStage<T>

net.shibboleth.metadata.pipeline.BaseIteratingStage<T>

net.shibboleth.metadata.pipeline.ItemMetadataAddingStage<T>

Type Parameters:

T - type of Item this stage operates upon

All Implemented Interfaces:

Stage<T>, 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.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent

@ThreadSafe
public class ItemMetadataAddingStage<T>
extends BaseIteratingStage<T>

A pipeline stage that adds a collection of ItemMetadata objects to each Item's item metadata.

Field Summary

Fields

Modifier and Type	Field and Description
private Collection<ItemMetadata>	additionalItemMetadata ItemMetadata objects to add to each Item's item metadata.

Constructor Summary

Constructors

Constructor and Description
ItemMetadataAddingStage()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	doExecute(Item<T> item) Processes a given Item.
Collection<ItemMetadata>	getAdditionalItemMetadata() Gets the ItemMetadata being added to each Item's item metadata.
void	setAdditionalItemMetadata(Collection<ItemMetadata> metadata) Gets the ItemMetadata to be added to each Item's item metadata.

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

doExecute

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

execute, getCollectionPredicate, setCollectionPredicate

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

setId

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

doInitialize, getId

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

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.utilities.java.support.component.DestructableComponent

destroy, isDestroyed

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

getId

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

initialize, isInitialized

Field Detail

additionalItemMetadata

private Collection<ItemMetadata> additionalItemMetadata

ItemMetadata objects to add to each Item's item metadata.

Constructor Detail

ItemMetadataAddingStage

public ItemMetadataAddingStage()

Method Detail

getAdditionalItemMetadata

@Nonnull
public Collection<ItemMetadata> getAdditionalItemMetadata()

Gets the ItemMetadata being added to each Item's item metadata.

Returns:

the ItemMetadata being added to each Item's item metadata

setAdditionalItemMetadata

public void setAdditionalItemMetadata(@Nonnull
                             Collection<ItemMetadata> metadata)

Gets the ItemMetadata to be added to each Item's item metadata.

Parameters:

metadata - the ItemMetadata to be added to each Item's item metadata

doExecute

protected boolean doExecute(@Nonnull
                Item<T> item)
                     throws StageProcessingException

Processes a given Item.

Specified by:

doExecute in class BaseIteratingStage<T>

Parameters:

item - Item on which to operate

Returns:

true if the Item should be retained in the collection, false if not

Throws:

StageProcessingException - thrown if there is a problem with the stage processing