RestSTS.java revision e6d7ebe1d98f7f030969e521b061f8643253475e
/*
* 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-2014 ForgeRock AS. All rights reserved.
*/
/**
* This is the top-level interface invoked directly by the REST-STS resource. Each of the methods defined in this interface
* will correlate to the top-level operations defined in the REST-STS. Currently, the single top-level operation is
* the TokenTranslateOperation. If we decide that the REST-STS implement issue/cancel/validate/renew operations like
* the WS-Trust STS, method definitions corresponding to this functionality would be added to this interface.
*/
public interface RestSTS {
/**
*
* @param invocationState An object encapsulating the input and output token state specifications
* @param httpContext The HttpContext
* @param securityContext The SecurityContex
* @return A JsonValue with a 'issued_token' key and the value corresponding to the issued token
* @throws TokenValidationException if the input token could not be validated
* @throws TokenCreationException if the desired token could not be produced
*/
}