Package com.sun.identity.liberty.ws.disco.plugins

Interface NameIdentifierMapper

All Known Implementing Classes:

IDFFNameIdentifierMapper

public interface NameIdentifierMapper

The class NameIdentifierMapper is an interface that is used to map user's NameIdentifier from one provider to another.

Method Summary

Modifier and Type	Method	Description
NameIdentifier	getNameIdentifier(String spProviderID, String idpProviderID, NameIdentifier nameId, String userID)	Returns mapped NameIdentifier for specified user.

Method Detail

getNameIdentifier

NameIdentifier getNameIdentifier(String spProviderID,
                                 String idpProviderID,
                                 NameIdentifier nameId,
                                 String userID)

Returns mapped NameIdentifier for specified user. This is used by Discovery Service to generate correct NameIdentifier when creating credentials for remote service provider. A NameIdentifier in encrypted format could be returned if the response will be passed through a proxy.

Parameters:

spProviderID - Provider ID of the service provider to which the NameIdentifier needs to be mapped.

idpProviderID - Provider ID of the identifier provider.

nameId - The NameIdentifier needs to be mapped.

userID - The user whose mapped NameIdentifier will be returned. The value is the universal identifier of the user.

Returns:

the mapped NameIdentifier for specified user, return null if unable to map the NameIdentifier, return original name identifier if no need to map the NameIdentifier.