Package com.sun.identity.liberty.ws.interfaces

Interface ResourceIDMapper

All Known Implementing Classes:

Default64ResourceIDMapper, DefaultHexResourceIDMapper, IDPPResourceIDMapper

public interface ResourceIDMapper

The class ResourceIDMapper is an interface that is used to map between an userID and the ResourceID associated with it.

A different implementation of the interface may be developed by different service provider. The implementation class(s) should be given to the provider that hosts discovery service. The mapping between the providerID and the implementation class can be configured through the Class for ResourceID Mapper Plugin field in Discovery service.

Method Summary

Modifier and Type	Method	Description
String	getResourceID(String providerID, String userID)	Returns the resource ID that is associated with the user in a provider.
String	getUserID(String providerID, String resourceID)	Returns the ID of the user who has the resource ID in a provider.
String	getUserID(String providerID, String resourceID, Message message)	Returns the ID of the user who has the resource ID in a provider.

Method Detail

getResourceID

String getResourceID(String providerID,
                     String userID)

Returns the resource ID that is associated with the user in a provider.

Parameters:

providerID - ID of the provider.

userID - ID of the user.

Returns:

resource ID. Return null if the resource ID cannot be found.

getUserID

String getUserID(String providerID,
                 String resourceID)

Returns the ID of the user who has the resource ID in a provider.

Parameters:

providerID - ID of the provider.

resourceID - ID of the resource.

Returns:

user ID. Return null if the user is not found.

getUserID

String getUserID(String providerID,
                 String resourceID,
                 Message message)

Returns the ID of the user who has the resource ID in a provider.

Parameters:

providerID - ID of the provider.

resourceID - ID of the resource.

message - Request message.

Returns:

user ID. Return null if the user is not found.