org.opensaml.saml.common.binding.artifact.impl

Class BasicSAMLArtifactMap

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

org.opensaml.saml.common.binding.artifact.impl.BasicSAMLArtifactMap

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, SAMLArtifactMap

public class BasicSAMLArtifactMap
extends AbstractInitializableComponent
implements SAMLArtifactMap

Basic artifact map implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BasicSAMLArtifactMap.Cleanup A cleanup task that relies on the weakly consistent iterator support in the map implementation.

Nested classes/interfaces inherited from interface org.opensaml.saml.common.binding.artifact.SAMLArtifactMap

SAMLArtifactMap.SAMLArtifactMapEntry, SAMLArtifactMap.SAMLArtifactMapEntryFactory

Field Summary

Fields

Modifier and Type	Field and Description
private long	artifactLifetime Lifetime of an artifact in milliseconds.
private Map<String,ExpiringSAMLArtifactMapEntry>	artifactStore Artifact mapping storage.
private long	cleanupInterval Number of seconds between cleanup checks.
private TimerTask	cleanupTask Task that cleans up expired records.
private Timer	cleanupTaskTimer Timer used to schedule cleanup tasks.
private SAMLArtifactMap.SAMLArtifactMapEntryFactory	entryFactory Factory for SAMLArtifactMapEntry instances.
private org.slf4j.Logger	log Class Logger.

Constructor Summary

Constructors

Constructor and Description
BasicSAMLArtifactMap() Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	contains(String artifact)
protected void	doDestroy()
protected void	doInitialize()
SAMLArtifactMap.SAMLArtifactMapEntry	get(String artifact)
long	getArtifactLifetime() Get the artifact entry lifetime in milliseconds.
SAMLArtifactMap.SAMLArtifactMapEntryFactory	getEntryFactory() Get the map entry factory.
void	put(String artifact, String relyingPartyId, String issuerId, SAMLObject samlMessage)
void	remove(String artifact)
void	setArtifactLifetime(long lifetime) Set the artifact entry lifetime in milliseconds.
void	setCleanupInterval(long interval) Set the cleanup interval in milliseconds, or 0 for none.
void	setEntryFactory(SAMLArtifactMap.SAMLArtifactMapEntryFactory factory) Set the map entry factory.

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

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class Logger.

artifactStore

@NonnullAfterInit
private Map<String,ExpiringSAMLArtifactMapEntry> artifactStore

Artifact mapping storage.

artifactLifetime

@Duration
 @Positive
private long artifactLifetime

Lifetime of an artifact in milliseconds.

entryFactory

@Nonnull
private SAMLArtifactMap.SAMLArtifactMapEntryFactory entryFactory

Factory for SAMLArtifactMapEntry instances.

cleanupInterval

@Duration
 @NonNegative
private long cleanupInterval

Number of seconds between cleanup checks. Default value: (300)

cleanupTaskTimer

@NonnullAfterInit
private Timer cleanupTaskTimer

Timer used to schedule cleanup tasks.

cleanupTask

@Nullable
private TimerTask cleanupTask

Task that cleans up expired records.

Constructor Detail

BasicSAMLArtifactMap

public BasicSAMLArtifactMap()

Constructor.

Method Detail

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class AbstractInitializableComponent

getArtifactLifetime

@Positive
public long getArtifactLifetime()

Get the artifact entry lifetime in milliseconds.

Returns:

the artifact entry lifetime in milliseconds

getEntryFactory

@Nonnull
public SAMLArtifactMap.SAMLArtifactMapEntryFactory getEntryFactory()

Get the map entry factory.

Returns:

the map entry factory

setArtifactLifetime

@Duration
public void setArtifactLifetime(@Duration @Positive
                                          long lifetime)

Set the artifact entry lifetime in milliseconds.

Parameters:

lifetime - artifact entry lifetime in milliseconds

setCleanupInterval

@Duration
public void setCleanupInterval(@Duration @NonNegative
                                         long interval)

Set the cleanup interval in milliseconds, or 0 for none.

Parameters:

interval - cleanup interval in milliseconds

setEntryFactory

public void setEntryFactory(@Nonnull
                            SAMLArtifactMap.SAMLArtifactMapEntryFactory factory)

Set the map entry factory.

Parameters:

factory - map entry factory

contains

public boolean contains(@Nonnull @NotEmpty
                        String artifact)
                 throws IOException

Specified by:

contains in interface SAMLArtifactMap

Throws:

IOException

get

@Nullable
public SAMLArtifactMap.SAMLArtifactMapEntry get(@Nonnull @NotEmpty
                                                          String artifact)
                                                   throws IOException

Specified by:

get in interface SAMLArtifactMap

Throws:

IOException

put

public void put(@Nonnull @NotEmpty
                String artifact,
                @Nonnull @NotEmpty
                String relyingPartyId,
                @Nonnull @NotEmpty
                String issuerId,
                @Nonnull
                SAMLObject samlMessage)
         throws IOException

Specified by:

put in interface SAMLArtifactMap

Throws:

IOException

remove

public void remove(@Nonnull @NotEmpty
                   String artifact)
            throws IOException

Specified by:

remove in interface SAMLArtifactMap

Throws:

IOException