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 Identity Server 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
 java.util.List getAttributes(AttributeQuery query, java.lang.String sourceID, SSOToken token)
          Returns Attributes for the user.
 Assertion getSSOAssertion(AttributeQuery query)
          Returns the Assertion that contains Authentication information that can be used to obtain SSOToken.
 java.lang.String getSSOTokenID(AttributeQuery query)
          Returns the SSOToken id to Identity Server from the query.
 

Method Detail

getSSOTokenID

public java.lang.String getSSOTokenID(AttributeQuery query)
Returns the SSOToken id to Identity Server from the query.
Parameters:
query - The received AttributeQuery.
Returns:
String which is the SSOTOken ID.

getSSOAssertion

public Assertion getSSOAssertion(AttributeQuery query)
Returns the Assertion that contains Authentication information that can be used to obtain SSOToken.
Parameters:
query - The received AttributeQuery.
Returns:
Assertion The assertion contained inside the query.

getAttributes

public java.util.List getAttributes(AttributeQuery query,
                                    java.lang.String sourceID,
                                    SSOToken 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 - The SSOToken to be used to retreive the attributes
Returns:
A List of Attributes
Throws:
SAMLException - if an error occurs