View Javadoc
1   /*
2    * The contents of this file are subject to the terms of the Common Development and
3    * Distribution License (the License). You may not use this file except in compliance with the
4    * License.
5    *
6    * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
7    * specific language governing permission and limitations under the License.
8    *
9    * When distributing Covered Software, include this CDDL Header Notice in each file and include
10   * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
11   * Header, with the fields enclosed by brackets [] replaced by your own identifying
12   * information: "Portions copyright [year] [name of copyright owner]".
13   *
14   * Copyright 2015 ForgeRock AS.
15   */
16  
17  package org.forgerock.json.resource;
18  
19  import org.forgerock.json.JsonValue;
20  import org.forgerock.util.promise.Promise;
21  
22  /**
23   * Response object for JSON responses.
24   */
25  public interface ActionResponse extends Response {
26  
27      /**
28       * Gets the {@code JsonValue} content contained in the {@code Response}.
29       *
30       * @return The {@code JsonValue} response content.
31       */
32      JsonValue getJsonContent();
33  
34      /**
35       * Return this response as a result Promise.
36       *
37       * @return A Promise whose result is this ActionResponse object.
38       */
39      Promise<ActionResponse, ResourceException> asPromise();
40  }