com.sun.identity.saml.plugins

Interface AttributeMapper

public interface AttributeMapper

The class AttributeMapper is an interface that is implemented to get SSO information and map partner attributes to OpenAM attributes.

A different implementation of the interface may be developed for different partner. The mapping between the partner source ID and the implementation class are configured at the Trusted Partner Sites field in SAML service.

Method Summary

Modifier and Type	Method and Description
List	getAttributes(AttributeQuery query, String sourceID, Object token) Returns Attributes for the user.
Assertion	getSSOAssertion(AttributeQuery query) Returns the Assertion that contains Authentication information that can be used to obtain single sign on token.
String	getSSOTokenID(AttributeQuery query) Returns the single sign on token ID to OpenAM from the query.

Method Detail

getSSOTokenID

String getSSOTokenID(AttributeQuery query)

Returns the single sign on token ID to OpenAM from the query.

Parameters:

query - The received AttributeQuery.

Returns:

String which is the single sign on token ID.

getSSOAssertion

Assertion getSSOAssertion(AttributeQuery query)

Returns the Assertion that contains Authentication information that can be used to obtain single sign on token.

Parameters:

query - The received AttributeQuery.

Returns:

Assertion The assertion contained inside the query.

getAttributes

List getAttributes(AttributeQuery query,
                   String sourceID,
                   Object token)
            throws SAMLException

Returns Attributes for the user.

Parameters:

query - The received AttributeQuery.

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

token - User' session to retrieve the attributes.

Returns:

A List of Attributes

Throws:

SAMLException - if an error occurs