001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2015 ForgeRock AS.
015 */
016
017package org.forgerock.json.resource;
018
019import org.forgerock.json.JsonValue;
020import org.forgerock.util.promise.Promise;
021
022/**
023 * Response object for JSON responses.
024 */
025public interface ActionResponse extends Response {
026
027    /**
028     * Gets the {@code JsonValue} content contained in the {@code Response}.
029     *
030     * @return The {@code JsonValue} response content.
031     */
032    JsonValue getJsonContent();
033
034    /**
035     * Return this response as a result Promise.
036     *
037     * @return A Promise whose result is this ActionResponse object.
038     */
039    Promise<ActionResponse, ResourceException> asPromise();
040}