net.shibboleth.idp.saml.nameid.impl

Interface PersistentIdStoreEx

All Superinterfaces:

IPersistentIdStore

All Known Implementing Classes:

JDBCPersistentIdStoreEx

public interface PersistentIdStoreEx
extends IPersistentIdStore

Storage and retrieval interface for SAML persistent IDs redesigned to support appropriately atomic behavior.

Method Summary

Methods

Modifier and Type	Method and Description
void	attach(String nameQualifier, String spNameQualifier, String persistentId, String spProvidedId) Attach an SPProvidedID value to an existing entry.
void	deactivate(String nameQualifier, String spNameQualifier, String persistentId, DateTime deactivation) Deactivate/revoke a persistent ID.
PersistentIdEntry	getByIssuedValue(String nameQualifier, String spNameQualifier, String persistentId) Get the PersistentIdEntry for a previously issued ID triple.
PersistentIdEntry	getBySourceValue(String nameQualifier, String spNameQualifier, String sourceId, String principal, boolean allowCreate, ComputedPersistentIdGenerationStrategy computedIdStrategy) Get the PersistentIdEntry for a given subject and audience, creating one if allowable and necessary.

Method Detail

getByIssuedValue

@Nullable
PersistentIdEntry getByIssuedValue(@Nonnull@NotEmpty
                                          String nameQualifier,
                                          @Nonnull@NotEmpty
                                          String spNameQualifier,
                                          @Nonnull@NotEmpty
                                          String persistentId)
                                   throws IOException

Get the PersistentIdEntry for a previously issued ID triple.

Parameters:

nameQualifier - the NameQualifier value

spNameQualifier - the SPNameQualifier value

persistentId - the persistent ID value

Returns:

PersistentIdEntry for the given inputs or null if none exists

Throws:

IOException - if an error occurs accessing the store

getBySourceValue

@Nullable
PersistentIdEntry getBySourceValue(@Nonnull@NotEmpty
                                          String nameQualifier,
                                          @Nonnull@NotEmpty
                                          String spNameQualifier,
                                          @Nonnull@NotEmpty
                                          String sourceId,
                                          @Nonnull@NotEmpty
                                          String principal,
                                          boolean allowCreate,
                                          @Nullable
                                          ComputedPersistentIdGenerationStrategy computedIdStrategy)
                                   throws IOException

Get the PersistentIdEntry for a given subject and audience, creating one if allowable and necessary.

Parameters:

nameQualifier - the NameQualifier value

spNameQualifier - the SPNameQualifier value

sourceId - source attribute underlying the persistent ID

principal - principal name of subject (may or may not be the same as the sourceId)

allowCreate - whether it's permissible to establish/issue a new identifier

computedIdStrategy - optional source of initial computed IDs for compatibilty with that mechanism

Returns:

PersistentIdEntry for the given inputs, or null if none exists and allowCreate is false

Throws:

IOException - if an error occurs accessing the store

deactivate

void deactivate(@Nonnull@NotEmpty
              String nameQualifier,
              @Nonnull@NotEmpty
              String spNameQualifier,
              @Nonnull@NotEmpty
              String persistentId,
              @Nullable
              DateTime deactivation)
                throws IOException

Deactivate/revoke a persistent ID.

Parameters:

nameQualifier - the NameQualifier value

spNameQualifier - the SPNameQualifier value

persistentId - ID to deactivate

deactivation - deactivation time (if null the current time is used)

Throws:

IOException - if there is an error updating the store

attach

void attach(@Nonnull@NotEmpty
          String nameQualifier,
          @Nonnull@NotEmpty
          String spNameQualifier,
          @Nonnull@NotEmpty
          String persistentId,
          @Nonnull@NotEmpty
          String spProvidedId)
            throws IOException

Attach an SPProvidedID value to an existing entry.

Parameters:

nameQualifier - the NameQualifier value

spNameQualifier - the SPNameQualifier value

persistentId - ID to deactivate

spProvidedId - the value to attach

Throws:

IOException - if there is an error updating the store