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 and Description
protected java.lang.String	status

Fields inherited from interface io.inversion.Status

SC_200_OK, SC_201_CREATED, SC_204_NO_CONTENT, SC_308_PERMANENT_REDIRECT, SC_400_BAD_REQUEST, SC_401_UNAUTHORIZED, SC_403_FORBIDDEN, SC_404_NOT_FOUND, SC_429_TOO_MANY_REQUESTS, SC_500_INTERNAL_SERVER_ERROR, SC_501_NOT_IMPLEMENTED

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getMessage(java.lang.String httpStatus, java.lang.Throwable cause, java.lang.String messageFormat, java.lang.Object... args) Supports error message construction including variable replacement supporting logging framework "{}" placesholders OR java.util.Formatter style placeholders.
java.lang.String	getStatus()
boolean	hasStatus(int... statusCodes)
static void	throw400BadRequest()
static void	throw400BadRequest(java.lang.String messageFormat, java.lang.Object... messages)
static void	throw400BadRequest(java.lang.Throwable cause)
static void	throw400BadRequest(java.lang.Throwable cause, java.lang.String messageFormat, java.lang.Object... messages)
static void	throw401Unauthroized()
static void	throw401Unauthroized(java.lang.String messageFormat, java.lang.Object... messages)
static void	throw401Unauthroized(java.lang.Throwable cause)
static void	throw401Unauthroized(java.lang.Throwable cause, java.lang.String messageFormat, java.lang.Object... messages)
static void	throw403Forbidden()
static void	throw403Forbidden(java.lang.String messageFormat, java.lang.Object... messages)
static void	throw403Forbidden(java.lang.Throwable cause)
static void	throw403Forbidden(java.lang.Throwable cause, java.lang.String messageFormat, java.lang.Object... messages)
static void	throw404NotFound()
static void	throw404NotFound(java.lang.String messageFormat, java.lang.Object... messages)
static void	throw404NotFound(java.lang.Throwable cause)
static void	throw404NotFound(java.lang.Throwable cause, java.lang.String messageFormat, java.lang.Object... messages)
static void	throw429TooManyRequests()
static void	throw429TooManyRequests(java.lang.String messageFormat, java.lang.Object... messages)
static void	throw429TooManyRequests(java.lang.Throwable cause)
static void	throw429TooManyRequests(java.lang.Throwable cause, java.lang.String messageFormat, java.lang.Object... messages)
static void	throw500InternalServerError()
static void	throw500InternalServerError(java.lang.String messageFormat, java.lang.Object... args)
static void	throw500InternalServerError(java.lang.Throwable cause)
static void	throw500InternalServerError(java.lang.Throwable cause, java.lang.String messageFormat, java.lang.Object... args)
static void	throw501NotImplemented()
static void	throw501NotImplemented(java.lang.String messageFormat, java.lang.Object... args)
static void	throw501NotImplemented(java.lang.Throwable cause)
static void	throw501NotImplemented(java.lang.Throwable cause, java.lang.String messageFormat, java.lang.Object... args)
static void	throwEx(java.lang.String messageFormat, java.lang.Object... messages) Throws a 500 INTERNAL SERVER ERROR ApiException with the given message
static void	throwEx(java.lang.String status, java.lang.Throwable cause, java.lang.String messageFormat, java.lang.Object... args)
static void	throwEx(java.lang.Throwable cause) Rethrows cause as a 500 INTERNAL SERVER ERROR ApiException
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 httpStatus)
             throws ApiException

Throws:

ApiException

ApiException

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

Throws:

ApiException

ApiException

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

Throws:

ApiException

Method Detail

getMessage

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

Supports error message construction including variable replacement supporting logging framework "{}" placesholders OR java.util.Formatter style placeholders.

Any "{}" substrings in messageFormat are replaced with "{}" before messageFormat and args are passed to a java.util.Formatter.

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

Parameters:

