net.shibboleth.metadata.dom.saml
Class GenerateIdStage

java.lang.Object
  net.shibboleth.utilities.java.support.component.AbstractDestructableInitializableComponent
      net.shibboleth.utilities.java.support.component.AbstractDestructableIdentifiableInitializableComponent
          net.shibboleth.metadata.pipeline.BaseStage<ItemType>
              net.shibboleth.metadata.pipeline.BaseIteratingStage<DomElementItem>
                  net.shibboleth.metadata.dom.saml.GenerateIdStage

All Implemented Interfaces:

Stage<DomElementItem>, 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.InitializableComponent

public class GenerateIdStage
extends BaseIteratingStage<DomElementItem>

A stage that populates the ID attribute of an EntitiesDescriptor or EntityDescriptor.

Field Summary

static QName	ID_ATTRIB QName of the ID attribute added to the descriptor.
private net.shibboleth.utilities.java.support.security.IdentifierGenerationStrategy	idGenerator Strategy used to generate identifiers.

Constructor Summary

GenerateIdStage()
Constructor.

GenerateIdStage(net.shibboleth.utilities.java.support.security.IdentifierGenerationStrategy generator)
Constructor.

Method Summary

protected boolean

doExecute(DomElementItem item) Processes a given Item.

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

doExecute

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

execute, setId

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

doInitialize, getId

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

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

getId

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

initialize, isInitialized

Field Detail

ID_ATTRIB

public static final QName ID_ATTRIB

QName of the ID attribute added to the descriptor.

idGenerator

private final net.shibboleth.utilities.java.support.security.IdentifierGenerationStrategy idGenerator

Strategy used to generate identifiers.

Constructor Detail

GenerateIdStage

public GenerateIdStage()

Constructor. Initialized the idGenerator to a Type4UuidIdentifierGenerationStrategy.

GenerateIdStage

public GenerateIdStage(@Nonnull
                       net.shibboleth.utilities.java.support.security.IdentifierGenerationStrategy generator)

Constructor.

Parameters:

generator - ID generation strategy used

Method Detail

doExecute

protected boolean doExecute(@Nonnull
                            DomElementItem item)
                     throws StageProcessingException

Processes a given Item.

Specified by:

doExecute in class BaseIteratingStage<DomElementItem>

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