Package io.inversion

Class ApiException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.inversion.ApiException

All Implemented Interfaces:

Status, java.io.Serializable

public class ApiException
extends java.lang.RuntimeException
implements Status

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	status

Fields inherited from interface io.inversion.Status

SC_200_OK, SC_201_CREATED, SC_202_ACCEPTED, SC_204_NO_CONTENT, SC_307_TEMPORARY_REDIRECT, SC_308_PERMANENT_REDIRECT, SC_400_BAD_REQUEST, SC_401_UNAUTHORIZED, SC_403_FORBIDDEN, SC_404_NOT_FOUND, SC_409_CONFLICT, SC_429_TOO_MANY_REQUESTS, SC_500_INTERNAL_SERVER_ERROR, SC_501_NOT_IMPLEMENTED, SC_507_INSUFFICIENT_STORAGE, SC_599_NETWORK_CONNECT_TIMEPUT_ERROR

Constructor Summary

Constructors

Constructor	Description
ApiException()
ApiException(java.lang.String messageFormat, java.lang.Object... args)
ApiException(java.lang.Throwable cause)
ApiException(java.lang.Throwable cause, java.lang.String httpStatus, java.lang.String messageFormat, java.lang.Object... args)

Method Summary

Modifier and Type	Method	Description
static java.lang.String	getMessage(java.lang.Throwable cause, java.lang.String httpStatus, java.lang.String messageFormat, java.lang.Object... args)	Constructs a useful error message.
java.lang.String	getStatus()
int	getStatusCode()
boolean	hasStatus(int... statusCodes)
static ApiException	new400BadRequest()
static ApiException	new400BadRequest(java.lang.String messageFormat, java.lang.Object... args)
static ApiException	new400BadRequest(java.lang.Throwable cause)
static ApiException	new400BadRequest(java.lang.Throwable cause, java.lang.String messageFormat, java.lang.Object... args)
static ApiException	new401Unauthroized()
static ApiException	new401Unauthroized(java.lang.String messageFormat, java.lang.Object... args)
static ApiException	new401Unauthroized(java.lang.Throwable cause)
static ApiException	new401Unauthroized(java.lang.Throwable cause, java.lang.String messageFormat, java.lang.Object... args)
static ApiException	new403Forbidden()
static ApiException	new403Forbidden(java.lang.String messageFormat, java.lang.Object... args)
static ApiException	new403Forbidden(java.lang.Throwable cause)
static ApiException	new403Forbidden(java.lang.Throwable cause, java.lang.String messageFormat, java.lang.Object... args)
static ApiException	new404NotFound()
static ApiException	new404NotFound(java.lang.String messageFormat, java.lang.Object... args)
static ApiException	new404NotFound(java.lang.Throwable cause)
static ApiException	new404NotFound(java.lang.Throwable cause, java.lang.String messageFormat, java.lang.Object... args)
static ApiException	new429TooManyRequests()
static ApiException	new429TooManyRequests(java.lang.String messageFormat, java.lang.Object... args)
static ApiException	new429TooManyRequests(java.lang.Throwable cause)
static ApiException	new429TooManyRequests(java.lang.Throwable cause, java.lang.String messageFormat, java.lang.Object... args)
static ApiException	new500InternalServerError()
static ApiException	new500InternalServerError(java.lang.String messageFormat, java.lang.Object... args)
static ApiException	new500InternalServerError(java.lang.Throwable cause)
static ApiException	new500InternalServerError(java.lang.Throwable cause, java.lang.String messageFormat, java.lang.Object... args)
static ApiException	new501NotImplemented()
static ApiException	new501NotImplemented(java.lang.String messageFormat, java.lang.Object... args)
static ApiException	new501NotImplemented(java.lang.Throwable cause)
static ApiException	new501NotImplemented(java.lang.Throwable cause, java.lang.String messageFormat, java.lang.Object... args)
static void	throwEx(java.lang.String messageFormat, java.lang.Object... args)	Throws a "500 Internal Server Error" ApiException with the given message
static void	throwEx(java.lang.Throwable cause)	Rethrows cause as a "500 Internal Server Error" ApiException
static void	throwEx(java.lang.Throwable cause, java.lang.String status, java.lang.String messageFormat, java.lang.Object... args)
ApiException	withStatus(java.lang.String status)

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

Field Detail

status

protected java.lang.String status

Constructor Detail

ApiException

public ApiException()
             throws ApiException

Throws:

ApiException

ApiException

public ApiException(java.lang.Throwable cause)
             throws ApiException

Throws:

ApiException

ApiException

public ApiException(java.lang.String messageFormat,
                    java.lang.Object... args)
             throws ApiException

Throws:

ApiException

ApiException

public ApiException(java.lang.Throwable cause,
                    java.lang.String httpStatus,
                    java.lang.String messageFormat,
                    java.lang.Object... args)
             throws ApiException

Throws:

ApiException

Method Detail

getStatus

public java.lang.String getStatus()

withStatus

public ApiException withStatus(java.lang.String status)

hasStatus

public boolean hasStatus(int... statusCodes)

getStatusCode

public int getStatusCode()

getMessage

public static java.lang.String getMessage(java.lang.Throwable cause,
                                          java.lang.String httpStatus,
                                          java.lang.String messageFormat,
                                          java.lang.Object... args)

Constructs a useful error message.

All arguments are optional but if everything is null you will get an empty string.

Parameters:

cause - the cause of the error

httpStatus - the HTTP stats codde of the error

messageFormat - the caller supplied error message with variable placeholders

args - variables to insert into messageFormat

Returns:

a hopefully user friendly error message

See Also:

Utils.format(String, Object...)

throwEx

public static void throwEx(java.lang.Throwable cause)
                    throws ApiException

Rethrows cause as a "500 Internal Server Error" ApiException

Parameters:

cause - the cause of the error

Throws:

ApiException - always

throwEx

public static void throwEx(java.lang.String messageFormat,
                           java.lang.Object... args)
                    throws ApiException

Throws a "500 Internal Server Error" ApiException with the given message

Parameters:

messageFormat - the error message potentially with variables

args - values substituted into messageFormat

Throws:

ApiException - always

throwEx

public static void throwEx(java.lang.Throwable cause,
                           java.lang.String status,
                           java.lang.String messageFormat,
                           java.lang.Object... args)
                    throws ApiException

Throws:

ApiException

new400BadRequest

public static ApiException new400BadRequest()
                                     throws ApiException

Throws:

ApiException

new400BadRequest

public static ApiException new400BadRequest(java.lang.Throwable cause)
                                     throws ApiException

Throws:

ApiException

new400BadRequest

public static ApiException new400BadRequest(java.lang.String messageFormat,
                                            java.lang.Object... args)
                                     throws ApiException

Throws:

ApiException

new400BadRequest

public static ApiException new400BadRequest(java.lang.Throwable cause,
                                            java.lang.String messageFormat,
                                            java.lang.Object... args)
                                     throws ApiException

Throws:

ApiException

new401Unauthroized

public static ApiException new401Unauthroized()
                                       throws ApiException

Throws:

ApiException

new401Unauthroized

public static ApiException new401Unauthroized(java.lang.Throwable cause)
                                       throws ApiException

Throws:

ApiException

new401Unauthroized

public static ApiException new401Unauthroized(java.lang.String messageFormat,
                                              java.lang.Object... args)
                                       throws ApiException

Throws:

ApiException

new401Unauthroized

public static ApiException new401Unauthroized(java.lang.Throwable cause,
                                              java.lang.String messageFormat,
                                              java.lang.Object... args)
                                       throws ApiException

Throws:

ApiException

new403Forbidden

public static ApiException new403Forbidden()
                                    throws ApiException

Throws:

ApiException

new403Forbidden

public static ApiException new403Forbidden(java.lang.Throwable cause)
                                    throws ApiException

Throws:

ApiException

new403Forbidden

public static ApiException new403Forbidden(java.lang.String messageFormat,
                                           java.lang.Object... args)
                                    throws ApiException

Throws:

ApiException

new403Forbidden

public static ApiException new403Forbidden(java.lang.Throwable cause,
                                           java.lang.String messageFormat,
                                           java.lang.Object... args)
                                    throws ApiException

Throws:

ApiException

new404NotFound

public static ApiException new404NotFound()
                                   throws ApiException

Throws:

ApiException

new404NotFound

public static ApiException new404NotFound(java.lang.Throwable cause)
                                   throws ApiException

Throws:

ApiException

new404NotFound

public static ApiException new404NotFound(java.lang.String messageFormat,
                                          java.lang.Object... args)
                                   throws ApiException

Throws:

ApiException

new404NotFound

public static ApiException new404NotFound(java.lang.Throwable cause,
                                          java.lang.String messageFormat,
                                          java.lang.Object... args)
                                   throws ApiException

Throws:

ApiException

new429TooManyRequests

public static ApiException new429TooManyRequests()
                                          throws ApiException

Throws:

ApiException

new429TooManyRequests

public static ApiException new429TooManyRequests(java.lang.Throwable cause)
                                          throws ApiException

Throws:

ApiException

new429TooManyRequests

public static ApiException new429TooManyRequests(java.lang.String messageFormat,
                                                 java.lang.Object... args)
                                          throws ApiException

Throws:

ApiException

new429TooManyRequests

public static ApiException new429TooManyRequests(java.lang.Throwable cause,
                                                 java.lang.String messageFormat,
                                                 java.lang.Object... args)
                                          throws ApiException

Throws:

ApiException

new500InternalServerError

public static ApiException new500InternalServerError()
                                              throws ApiException

Throws:

ApiException

new500InternalServerError

public static ApiException new500InternalServerError(java.lang.Throwable cause)
                                              throws ApiException

Throws:

ApiException

new500InternalServerError

public static ApiException new500InternalServerError(java.lang.String messageFormat,
                                                     java.lang.Object... args)
                                              throws ApiException

Throws:

ApiException

new500InternalServerError

public static ApiException new500InternalServerError(java.lang.Throwable cause,
                                                     java.lang.String messageFormat,
                                                     java.lang.Object... args)
                                              throws ApiException

Throws:

ApiException

new501NotImplemented

public static ApiException new501NotImplemented()
                                         throws ApiException

Throws:

ApiException

new501NotImplemented

public static ApiException new501NotImplemented(java.lang.Throwable cause)
                                         throws ApiException

Throws:

ApiException

new501NotImplemented

public static ApiException new501NotImplemented(java.lang.String messageFormat,
                                                java.lang.Object... args)
                                         throws ApiException

Throws:

ApiException

new501NotImplemented

public static ApiException new501NotImplemented(java.lang.Throwable cause,
                                                java.lang.String messageFormat,
                                                java.lang.Object... args)
                                         throws ApiException

Throws:

ApiException