net.shibboleth.metadata.pipeline

Class MultiOutputSerializationStage<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.MultiOutputSerializationStage<T>

Type Parameters:

T - type of items upon which this stage operates

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 MultiOutputSerializationStage<T>
extends BaseStage<T>

A stage which writes the given item collection out to multiple destinations. The destination for each item is determined by a strategy function, and the serialisation is performed using a provided ItemSerializer.

This stage requires the following properties be set prior to initialization:

• outputStrategy
• serializer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MultiOutputSerializationStage.Destination Interface implemented by destination objects created by an MultiOutputSerializationStage.OutputStrategy.
static interface	MultiOutputSerializationStage.OutputStrategy<T> Interface to be implemented by strategy object determining where an item should be written.

Field Summary

Fields

Modifier and Type	Field and Description
private MultiOutputSerializationStage.OutputStrategy<T>	outputStrategy Strategy used to determine where to serialize the item.
private ItemSerializer<T>	serializer Serializer used to write the collection to the output stream.

Constructor Summary

Constructors

Constructor and Description
MultiOutputSerializationStage()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doDestroy()
protected void	doExecute(Collection<Item<T>> itemCollection) Performs the stage processing on the given Item collection.
protected void	doInitialize()
MultiOutputSerializationStage.OutputStrategy<T>	getOutputStrategy() Gets the output strategy function determining where an item will be written.
ItemSerializer<T>	getSerializer() Gets the serializer used to write item to the output file.
void	setOutputStrategy(MultiOutputSerializationStage.OutputStrategy<T> strategy) Sets the output strategy function determining where an item will be written.
void	setSerializer(ItemSerializer<T> itemSerializer) Sets the serializer used to write item to the output file.

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

getId

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

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

getId

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

initialize, isInitialized

Field Detail

outputStrategy

private MultiOutputSerializationStage.OutputStrategy<T> outputStrategy

Strategy used to determine where to serialize the item.

serializer

private ItemSerializer<T> serializer

Serializer used to write the collection to the output stream.

Constructor Detail

MultiOutputSerializationStage

public MultiOutputSerializationStage()

Method Detail

getOutputStrategy

@Nullable
public MultiOutputSerializationStage.OutputStrategy<T> getOutputStrategy()

Gets the output strategy function determining where an item will be written.

Returns:

the output strategy function

setOutputStrategy

public void setOutputStrategy(@Nonnull
                     MultiOutputSerializationStage.OutputStrategy<T> strategy)

Sets the output strategy function determining where an item will be written.

Parameters:

strategy - output strategy function determining where an item will be written

getSerializer

@Nullable
public ItemSerializer<T> getSerializer()

Gets the serializer used to write item to the output file.

Returns:

serializer used to write item to the output file

setSerializer

public void setSerializer(@Nonnull
                 ItemSerializer<T> itemSerializer)

Sets the serializer used to write item to the output file.

Parameters:

itemSerializer - serializer used to write item to the output file

doExecute

protected void doExecute(@Nonnull@NonnullElements
             Collection<Item<T>> itemCollection)
                  throws StageProcessingException

Description copied from class: BaseStage

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 BaseStage<T>

Parameters:

itemCollection - collection to be processed

Throws:

StageProcessingException - thrown if there is an unrecoverable problem when processing the stage

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException