com.opsmatters.newrelic.api.exceptions.ErrorResponseException Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of newrelic-api Show documentation

Java client library for the New Relic REST APIs built using Jersey and Gson. The library includes over 110 operations across all of the available 35 New Relic services. It can be used by applications to automate the configuration of New Relic Monitoring, Alerting and Dashboards, but can also be used for extracting incident and metric data, executing Insights queries, and uploading plugin metrics.

There is a newer version: 1.0.12

Show newest version

/*
 * Copyright 2018 Gerald Curley
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.opsmatters.newrelic.api.exceptions;

import com.opsmatters.newrelic.api.model.ErrorResponse;

/**
 * Exception thrown when a REST API returns an error response.
 * 
 * @author Gerald Curley (opsmatters)
 */
public class ErrorResponseException extends RuntimeException
{
    private String method;
    private int status;
    private String reason;
    private ErrorResponse error;

    /**
     * Constructor that takes a method, status, reason and error response.
     * @param method The HTTP method
     * @param status The HTTP status code
     * @param reason The HTTP reason phrase
     * @param error The REST API error object
     */
    public ErrorResponseException(String method, int status, String reason, ErrorResponse error)
    {
        this(method+" returned response "+status+" "+reason
            +(error != null && error.hasError() ? " ("+error+")" : ""));

        this.method = method;
        this.status = status;
        this.reason = reason;
        this.error = error;
    }

    /**
     * Constructor that takes a method, status and reason.
     * @param method The HTTP method
     * @param status The HTTP status code
     * @param reason The HTTP reason phrase
     */
    public ErrorResponseException(String method, int status, String reason)
    {
        this(method, status, reason, null);
    }

    /**
     * Constructor that takes an error message.
     * @param message The error message
     */
    public ErrorResponseException(String message)
    {
        super(message);
    }

    /**
     * Returns the HTTP method.
     * @return The HTTP method
     */
    public String getMethod()
    {
        return method;
    }

    /**
     * Returns the HTTP status code.
     * @return The HTTP status code
     */
    public int getStatus()
    {
        return status;
    }

    /**
     * Returns the HTTP reason phrase.
     * @return The HTTP reason phrase
     */
    public String getReasonPhrase()
    {
        return reason;
    }

    /**
     * Returns the REST API error object.
     * @return The REST API error object
     */
    public ErrorResponse getErrorResponse()
    {
        return error;
    }
}