net.shibboleth.idp.saml.nameid

Interface PersistentIdStore

public interface PersistentIdStore

Storage and retrieval interface for SAML persistent IDs.

Method Summary

Methods

Modifier and Type	Method and Description
void	deactivate(String persistentId, DateTime deactivation) Deactivate a persistent ID.
PersistentIdEntry	getActiveEntry(String persistentId) Get the active persistent ID entry for a given ID.
PersistentIdEntry	getActiveEntry(String issuer, String recipient, String sourceId) Get the active persistent ID entry for an (issuer, recipient, source ID) tuple.
int	getCount(String issuer, String recipient, String sourceId) Get the count of persistent ID entries for a (principal, issuer, source ID) tuple.
boolean	isAvailable(String persistentId) Get whether a persistent ID is not in use, active or otherwise.
void	store(PersistentIdEntry entry) Store a persistent ID.

Method Detail

isAvailable

boolean isAvailable(@Nonnull@NotEmpty
                  String persistentId)
                    throws IOException

Get whether a persistent ID is not in use, active or otherwise.

Parameters:

persistentId - the ID to check

Returns:

true iff the ID is available for use

Throws:

IOException - if an error occurs accessing the store

store

void store(@Nonnull
         PersistentIdEntry entry)
           throws IOException

Store a persistent ID.

Parameters:

entry - entry to store

Throws:

IOException - if there is an error updating the store

getCount

int getCount(@Nonnull@NotEmpty
           String issuer,
           @Nonnull@NotEmpty
           String recipient,
           @Nonnull@NotEmpty
           String sourceId)
             throws IOException

Get the count of persistent ID entries for a (principal, issuer, source ID) tuple.

Parameters:

issuer - entityID of the ID issuer

recipient - entityID of the recipient the ID is for

sourceId - source ID underlying the persistent ID

Returns:

the number of identifiers

Throws:

IOException - if an error occurs accessing the store

getActiveEntry

@Nullable
PersistentIdEntry getActiveEntry(@Nonnull@NotEmpty
                                        String persistentId)
                                 throws IOException

Get the active persistent ID entry for a given ID.

Parameters:

persistentId - the persistent ID to lookup

Returns:

entry for the given ID or null if none exists

Throws:

IOException - if an error occurs accessing the store

getActiveEntry

@Nullable
PersistentIdEntry getActiveEntry(@Nonnull@NotEmpty
                                        String issuer,
                                        @Nonnull@NotEmpty
                                        String recipient,
                                        @Nonnull@NotEmpty
                                        String sourceId)
                                 throws IOException

Get the active persistent ID entry for an (issuer, recipient, source ID) tuple.

Parameters:

issuer - entityID of the ID issuer

recipient - entityID of the recipient the ID is for

sourceId - source ID underlying the persistent ID

Returns:

the active identifier

Throws:

IOException - if an error occurs accessing the store

deactivate

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

Deactivate a persistent ID.

Parameters:

persistentId - ID to deactivate

deactivation - deactivation time, if null the current time is used

Throws:

IOException - if there is an error updating the store