IDFFNameIdentifierMapper (OpenAM Project 16.0.0-SNAPSHOT API)

java.lang.Object
- com.sun.identity.liberty.ws.disco.plugins.IDFFNameIdentifierMapper

All Implemented Interfaces:

NameIdentifierMapper
```
public class IDFFNameIdentifierMapper
extends Object
implements NameIdentifierMapper
```
The class IDFFNameIdentifierMapper is an implementation of NameIdentifierMapper for Liberty ID-FF providers.

Constructor Summary

Constructors
Constructor Description

IDFFNameIdentifierMapper()

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IDFFNameIdentifierMapper
```
public IDFFNameIdentifierMapper()
```
- Method Detail
  - getNameIdentifier
```
public 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 will be returned if the mapped NameIdentifier is different from the original NameIdentifier, this is to prevent the NameIdentifier to be revealed to a proxy service provider.
    
    Specified by:
    
    getNameIdentifier in interface NameIdentifierMapper
    
    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 mapp the NameIdentifier.