retrofit

Class MockHttpException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

retrofit.MockHttpException

All Implemented Interfaces:

Serializable

public class MockHttpException
extends RuntimeException

An exception used to trigger the simulation of an HTTP error for mock services.

See Also:

MockRestAdapter, Serialized Form

Constructor Summary

Constructors

Constructor and Description
MockHttpException(int code, String reason, Object responseBody) Create a new HTTP exception.

Method Summary

Modifier and Type	Method and Description
static MockHttpException	newBadRequest(Object responseBody) Create a new MockHttpException for HTTP 400 Bad Request.
static MockHttpException	newForbidden(Object responseBody) Create a new MockHttpException for HTTP 403 Forbidden.
static MockHttpException	newInternalError(Object responseBody) Create a new MockHttpException for HTTP 500 Internal Server Error.
static MockHttpException	newMovedPermanentely(String location, Object responseBody) Create a new MockHttpException for HTTP 301 Moved Permanently.
static MockHttpException	newMovedTemporarily(String location, Object responseBody) Create a new MockHttpException for HTTP 302 Moved Temporarily.
static MockHttpException	newNotFound(Object responseBody) Create a new MockHttpException for HTTP 404 Not Found.
static MockHttpException	newUnauthorized(Object responseBody) Create a new MockHttpException for HTTP 401 Unauthorized.
MockHttpException	withHeader(String name, String value) Add a header to the response.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, 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

MockHttpException

public MockHttpException(int code,
                         String reason,
                         Object responseBody)

Create a new HTTP exception.

Parameters:

code - HTTP status code to trigger. Must be 300 or higher.

reason - HTTP status reason message.

responseBody - Object to use as the contents of the response body.

Method Detail

newMovedPermanentely

public static MockHttpException newMovedPermanentely(String location,
                                                     Object responseBody)

Create a new MockHttpException for HTTP 301 Moved Permanently.

newMovedTemporarily

public static MockHttpException newMovedTemporarily(String location,
                                                    Object responseBody)

Create a new MockHttpException for HTTP 302 Moved Temporarily.

newBadRequest

public static MockHttpException newBadRequest(Object responseBody)

Create a new MockHttpException for HTTP 400 Bad Request.

newUnauthorized

public static MockHttpException newUnauthorized(Object responseBody)

Create a new MockHttpException for HTTP 401 Unauthorized.

newForbidden

public static MockHttpException newForbidden(Object responseBody)

Create a new MockHttpException for HTTP 403 Forbidden.

newNotFound

public static MockHttpException newNotFound(Object responseBody)

Create a new MockHttpException for HTTP 404 Not Found.

newInternalError

public static MockHttpException newInternalError(Object responseBody)

Create a new MockHttpException for HTTP 500 Internal Server Error.

withHeader

public MockHttpException withHeader(String name,
                                    String value)

Add a header to the response.