com.contrastsecurity.exceptions

Class HttpResponseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.contrastsecurity.exceptions.ContrastException

com.contrastsecurity.exceptions.HttpResponseException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ResourceNotFoundException, UnauthorizedException

public class HttpResponseException
extends ContrastException

Thrown when the Contrast API returns a response that indicates an error has occurred. Captures the HTTP status line and body.

Typically, HTTP status codes in the 4XX and 5XX ranges indicate an error; however, in some legacy cases, the Contrast API may return a successful status code (e.g. 200) with an error body. In this case, the Contrast Java SDK still throws this exception.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HttpResponseException(java.lang.String message, java.lang.String method, java.lang.String path, int code, java.lang.String status) Constructor.
HttpResponseException(java.lang.String message, java.lang.String method, java.lang.String path, int code, java.lang.String status, java.lang.String body) Constructor.

Method Summary

Modifier and Type	Method and Description
static HttpResponseException	fromConnection(java.net.HttpURLConnection connection, java.lang.String message) Static factory method that captures the status line and body of the given HttpURLConnection to create a new exception.
java.lang.String	getBody()
int	getCode()
java.lang.String	getMessage()
java.lang.String	getStatus()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HttpResponseException

public HttpResponseException(java.lang.String message,
                             java.lang.String method,
                             java.lang.String path,
                             int code,
                             java.lang.String status)

Constructor.

Parameters:

message - error message provided by the caller

method - HTTP method used in the request

path - HTTP path from the request

code - code from the status line e.g. 400

status - message from the status line e.g. Bad Request

HttpResponseException

public HttpResponseException(java.lang.String message,
                             java.lang.String method,
                             java.lang.String path,
                             int code,
                             java.lang.String status,
                             java.lang.String body)

Constructor.

Parameters:

message - error message provided by the caller

method - HTTP method used in the request

path - HTTP path from the request

code - code from the status line e.g. 400

status - message from the status line e.g. Bad Request

body - the body of the response, or null if there is no such body

Throws:

java.lang.NullPointerException - when message, method, or path are null

Method Detail

fromConnection

public static HttpResponseException fromConnection(java.net.HttpURLConnection connection,
                                                   java.lang.String message)
                                            throws java.io.IOException

Static factory method that captures the status line and body of the given HttpURLConnection to create a new exception.

Parameters:

connection - connection from which to derive status line and body information

message - error message provided by the caller

Returns:

new HttpResponseException

Throws:

java.io.IOException - when fails to read the status line or body of the response

getCode

public int getCode()

Returns:

code from the status line e.g. 400

getStatus

public java.lang.String getStatus()

Returns:

message from the status line e.g. Bad Request, or null if no such status line exists

getBody

public java.lang.String getBody()

Returns:

the body of the response, or null if there is no such body

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable