Package com.sun.identity.saml.plugins

Interface PartnerAccountMapper

All Known Implementing Classes:

DefaultPartnerAccountMapper, NameIDPartnerAccountMapper

public interface PartnerAccountMapper

The class PartnerAccountMapper is an interface that is implemented to map partner account to user account in OpenAM.

Different partner would need to have a different implementation of the interface. The mappings between the partner source ID and the implementation class are configured at the Partner URLs field in SAML service.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTRIBUTE	Key to hold attributes to be set as session properties.
static String	NAME	Key to hold user DN in returned map
static String	ORG	Key to hold organization DN in returned map

Method Summary

Modifier and Type	Method	Description
Map	getUser(SubjectQuery subjectQuery, String sourceID)	Returns user account in OpenAM to which the subject in the query is mapped.
Map	getUser(List assertions, String sourceID, String targetURL)	Returns user account in OpenAM to which the subject in the assertion is mapped.

Field Detail

NAME

static final String NAME

Key to hold user DN in returned map

See Also:

Constant Field Values

ORG

static final String ORG

Key to hold organization DN in returned map

See Also:

Constant Field Values

ATTRIBUTE

static final String ATTRIBUTE

Key to hold attributes to be set as session properties.

See Also:

Constant Field Values

Method Detail

getUser

Map getUser(List assertions,
            String sourceID,
            String targetURL)

Returns user account in OpenAM to which the subject in the assertion is mapped. This method will be called in POST profile, ARTIFACT profile, AttributeQuery and AuthorizationDecisionQuery.

Parameters:

assertions - a list of authentication assertions returned from partner side, this will contains user's identity in the partner side. The object in the list will be com.sun.identity.saml.assertion.Assertion

sourceID - source ID for the site from which the subject originated.

targetURL - value for TARGET query parameter when the user accessing the SAML aware servlet or post profile servlet.

Returns:

Map which contains NAME, ORG and ATTRIBUTE keys, value of the NAME key is the user DN, value of the ORG is the user organization DN, value of the ATTRIBUTE is a Map containing key/value pairs which will be set as properties on the OpenAM SSO token, the key is the SSO property name, the value is a String value of the property. Returns empty map if the mapped user could not be obtained from the subject.

getUser

Map getUser(SubjectQuery subjectQuery,
            String sourceID)

Returns user account in OpenAM to which the subject in the query is mapped. This method will be called in AttributeQuery.

Parameters:

subjectQuery - subject query returned from partner side, this will contains user's identity in the partner side.

sourceID - source ID for the site from which the subject originated.

Returns:

Map which contains NAME and ORG keys, value of the NAME key is the user DN, value of the ORG is the user organization DN. Returns empty map if the mapped user could not be obtained from the subject.