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

Interface SubjectProvider

@SupportedAll
public interface SubjectProvider

Defines the concerns of providing the Subject to be included in the generated SAML2 assertion. If no custom class name is specified in the SAML2Config, then the DefaultSubjectProvider will be used.

Method Summary

Modifier and Type	Method	Description
Subject	get(String subjectId, String audienceId, SAML2Config saml2Config, SAML2SubjectConfirmation subjectConfirmation, Date assertionIssueInstant, ProofTokenState proofTokenState)	Called to obtain the Subject instance to be included in the generated SAML2 assertion

Method Detail

get

Subject get(String subjectId,
            String audienceId,
            SAML2Config saml2Config,
            SAML2SubjectConfirmation subjectConfirmation,
            Date assertionIssueInstant,
            ProofTokenState proofTokenState)
     throws TokenCreationException

Called to obtain the Subject instance to be included in the generated SAML2 assertion

Parameters:

subjectId - The identifier for the subject

audienceId - Used to set the recipient in the SubjectConfirmationData

saml2Config - The STS-instance specific SAML2 configuration state

subjectConfirmation - The type of subject confirmation

assertionIssueInstant - The issue instant assertion

proofTokenState - The instance containing the proof token necessary for HoK assertions.

Returns:

The to-be-included Subject instance

Throws:

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