org.osgl.mvc.result

Class RequestTimeout

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

org.osgl.mvc.result.RequestTimeout

All Implemented Interfaces:

Serializable

public class RequestTimeout
extends ErrorResult

The server timed out waiting for the request. According to HTTP specifications: “The client did not produce a request within the time that the server was prepared to wait. The client MAY repeat the request without modifications at any later time.”

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
RequestTimeout()
RequestTimeout(int errorCode)
RequestTimeout(int errorCode, String message, Object... args)
RequestTimeout(int errorCode, Throwable cause)
RequestTimeout(int errorCode, Throwable cause, String message, Object... args)
RequestTimeout(String message, Object... args)
RequestTimeout(Throwable cause)
RequestTimeout(Throwable cause, String message, Object... args)

Method Summary

Modifier and Type	Method and Description
static RequestTimeout	get() Returns a static RequestTimeout instance and set the Result.payload thread local with default message.
static RequestTimeout	of(int errorCode) Returns a static RequestTimeout instance and set the Result.payload thread local with error code and default message.
static RequestTimeout	of(int errorCode, String message, Object... args) Returns a static RequestTimeout instance and set the Result.payload thread local with error code and message specified.
static RequestTimeout	of(int errorCode, Throwable cause) Returns a static RequestTimeout instance and set the Result.payload thread local with error code and cause specified
static RequestTimeout	of(int errorCode, Throwable cause, String message, Object... args) Returns a static RequestTimeout instance and set the Result.payload thread local with error code, cause and message specified.
static RequestTimeout	of(String message, Object... args) Returns a static RequestTimeout instance and set the Result.payload thread local with message specified.
static RequestTimeout	of(Throwable cause) Returns a static RequestTimeout instance and set the Result.payload thread local with cause specified.
static RequestTimeout	of(Throwable cause, String message, Object... args) Returns a static RequestTimeout instance and set the Result.payload thread local with cause and message specified.

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

_localizedErrorMsg, applyMessage, attach, attachment, attachment, defaultMessage, errorCode, errorCode, getLocalizedMessage, of, of, of, of, of, of, of, toJsonString, toKVStore, 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

RequestTimeout

public RequestTimeout()

RequestTimeout

public RequestTimeout(String message,
                      Object... args)

RequestTimeout

public RequestTimeout(Throwable cause,
                      String message,
                      Object... args)

RequestTimeout

public RequestTimeout(Throwable cause)

RequestTimeout

public RequestTimeout(int errorCode)

RequestTimeout

public RequestTimeout(int errorCode,
                      String message,
                      Object... args)

RequestTimeout

public RequestTimeout(int errorCode,
                      Throwable cause,
                      String message,
                      Object... args)

RequestTimeout

public RequestTimeout(int errorCode,
                      Throwable cause)

Method Detail

get

public static RequestTimeout get()

Returns a static RequestTimeout instance and set the Result.payload thread local with default message.

When calling the instance on Throwable.getMessage() method, it will return whatever stored in the Result.payload thread local

Returns:

a static RequestTimeout instance as described above

of

public static RequestTimeout of(String message,
                                Object... args)

Returns a static RequestTimeout instance and set the Result.payload thread local with message specified.

When calling the instance on Throwable.getMessage() method, it will return whatever stored in the Result.payload thread local

Parameters:

message - the message

args - the message arguments

Returns:

a static RequestTimeout instance as described above

of

public static RequestTimeout of(Throwable cause)

Returns a static RequestTimeout instance and set the Result.payload thread local with cause specified.

When calling the instance on Throwable.getMessage() method, it will return whatever stored in the Result.payload thread local

Parameters:

cause - the cause

Returns:

a static RequestTimeout instance as described above

of

public static RequestTimeout of(Throwable cause,
                                String message,
                                Object... args)

Returns a static RequestTimeout instance and set the Result.payload thread local with cause and message specified.

When calling the instance on Throwable.getMessage() method, it will return whatever stored in the Result.payload thread local

Parameters:

cause - the cause

message - the message

args - the message arguments

Returns:

a static RequestTimeout instance as described above

of

public static RequestTimeout of(int errorCode)

Returns a static RequestTimeout instance and set the Result.payload thread local with error code and default message.

When calling the instance on Throwable.getMessage() method, it will return whatever stored in the Result.payload thread local

Parameters:

errorCode - the app defined error code

Returns:

a static RequestTimeout instance as described above

of

public static RequestTimeout of(int errorCode,
                                String message,
                                Object... args)

Returns a static RequestTimeout instance and set the Result.payload thread local with error code and message specified.

When calling the instance on Throwable.getMessage() method, it will return whatever stored in the Result.payload thread local

Parameters:

errorCode - the app defined error code

message - the message

args - the message arguments

Returns:

a static RequestTimeout instance as described above

of

public static RequestTimeout of(int errorCode,
                                Throwable cause)

Returns a static RequestTimeout instance and set the Result.payload thread local with error code and cause specified

When calling the instance on Throwable.getMessage() method, it will return whatever stored in the Result.payload thread local

Parameters:

cause - the cause

errorCode - the app defined error code

Returns:

a static RequestTimeout instance as described above

of

public static RequestTimeout of(int errorCode,
                                Throwable cause,
                                String message,
                                Object... args)

Returns a static RequestTimeout instance and set the Result.payload thread local with error code, cause and message specified.

When calling the instance on Throwable.getMessage() method, it will return whatever stored in the Result.payload thread local

Parameters:

cause - the cause

errorCode - the app defined error code

message - the message

args - the message arguments

Returns:

a static RequestTimeout instance as described above