org.osgl.mvc.result

Class ServiceUnavailable

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.ServiceUnavailable

All Implemented Interfaces:

Serializable

public class ServiceUnavailable
extends ErrorResult

The server is currently unavailable (because it is overloaded or down for maintenance). Generally, this is a temporary state.

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

Method Summary

Modifier and Type	Method and Description
static ServiceUnavailable	get() Returns a static ServiceUnavailable instance and set the Result.payload thread local with default message.
static ServiceUnavailable	of(int errorCode) Returns a static ServiceUnavailable instance and set the Result.payload thread local with error code and default message.
static ServiceUnavailable	of(int errorCode, String message, Object... args) Returns a static ServiceUnavailable instance and set the Result.payload thread local with error code and message specified.
static ServiceUnavailable	of(int errorCode, Throwable cause) Returns a static ServiceUnavailable instance and set the Result.payload thread local with error code and cause specified
static ServiceUnavailable	of(int errorCode, Throwable cause, String message, Object... args) Returns a static ServiceUnavailable instance and set the Result.payload thread local with error code, cause and message specified.
static ServiceUnavailable	of(String message, Object... args) Returns a static ServiceUnavailable instance and set the Result.payload thread local with message specified.
static ServiceUnavailable	of(Throwable cause) Returns a static ServiceUnavailable instance and set the Result.payload thread local with cause specified.
static ServiceUnavailable	of(Throwable cause, String message, Object... args) Returns a static ServiceUnavailable 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

ServiceUnavailable

public ServiceUnavailable()

ServiceUnavailable

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

ServiceUnavailable

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

ServiceUnavailable

public ServiceUnavailable(Throwable cause)

ServiceUnavailable

public ServiceUnavailable(int errorCode)

ServiceUnavailable

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

ServiceUnavailable

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

ServiceUnavailable

public ServiceUnavailable(int errorCode,
                          Throwable cause)

Method Detail

get

public static ServiceUnavailable get()

Returns a static ServiceUnavailable 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 ServiceUnavailable instance as described above

of

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

Returns a static ServiceUnavailable 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 ServiceUnavailable instance as described above

of

public static ServiceUnavailable of(Throwable cause)

Returns a static ServiceUnavailable 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 ServiceUnavailable instance as described above

of

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

Returns a static ServiceUnavailable 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 ServiceUnavailable instance as described above

of

public static ServiceUnavailable of(int errorCode)

Returns a static ServiceUnavailable 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 ServiceUnavailable instance as described above

of

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

Returns a static ServiceUnavailable 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 ServiceUnavailable instance as described above

of

public static ServiceUnavailable of(int errorCode,
                                    Throwable cause)

Returns a static ServiceUnavailable 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 ServiceUnavailable instance as described above

of

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

Returns a static ServiceUnavailable 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 ServiceUnavailable instance as described above