net.shibboleth.idp.saml.nameid.impl

Interface PersistentIdGenerationStrategy

All Known Implementing Classes:

ComputedPersistentIdGenerationStrategy, StoredPersistentIdGenerationStrategy

public interface PersistentIdGenerationStrategy

Generates and manages persistent identifiers according to specific strategies.

Method Summary

Methods

Modifier and Type	Method and Description
String	generate(String assertingPartyId, String relyingPartyId, String principalName, String sourceId) Get a Persistent ID that corresponds to the inputs.

Method Detail

generate

@Nonnull
@NotEmpty
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.

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