org.sourceid.saml20.service
Interface PseudonymService

All Known Implementing Classes:
PseudonymServiceMapImpl, PseudonymServiceSha1Impl

public interface PseudonymService

Defines the method needed by PingFederate to lookup/generate a pseudonym (opaque user id) for a subject. Please see the SAML specification for particular details and rules about pseudonym (persistent id) formats and usage.

Note that this interface is utilized only when you have PingFederate configured as an IdP and one or more SP connections configured to receive pseudonyms as subject identifiers.

Author:
Brian Campbell

Method Summary
 java.lang.String getPseudonym(java.lang.String localIdentification, java.lang.String spEntityId, boolean allowCreate)
          Looks up or generates of derives the pseudonym for the given subject for use in the context of the given SP.
 

Method Detail

getPseudonym

java.lang.String getPseudonym(java.lang.String localIdentification,
                              java.lang.String spEntityId,
                              boolean allowCreate)
                              throws PseudonymServiceException
Looks up or generates of derives the pseudonym for the given subject for use in the context of the given SP.

Parameters:
localIdentification - a string representation of the local identity of the subject.
spEntityId - the entityId of the SP partner connection with whom this pseudonym will be used.
allowCreate - passed though from the protocol message. The value of this attribute is only advisory and can be ignored.
Returns:
an opaque user identifer (repeated calls with the same values for localIdentification and spEntityId should return the same value).
Throws:
PseudonymServiceException - for any unexpected runtime problem that the implementation cannot handle.


Copyright 2007 Ping Identity Corp. All rights reserved.