org.forgerock.openam.sts.tokengeneration.saml2

Interface StatementProvider

All Known Implementing Classes:

StatementProviderImpl

public interface StatementProvider

Defines the interface referenced by the SAML2TokenGeneration implementation to obtain the providers of the various SAML2 assertion statements. The implementation of this method will return an instance of the *Provider specified in the SAML2Config, and if no custom *Provider is specified, an instance of the Default*Provider will be returned.

Method Summary

Modifier and Type	Method and Description
AttributeMapper	getAttributeMapper(SAML2Config saml2Config)
AttributeStatementsProvider	getAttributeStatementsProvider(SAML2Config saml2Config)
AuthenticationStatementsProvider	getAuthenticationStatementsProvider(SAML2Config saml2Config)
AuthzDecisionStatementsProvider	getAuthzDecisionStatementsProvider(SAML2Config saml2Config)
ConditionsProvider	getConditionsProvider(SAML2Config saml2Config)
SubjectProvider	getSubjectProvider(SAML2Config saml2Config)

Method Detail

getConditionsProvider

ConditionsProvider getConditionsProvider(SAML2Config saml2Config)
                                  throws TokenCreationException

Parameters:

saml2Config - The SAML2Config corresponding to the STS instance consuming the TokenGenerationService

Returns:

The ConditionsProvider instance which will be invoked to obtain the Conditions included in the generated SAML2 assertion

Throws:

TokenCreationException

getSubjectProvider

SubjectProvider getSubjectProvider(SAML2Config saml2Config)
                            throws TokenCreationException

Parameters:

saml2Config - The SAML2Config corresponding to the STS instance consuming the TokenGenerationService

Returns:

The SubjectProvider instance which will be invoked to obtain the Subject included in the generated SAML2 assertion

Throws:

TokenCreationException

getAuthenticationStatementsProvider

AuthenticationStatementsProvider getAuthenticationStatementsProvider(SAML2Config saml2Config)
                                                              throws TokenCreationException

Parameters:

saml2Config - The SAML2Config corresponding to the STS instance consuming the TokenGenerationService

Returns:

The AuthenticationStatementsProvider instance which will be invoked to obtain the AuthenticationStatements included in the generated SAML2 assertion

Throws:

TokenCreationException

getAttributeStatementsProvider

AttributeStatementsProvider getAttributeStatementsProvider(SAML2Config saml2Config)
                                                    throws TokenCreationException

Parameters:

saml2Config - The SAML2Config corresponding to the STS instance consuming the TokenGenerationService

Returns:

The AttributeStatementsProvider instance which will be invoked to obtain the AttributeStatements included in the generated SAML2 assertion

Throws:

TokenCreationException

getAuthzDecisionStatementsProvider

AuthzDecisionStatementsProvider getAuthzDecisionStatementsProvider(SAML2Config saml2Config)
                                                            throws TokenCreationException

Parameters:

saml2Config - The SAML2Config corresponding to the STS instance consuming the TokenGenerationService

Returns:

The AuthzDecisionStatementsProvider instance which will be invoked to obtain the AuthzDecisionStatements included in the generated SAML2 assertion

Throws:

TokenCreationException

getAttributeMapper

AttributeMapper getAttributeMapper(SAML2Config saml2Config)
                            throws TokenCreationException

Parameters:

saml2Config - The SAML2Config corresponding to the STS instance consuming the TokenGenerationService

Returns:

The AttributeMapper instance which will be invoked to obtain the Attributes included in the generated SAML2 assertion

Throws:

TokenCreationException