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

Interface AttributeStatementsProvider

public interface AttributeStatementsProvider

Defines the concerns of generating the AttributeStatement list to be included in the SAML2 assertion. If no custom class is specified in the SAML2Config, then the DefaultAttributeStatementsProvider will be used.

Method Summary

Modifier and Type	Method and Description
List<AttributeStatement>	get(SSOToken ssoToken, SAML2Config saml2Config, AttributeMapper attributeMapper) Invoked to obtain the List of AttributeStatement instances to be included in the generated SAML2 assertion.

Method Detail

get

List<AttributeStatement> get(SSOToken ssoToken,
                             SAML2Config saml2Config,
                             AttributeMapper attributeMapper)
                      throws TokenCreationException

Invoked to obtain the List of AttributeStatement instances to be included in the generated SAML2 assertion.

Parameters:

ssoToken - The SSOToken corresponding to asserted subject

saml2Config - The STS-instance-specific SAML2 configurations

attributeMapper - The AttributeMapper implementation which will map attributes. If the AttributeMapper cannot map any attributes, then an empty list should be returned.

Returns:

The list of AttributeStatement instances containing the mapped attributes, or an empty list, if no attributes could be mapped.

Throws:

TokenCreationException - If there was an error while creating the AttributeStatements.