authn/exceptions/RestAuthResponseException.java

	RestAuthResponseException.java revision 41c1067de1a5fa74255d311e5362548ae41f9a04
/*
 * 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 copyright [year] [name of copyright owner]".
 *
 * Copyright 2013-2014 ForgeRock AS.
 */

package org.forgerock.openam.forgerockrest.authn.exceptions;

import org.forgerock.json.fluent.JsonValue;

import java.util.Map;

/**
 * This exception is thrown by any of the RestAuthCallbackHandlers for it to return its own Http Response.
 */
public class RestAuthResponseException extends RestAuthException {

    private final int statusCode;
    private Map<String, String> responseHeaders;
    private JsonValue jsonResponse;

    /**
     * Constructs a RestAuthResponseException.
     *
     * @param statusCode The Http Status of the response.
     * @param responseHeaders A Map of the header key value pairs for the response.
     * @param jsonResponse The JSON object for the response body.
     */
    public RestAuthResponseException(final int statusCode,
            final Map<String, String> responseHeaders, final JsonValue jsonResponse) {
        super(statusCode, jsonResponse.toString());
        this.statusCode = statusCode;
        this.responseHeaders = responseHeaders;
        this.jsonResponse = jsonResponse;
    }

    public int getStatusCode() {
        return statusCode;
    }

    /**
     * Gets the Map of header key value pairs.
     *
     * @return response headers.
     */
    public Map<String, String> getResponseHeaders() {
        return responseHeaders;
    }

    /**
     * Gets the JSON object for the response body.
     *
     * @return The response JSON body.
     */
    public JsonValue getJsonResponse() {
        return jsonResponse;
    }
}