net.shibboleth.metadata.dom.saml
Class SetValidUntilStage

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

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

@ThreadSafe
public class SetValidUntilStage
extends BaseIteratingStage<DomElementItem>

Sets a validUntil attribute for every EntityDescriptor and EntitiesDescriptor element in the collection.

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

• validityDuration

Field Summary

private long

validityDuration Amount of time the descriptors will be valid, expressed in milliseconds.

Constructor Summary

SetValidUntilStage()

Method Summary

protected boolean	doExecute(DomElementItem item) Processes a given Item.
protected void	doInitialize()
long	getValidityDuration() Gets the amount of time the descriptors will be valid, expressed in milliseconds.
void	setValidityDuration(long duration) Sets the amount of time the descriptors will be valid, expressed in milliseconds.

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

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

validityDuration

private long validityDuration

Amount of time the descriptors will be valid, expressed in milliseconds.

Constructor Detail

SetValidUntilStage

public SetValidUntilStage()

Method Detail

getValidityDuration

public long getValidityDuration()

Gets the amount of time the descriptors will be valid, expressed in milliseconds.

Returns:

amount of time the descriptors will be valid, expressed in milliseconds

setValidityDuration

public void setValidityDuration(long duration)

Sets the amount of time the descriptors will be valid, expressed in milliseconds.

Parameters:

duration - amount of time the descriptors will be valid, expressed in milliseconds

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

doInitialize

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

Overrides:

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

Throws:

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