org.forgerock.openam.sts.tokengeneration.saml2.statements

Interface AttributeMapper

public interface AttributeMapper

Defines the concerns of mapping attributes into SAML2 AttributeStatements. The AttributeStatementsProvider implementation will return a list of AttributeStatements. Only a single AttributeMapper will be provided to the AttributeStatementsProvider, and the attributeMap specification will be pulled from the SAML2Config associated with the STS instance currently consuming the TokenGenerationService.

Method Summary

Modifier and Type	Method and Description
List<Attribute>	getAttributes(SSOToken token, Map<String,String> attributeMap) Gets a list of populated SAML2 Attribute instances.

Method Detail

getAttributes

List<Attribute> getAttributes(SSOToken token,
                              Map<String,String> attributeMap)
                       throws TokenCreationException

Gets a list of populated SAML2 Attribute instances.

Parameters:

token - The SSOToken corresponding to the subject whose attributes will be referenced.

attributeMap - Contains the mapping of saml attribute names (Map keys) to local OpenAM attributes (Map values) in various stores. The DefaultAttributeMapper looks at profile attributes in various places: LDAP or SQL, depending on data store setup, or in Session properties. The keys will define the name of the attributes included in the Assertion Attribute statements, and the data pulled from the subject's directory entry or session state corresponding to the map value will define the value corresponding to this attribute name. If no state is present corresponding to this attribute value, then it will not appear in the AttributeStatement.

Returns:

This list of populated SAML2 Attribute instances. If the list is empty, no AttributeStatement should be created.

Throws:

TokenCreationException - if an exception is encountered mapping attributes. exceptions?