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.http.routing.Version;
20
21 /**
22 * Common response object of all resource responses.
23 */
24 public interface Response {
25
26 /**
27 * Sets the API version of the resource that the request was routed to.
28 *
29 * @param version The resource API version.
30 */
31 void setResourceApiVersion(Version version);
32
33 /**
34 * Gets the API version of the resource that the request was routed to.
35 *
36 * @return The resource API version.
37 */
38 Version getResourceApiVersion();
39 }