com.sun.identity.saml2.plugins
Interface 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.

See Also:

SPAccountMapper

Method Summary

java.lang.String	getIdentity(ManageNameIDRequest manageNameIDRequest, java.lang.String hostEntityID, java.lang.String realm) Returns the user's disntinguished name or the universal ID for the corresponding SAML ManageNameIDRequest.
NameID	getNameID(com.iplanet.sso.SSOToken ssoToken, java.lang.String hostEntityID, java.lang.String remoteEntityID) Returns the user's NameIDinformation that contains account federation with the corresponding remote and local entities.

Method Detail

getNameID

public NameID getNameID(com.iplanet.sso.SSOToken ssoToken,
                        java.lang.String hostEntityID,
                        java.lang.String remoteEntityID)
                 throws SAML2Exception

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

Parameters:

ssoToken - Single Sign On Token of the user.

hostEntityID - EntityID of the hosted provider.

remoteEntityID - EntityID of the remote provider.

Returns:

the NameID corresponding to the authenticated user.

Throws:

SAML2Exception - if any failure.

getIdentity

public java.lang.String getIdentity(ManageNameIDRequest manageNameIDRequest,
                                    java.lang.String hostEntityID,
                                    java.lang.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.

Parameters:

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.

Returns:

user's disntinguished name or the universal ID.

Throws:

SAML2Exception - if any failure.