net.shibboleth.metadata.pipeline

Class SerializationStage<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.SerializationStage<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 SerializationStage<T>
extends BaseStage<T>

A stage which writes the given item collection out to a file using a provided ItemCollectionSerializer.

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

• outputFile
• serializer

Field Summary

Fields

Modifier and Type	Field and Description
private Logger	log Class logger.
private File	outputFile File to which the item will be written.
private boolean	overwritingExistingOutputFile Whether an existing output file should be overwritten.
private ItemCollectionSerializer<T>	serializer Serializer used to write the collection to the output stream.

Constructor Summary

Constructors

Constructor and Description
SerializationStage()

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()
File	getOutputFile() Gets the file to which the item will be written.
ItemCollectionSerializer<T>	getSerializer() Gets the serializer used to write item to the output file.
boolean	isOverwritingExistingOutputFile() Gets whether an existing output file should be overwritten.
void	setOutputFile(File file) Sets the file to which the item will be written.
void	setOverwritingExistingOutputFile(boolean isOverwriting) Sets whether an existing output file should be overwritten.
void	setSerializer(ItemCollectionSerializer<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

log

private final Logger log

Class logger.

outputFile

private File outputFile

File to which the item will be written.

overwritingExistingOutputFile

private boolean overwritingExistingOutputFile

Whether an existing output file should be overwritten. Default value: true

serializer

private ItemCollectionSerializer<T> serializer

Serializer used to write the collection to the output stream.

Constructor Detail

SerializationStage

public SerializationStage()

Method Detail

getOutputFile

@Nullable
public File getOutputFile()

Gets the file to which the item will be written.

Returns:

file to which the item will be written

setOutputFile

public void setOutputFile(@Nonnull
                 File file)

Sets the file to which the item will be written.

Parameters:

file - file to which the item will be written

isOverwritingExistingOutputFile

public boolean isOverwritingExistingOutputFile()

Gets whether an existing output file should be overwritten.

Returns:

whether an existing output file should be overwritten

setOverwritingExistingOutputFile

public void setOverwritingExistingOutputFile(boolean isOverwriting)

Sets whether an existing output file should be overwritten.

Parameters:

isOverwriting - whether an existing output file should be overwritten

getSerializer

@Nullable
public ItemCollectionSerializer<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
                 ItemCollectionSerializer<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

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