com.contentful.java.cma.model

Class CMAHttpException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.contentful.java.cma.model.CMAHttpException

All Implemented Interfaces:

Serializable

public class CMAHttpException
extends RuntimeException

This class will represent known Contentful exceptions

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	HEADER_RATE_LIMIT_HOUR_LIMIT
static String	HEADER_RATE_LIMIT_HOUR_REMAINING
static String	HEADER_RATE_LIMIT_RESET
static String	HEADER_RATE_LIMIT_SECOND_LIMIT
static String	HEADER_RATE_LIMIT_SECOND_REMAINING

Constructor Summary

Constructors

Constructor and Description
CMAHttpException(okhttp3.Request request, okhttp3.Response response) Construct an error response.

Method Summary

Modifier and Type	Method and Description
int	rateLimitHourLimit()
int	rateLimitHourRemaining()
int	rateLimitReset()
int	rateLimitSecondLimit()
int	rateLimitSecondRemaining()
int	responseCode()
String	responseMessage()
String	toString() Convert exception to human readable form.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

HEADER_RATE_LIMIT_HOUR_LIMIT

public static final String HEADER_RATE_LIMIT_HOUR_LIMIT

See Also:

Constant Field Values

HEADER_RATE_LIMIT_HOUR_REMAINING

public static final String HEADER_RATE_LIMIT_HOUR_REMAINING

See Also:

Constant Field Values

HEADER_RATE_LIMIT_SECOND_LIMIT

public static final String HEADER_RATE_LIMIT_SECOND_LIMIT

See Also:

Constant Field Values

HEADER_RATE_LIMIT_SECOND_REMAINING

public static final String HEADER_RATE_LIMIT_SECOND_REMAINING

See Also:

Constant Field Values

HEADER_RATE_LIMIT_RESET

public static final String HEADER_RATE_LIMIT_RESET

See Also:

Constant Field Values

Constructor Detail

CMAHttpException

public CMAHttpException(okhttp3.Request request,
                        okhttp3.Response response)

Construct an error response.

This constructor will fill the exception with easy accessible values, like responseCode(). responseMessage(), but also rateLimitReset().

Parameters:

request - the request issuing the error.

response - the response from the server to this faulty request.

Method Detail

toString

public String toString()

Convert exception to human readable form.

Overrides:

toString in class Throwable

Returns:

a string representing this exception.

responseCode

public int responseCode()

Returns:

the response code of the request.

responseMessage

public String responseMessage()

Returns:

the message the server returned.

rateLimitHourLimit

public int rateLimitHourLimit()

Returns:

the hourly rate limit or -1 if header not send

rateLimitHourRemaining

public int rateLimitHourRemaining()

Returns:

the number of remaining requests that can be made in the hour or -1 if header not send

rateLimitSecondLimit

public int rateLimitSecondLimit()

Returns:

the per second rate limit or -1 if header not send

rateLimitSecondRemaining

public int rateLimitSecondRemaining()

Returns:

the number of remaining requests that can be made per second or -1 if header not send

rateLimitReset

public int rateLimitReset()

Returns:

the number of seconds until the user can make a next request or -1 if header not send