Package com.sun.identity.saml2.plugins

Interface SPAttributeMapper

@SupportedAll
public interface SPAttributeMapper

This interface SPAttributeMapper is used to map the SAML Attributes to the local user attributes. This mapper will be used by the Service Provider that will read the configured map for the corresponding SAML attributes and supply to the SAML framework. The locally mapped attributes returned by the implementation of this interface will be used by the SAML2 framework to expose through the single sign-on token to the application. Also, the implementation of this mapper may need to consider the deployment of the SAML v2 plugin base platform for example AccessManager or the FederationManager.

See Also:

IDPAttributeMapper

Method Summary

Modifier and Type	Method	Description
Map<String,Set<String>>	getAttributes(List<Attribute> attributes, String userID, String hostEntityID, String remoteEntityID, String realm)	Returns the map of user attribute values for the corresponding SAML Attributes.

Method Detail

getAttributes

Map<String,Set<String>> getAttributes(List<Attribute> attributes,
                                            String userID,
                                            String hostEntityID,
                                            String remoteEntityID,
                                            String realm)
                                     throws SAML2Exception

Returns the map of user attribute values for the corresponding SAML Attributes. This attribute value pair map will be expose by the SAML framework via the Single Sign On Token.

Parameters:

attributes - list of SAML Attributes.

userID - Universal identifier of the user. May be null if the local account is not yet linked.

hostEntityID - EntityID of the hosted provider.

remoteEntityID - EntityID of the remote provider.

realm - The realm where the hosted provider belongs to.

Returns:

map of AttributeValuePairs for the given SAML Attribute list.

Throws:

SAML2Exception - if any failure.