/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions Copyrighted [year] [name of copyright owner]".
 *
 * Copyright 2014-2015 ForgeRock AS.
 */

package org.forgerock.openam.sts.tokengeneration.saml2;

import com.iplanet.sso.SSOToken;
import org.forgerock.openam.sts.TokenCreationException;
import org.forgerock.openam.sts.service.invocation.TokenGenerationServiceInvocationState;
import org.forgerock.openam.sts.tokengeneration.state.STSInstanceState;

/**
 * This interface defines the concerns of SAML2TokenGeneration, as exposed by the TokenGenerationService, and consumed by
 * published STS instances, both REST and SOAP.
 *
 * The implementation of this interface will consult the SAML2Config of the STSInstanceConfig referenced in the invocation
 * to determine if any custom statement providers have been registered with the published STS.
 *
 */
public interface SAML2TokenGeneration {
    /**
     *
     * @param subjectToken The SSOToken authenticating the identity of the subject of the assertion
     * @param stsInstanceState The STS-instance-specific state necessary to generate the assertion
     * @param invocationState The parameters with which the TokenGenerationService was invoked.
     * @return The String representation of the assertion
     * @throws TokenCreationException
     */
    String generate(SSOToken subjectToken, STSInstanceState stsInstanceState,
                    TokenGenerationServiceInvocationState invocationState) throws TokenCreationException;
}
