org.osgl.mvc.result

Class ErrorResult

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.osgl.exception.FastRuntimeException

org.osgl.mvc.result.Result

org.osgl.mvc.result.ErrorResult

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BadGateway, BadRequest, Conflict, ExpectationFailed, Forbidden, GatewayTimeout, Gone, InternalServerError, MethodNotAllowed, NotAcceptable, NotFound, NotImplemented, PaymentRequired, PreconditionRequired, RequestTimeout, ServerError, ServiceUnavailable, TooManyRequests, Unauthorized, UnavailableForLegalReasons, UnsupportedMediaType

public class ErrorResult
extends Result

Base class for Error results, i.e result with status code between 400 and 600 (excluded)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.osgl.mvc.result.Result

Result.Payload

Constructor Summary

Constructors

Constructor and Description
ErrorResult(org.osgl.http.H.Status status)
ErrorResult(org.osgl.http.H.Status status, Integer errorCode)
ErrorResult(org.osgl.http.H.Status status, Integer errorCode, String message)
ErrorResult(org.osgl.http.H.Status status, Integer errorCode, String message, Object... args)
ErrorResult(org.osgl.http.H.Status status, Integer errorCode, Throwable cause)
ErrorResult(org.osgl.http.H.Status status, Integer errorCode, Throwable cause, String message, Object... args)
ErrorResult(org.osgl.http.H.Status status, String message)
ErrorResult(org.osgl.http.H.Status status, String message, Object... args)
ErrorResult(org.osgl.http.H.Status status, Throwable cause)
ErrorResult(org.osgl.http.H.Status status, Throwable cause, String message, Object... args)

Method Summary

Modifier and Type	Method and Description
protected static boolean	_localizedErrorMsg()
protected void	applyMessage(org.osgl.http.H.Request request, org.osgl.http.H.Response response)
ErrorResult	attach(Object attachment)
<T> T	attachment()
<T> T	attachment(Class<T> type)
protected static String	defaultMessage(org.osgl.http.H.Status status)
Integer	errorCode()
ErrorResult	errorCode(int errorCode)
String	getLocalizedMessage()
static ErrorResult	of(org.osgl.http.H.Status status)
static ErrorResult	of(org.osgl.http.H.Status status, int errorCode)
static ErrorResult	of(org.osgl.http.H.Status status, int errorCode, String message, Object... args)
static ErrorResult	of(org.osgl.http.H.Status status, int errorCode, Throwable cause)
static ErrorResult	of(org.osgl.http.H.Status status, int errorCode, Throwable cause, String message, Object... args)
static ErrorResult	of(org.osgl.http.H.Status status, String message, Object... args)
static ErrorResult	of(org.osgl.http.H.Status status, Throwable cause, String message, Object... args)
String	toJsonString()
org.osgl.util.KVStore	toKVStore() Export the error result data into a KVStore
String	toString()

Methods inherited from class org.osgl.mvc.result.Result

addCookie, addHeader, apply, applyAfterCommitHandler, applyBeforeCommitHandler, applyCookies, applyHeaders, applyStatus, clearThreadLocals, header, payload, status, status, statusCode, timestamp, touchPayload

Methods inherited from class org.osgl.exception.FastRuntimeException

doFillInStackTrace, fillInStackTrace

Methods inherited from class java.lang.Throwable

addSuppressed, getCause, 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

Constructor Detail

ErrorResult

public ErrorResult(org.osgl.http.H.Status status)

ErrorResult

public ErrorResult(org.osgl.http.H.Status status,
                   String message)

ErrorResult

public ErrorResult(org.osgl.http.H.Status status,
                   String message,
                   Object... args)

ErrorResult

public ErrorResult(org.osgl.http.H.Status status,
                   Throwable cause)

ErrorResult

public ErrorResult(org.osgl.http.H.Status status,
                   Throwable cause,
                   String message,
                   Object... args)

ErrorResult

public ErrorResult(org.osgl.http.H.Status status,
                   Integer errorCode)

ErrorResult

public ErrorResult(org.osgl.http.H.Status status,
                   Integer errorCode,
                   String message)

ErrorResult

public ErrorResult(org.osgl.http.H.Status status,
                   Integer errorCode,
                   String message,
                   Object... args)

ErrorResult

public ErrorResult(org.osgl.http.H.Status status,
                   Integer errorCode,
                   Throwable cause)

ErrorResult

public ErrorResult(org.osgl.http.H.Status status,
                   Integer errorCode,
                   Throwable cause,
                   String message,
                   Object... args)

Method Detail

attach

public ErrorResult attach(Object attachment)

attachment

public <T> T attachment()

attachment

public <T> T attachment(Class<T> type)

toString

public String toString()

Overrides:

toString in class Throwable

toJsonString

public String toJsonString()

toKVStore

public org.osgl.util.KVStore toKVStore()

Export the error result data into a KVStore

Returns:

a KV store of this error result

errorCode

public ErrorResult errorCode(int errorCode)

errorCode

public Integer errorCode()

getLocalizedMessage

public String getLocalizedMessage()

Overrides:

getLocalizedMessage in class Throwable

applyMessage

protected void applyMessage(org.osgl.http.H.Request request,
                            org.osgl.http.H.Response response)

Overrides:

applyMessage in class Result

defaultMessage

protected static String defaultMessage(org.osgl.http.H.Status status)

_localizedErrorMsg

protected static boolean _localizedErrorMsg()

of

public static ErrorResult of(org.osgl.http.H.Status status)

of

public static ErrorResult of(org.osgl.http.H.Status status,
                             String message,
                             Object... args)

of

public static ErrorResult of(org.osgl.http.H.Status status,
                             int errorCode)

of

public static ErrorResult of(org.osgl.http.H.Status status,
                             int errorCode,
                             String message,
                             Object... args)

of

public static ErrorResult of(org.osgl.http.H.Status status,
                             int errorCode,
                             Throwable cause)

of

public static ErrorResult of(org.osgl.http.H.Status status,
                             int errorCode,
                             Throwable cause,
                             String message,
                             Object... args)

of

public static ErrorResult of(org.osgl.http.H.Status status,
                             Throwable cause,
                             String message,
                             Object... args)