httpStatus -

cause -

messageFormat -

args -

Returns:

getStatus

public java.lang.String getStatus()

withStatus

public ApiException withStatus(java.lang.String status)

hasStatus

public boolean hasStatus(int... statusCodes)

throw400BadRequest

public static void throw400BadRequest()
                               throws ApiException

Throws:

ApiException

throw400BadRequest

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

Throws:

ApiException

throw400BadRequest

public static void throw400BadRequest(java.lang.String messageFormat,
                                      java.lang.Object... messages)
                               throws ApiException

Throws:

ApiException

throw400BadRequest

public static void throw400BadRequest(java.lang.Throwable cause,
                                      java.lang.String messageFormat,
                                      java.lang.Object... messages)
                               throws ApiException

Throws:

ApiException

throw401Unauthroized

public static void throw401Unauthroized()
                                 throws ApiException

Throws:

ApiException

throw401Unauthroized

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

Throws:

ApiException

throw401Unauthroized

public static void throw401Unauthroized(java.lang.String messageFormat,
                                        java.lang.Object... messages)
                                 throws ApiException

Throws:

ApiException

throw401Unauthroized

public static void throw401Unauthroized(java.lang.Throwable cause,
                                        java.lang.String messageFormat,
                                        java.lang.Object... messages)
                                 throws ApiException

Throws:

ApiException

throw403Forbidden

public static void throw403Forbidden()
                              throws ApiException

Throws:

ApiException

throw403Forbidden

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

Throws:

ApiException

throw403Forbidden

public static void throw403Forbidden(java.lang.String messageFormat,
                                     java.lang.Object... messages)
                              throws ApiException

Throws:

ApiException

throw403Forbidden

public static void throw403Forbidden(java.lang.Throwable cause,
                                     java.lang.String messageFormat,
                                     java.lang.Object... messages)
                              throws ApiException

Throws:

ApiException

throw404NotFound

public static void throw404NotFound()
                             throws ApiException

Throws:

ApiException

throw404NotFound

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

Throws:

ApiException

throw404NotFound

public static void throw404NotFound(java.lang.String messageFormat,
                                    java.lang.Object... messages)
                             throws ApiException

Throws:

ApiException

throw404NotFound

public static void throw404NotFound(java.lang.Throwable cause,
                                    java.lang.String messageFormat,
                                    java.lang.Object... messages)
                             throws ApiException

Throws:

ApiException

throw429TooManyRequests

public static void throw429TooManyRequests()
                                    throws ApiException

Throws:

ApiException

throw429TooManyRequests

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

Throws:

ApiException

throw429TooManyRequests

public static void throw429TooManyRequests(java.lang.String messageFormat,
                                           java.lang.Object... messages)
                                    throws ApiException

Throws:

ApiException

throw429TooManyRequests

public static void throw429TooManyRequests(java.lang.Throwable cause,
                                           java.lang.String messageFormat,
                                           java.lang.Object... messages)
                                    throws ApiException

Throws:

ApiException

throw500InternalServerError

public static void throw500InternalServerError()
                                        throws ApiException

Throws:

ApiException

throw500InternalServerError

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

Throws:

ApiException

throw500InternalServerError

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

Throws:

ApiException

throw500InternalServerError

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

Throws:

ApiException

throw501NotImplemented

public static void throw501NotImplemented()
                                   throws ApiException

Throws:

ApiException

throw501NotImplemented

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

Throws:

ApiException

throw501NotImplemented

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

Throws:

ApiException

throw501NotImplemented

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

Throws:

ApiException

throwEx

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

Rethrows cause as a 500 INTERNAL SERVER ERROR ApiException

Parameters:

cause -

Throws:

ApiException

throwEx

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

Throws a 500 INTERNAL SERVER ERROR ApiException with the given message

Parameters:

messageFormat -

messages -

Throws:

ApiException

throwEx

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

Throws:

ApiException