/*
 * 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 2013-2015 ForgeRock AS.
 */

package org.forgerock.openam.sts.rest.operation.translate;

import org.forgerock.services.context.Context;
import org.forgerock.json.JsonValue;
import org.forgerock.openam.sts.TokenCreationException;
import org.forgerock.openam.sts.TokenMarshalException;
import org.forgerock.openam.sts.TokenValidationException;
import org.forgerock.openam.sts.user.invocation.RestSTSTokenTranslationInvocationState;

/**
 * This class is the analogue to the Token{Issue/Validate/Renew/Cancel}Operation instances plugged-into the CXF-STS.
 * It is a 'top-level' operation, invoked directly by the implementation of the RestSTS.validateToken method.
 * It may be that other 'top-level' interfaces will be defined, corresponding to resful analogues of the
 * {Issue/Validate/Renew/Cancel} operations defined in WS-Trust.
 */
public interface TokenTranslateOperation {
    /**
     *
     * @param invocationState The invocationState, as generated by the caller, containing the input and output token
     *                        specifications
     * @param context The HttpContext
     * @return A JsonValue with a 'issued_token' key and the value corresponding to the issued token
     * @throws TokenMarshalException if the token state corresponding to the input and output tokens were incorrect
     * @throws TokenValidationException if the input token could not be successfully validated
     * @throws TokenCreationException if the output token could not be successfully produced
     */
    JsonValue translateToken(RestSTSTokenTranslationInvocationState invocationState,
                             Context context)
            throws TokenMarshalException, TokenValidationException, TokenCreationException;
}
