Package net.shibboleth.metadata.pipeline

Class ItemMetadataAddingStage<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>

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

Type Parameters:

T - type of Item 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

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

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

Since:

0.9.0

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ItemMetadataAddingStage()

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(Item<T> item)	Processes a given Item.
final 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.AbstractIteratingStage

doExecute

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

additionalItemMetadata

@Nonnull
@NonnullElements
@Unmodifiable
private List<ItemMetadata> additionalItemMetadata

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

Constructor Details

ItemMetadataAddingStage

public ItemMetadataAddingStage()

Method Details

getAdditionalItemMetadata

@Nonnull
@NonnullElements
@Unmodifiable
public final 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 @NonnullElements @Unmodifiable
 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 void doExecute(@Nonnull
 Item<T> item)
                  throws StageProcessingException

Description copied from class: AbstractIteratingStage

Processes a given Item.

Specified by:

doExecute in class AbstractIteratingStage<T>

Parameters:

item - Item on which to operate

Throws:

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