com.newrelic.api.agent.Response Maven / Gradle / Ivy

Go to download

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

New Relics's Java Api Jar.

There is a newer version: 8.16.0

/*
 *
 *  * Copyright 2020 New Relic Corporation. All rights reserved.
 *  * SPDX-License-Identifier: Apache-2.0
 *
 */

package com.newrelic.api.agent;

/**
 * Represents a response to a web request.
 * 
 * The implementation of this interface does not need to be servlet specific, but the API is based on the servlet spec.
 *
 * @see NewRelic#setRequestAndResponse(Request, Response)
 * @deprecated since 3.41.0; use {@link com.newrelic.api.agent.ExtendedResponse} instead.
 */
public interface Response extends OutboundHeaders {
    /**
     * Returns the status code for this response.
     * 
     * @return The status code.
     * @throws Exception Problem getting the status.
     * @since 2.3.0
     */
    int getStatus() throws Exception;

    /**
     * Returns the error status message, or null if there is none.
     * 
     * @return The error status message.
     * @throws Exception Problem getting status message.
     * @since 2.3.0
     */
    String getStatusMessage() throws Exception;

    /**
     * Returns the response content type, or null if it is not available.
     * 
     * @return The response content type or null if it is not available.
     * @since 2.3.0
     */
    String getContentType();
}