net.shibboleth.idp.saml.nameid.impl

Class StoredPersistentIdGenerationStrategy

java.lang.Object

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

net.shibboleth.idp.saml.nameid.impl.StoredPersistentIdGenerationStrategy

All Implemented Interfaces:

PersistentIdGenerationStrategy, Component, DestructableComponent, InitializableComponent

public class StoredPersistentIdGenerationStrategy
extends AbstractInitializableComponent
implements PersistentIdGenerationStrategy

Manages persistent IDs via a PersistentIdStore, generating them either randomly or via a ComputedPersistentIdGenerationStrategy (for compatibility with existing data).

Field Summary

Fields

Modifier and Type	Field and Description
private ComputedPersistentIdGenerationStrategy	computedIdStrategy Optional generator of computed ID values.
private DataSource	dataSource A DataSource to auto-provision a JDBCPersistentIdStoreEx instance.
private PersistentIdStore	deprecatedStore Deprecated version of persistent identifier data store.
private org.slf4j.Logger	log Class logger.
private PersistentIdStoreEx	pidStore Updated version of persistent identifier data store layer.

Constructor Summary

Constructors

Constructor and Description
StoredPersistentIdGenerationStrategy()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInitialize()
String	generate(String assertingPartyId, String relyingPartyId, String principalName, String sourceId) Get a Persistent ID that corresponds to the inputs.
void	setComputedIdStrategy(ComputedPersistentIdGenerationStrategy strategy) Set a strategy to use to compute IDs for the first time.
void	setDataSource(DataSource source) Set a data source to inject into an auto-provisioned instance of JDBCPersistentIdStoreEx to use as the storage strategy.
void	setIDStore(IPersistentIdStore store) Set an IPersistentIdStore used to store the IDs.

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

destroy, doDestroy, 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.

pidStore

@NonnullAfterInit
private PersistentIdStoreEx pidStore

Updated version of persistent identifier data store layer.

dataSource

@Nullable
private DataSource dataSource

A DataSource to auto-provision a JDBCPersistentIdStoreEx instance.

deprecatedStore

@Nullable
private PersistentIdStore deprecatedStore

Deprecated version of persistent identifier data store.

computedIdStrategy

@Nullable
private ComputedPersistentIdGenerationStrategy computedIdStrategy

Optional generator of computed ID values.

Constructor Detail

StoredPersistentIdGenerationStrategy

public StoredPersistentIdGenerationStrategy()

Method Detail

setIDStore

public void setIDStore(@Nullable
              IPersistentIdStore store)

Set an IPersistentIdStore used to store the IDs.

The marker interface is used, allowing injection of either the broken or the updated version of the interface.

Parameters:

store - the ID store to use

setDataSource

public void setDataSource(@Nullable
                 DataSource source)

Set a data source to inject into an auto-provisioned instance of JDBCPersistentIdStoreEx to use as the storage strategy.

Parameters:

source - the data source

setComputedIdStrategy

public void setComputedIdStrategy(@Nullable
                         ComputedPersistentIdGenerationStrategy strategy)

Set a strategy to use to compute IDs for the first time.

Parameters:

strategy - computed ID strategy

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

generate

@Nonnull
@NotEmpty
public String generate(@Nonnull@NotEmpty
                               String assertingPartyId,
                               @Nonnull@NotEmpty
                               String relyingPartyId,
                               @Nonnull@NotEmpty
                               String principalName,
                               @Nonnull@NotEmpty
                               String sourceId)
                throws org.opensaml.saml.common.SAMLException

Get a Persistent ID that corresponds to the inputs.

This may be generated directly from the inputs or retrieved from some other source.

Specified by:

generate in interface PersistentIdGenerationStrategy

Parameters:

assertingPartyId - the asserting party providing the identifier

relyingPartyId - the relying party for whom we're obtaining the identifier

principalName - name of the subject

sourceId - an underlying identifier for the subject

Returns:

the identifier

Throws:

org.opensaml.saml.common.SAMLException - if an error occurs generating the identifier