com.sun.identity.saml2.plugins
インタフェース IDPAccountMapper

public interface IDPAccountMapper

The interface IDPAccountMapper is used to map the local identities to the SAML protocol objects and also the vice versa for some of the protocols for e.g. ManageNameIDRequest. This mapper interface is used to map the identities only at the SAMLAssertionProducer, in otherwords, SAML Provider as an IdentityProvider. The implementation of this interface will be used by the SAML framework to retrieve the user's account federation information for the constructing SAML protocol objects such as Assertion and also to find out the corresponding user account for the given SAML requests. The implementation of this interface may need to consider the deployment of the SAMLv2 plugin for example the AccessManger platform or the FederationManager platform.

関連項目:

SPAccountMapper

メソッドの概要

String	getIdentity(ManageNameIDRequest manageNameIDRequest, String hostEntityID, String realm) Returns the user's disntinguished name or the universal ID for the corresponding SAML ManageNameIDRequest.
String	getIdentity(NameID nameID, String hostEntityID, String remoteEntityID, String realm) Returns the user's disntinguished name or the universal ID for the corresponding SAML NameID.
NameID	getNameID(Object session, String hostEntityID, String remoteEntityID, String realm, String nameIDFormat) Returns the user's NameIDinformation that contains account federation with the corresponding remote and local entities.

メソッドの詳細

getNameID

NameID getNameID(Object session,
                 String hostEntityID,
                 String remoteEntityID,
                 String realm,
                 String nameIDFormat)
                 throws SAML2Exception

Returns the user's NameIDinformation that contains account federation with the corresponding remote and local entities.

パラメータ:

session - Single Sign On session of the user.

hostEntityID - EntityID of the hosted provider.

remoteEntityID - EntityID of the remote provider.

realm - realm or the organization name that may be used to find the user information.

nameIDFormat - NameID format.

戻り値:

the NameID corresponding to the authenticated user.

例外:

SAML2Exception - if any failure.

getIdentity

String getIdentity(ManageNameIDRequest manageNameIDRequest,
                   String hostEntityID,
                   String realm)
                   throws SAML2Exception

Returns the user's disntinguished name or the universal ID for the corresponding SAML ManageNameIDRequest. This method returns the universal ID or the DN based on the deployment of the SAMLv2 plugin base platform.

パラメータ:

manageNameIDRequest - SAML ManageNameIDRequest that needs to be mapped to the user.

hostEntityID - EntityID of the hosted provider.

realm - realm or the organization name that may be used to find the user information.

戻り値:

user's disntinguished name or the universal ID.

例外:

SAML2Exception - if any failure.

getIdentity

String getIdentity(NameID nameID,
                   String hostEntityID,
                   String remoteEntityID,
                   String realm)
                   throws SAML2Exception

Returns the user's disntinguished name or the universal ID for the corresponding SAML NameID. This method returns the universal ID or the DN based on the deployment of the SAMLv2 plugin base platform.

パラメータ:

nameID - SAML NameID that needs to be mapped to the user.

hostEntityID - EntityID of the hosted provider.

remoteEntityID - EntityID of the remote provider.

realm - realm or the organization name that may be used to find the user information.

戻り値:

user's disntinguished name or the universal ID.

例外:

SAML2Exception - if any failure.