org.osgl.mvc.result

Class UnavailableForLegalReasons

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

All Implemented Interfaces:

Serializable

public class UnavailableForLegalReasons
extends ErrorResult

A server operator has received a legal demand to deny access to a resource or to a set of resources that includes the requested resource. The code 451 was chosen as a reference to the novel Fahrenheit 451.

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

Method Summary

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

UnavailableForLegalReasons

public UnavailableForLegalReasons()

UnavailableForLegalReasons

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

UnavailableForLegalReasons

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

UnavailableForLegalReasons

public UnavailableForLegalReasons(Throwable cause)

UnavailableForLegalReasons

public UnavailableForLegalReasons(int errorCode)

UnavailableForLegalReasons

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

UnavailableForLegalReasons

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

UnavailableForLegalReasons

public UnavailableForLegalReasons(int errorCode,
                                  Throwable cause)

Method Detail

get

public static UnavailableForLegalReasons get()

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

of

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

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

of

public static UnavailableForLegalReasons of(Throwable cause)

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

of

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

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

of

public static UnavailableForLegalReasons of(int errorCode)

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

of

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

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

of

public static UnavailableForLegalReasons of(int errorCode,
                                            Throwable cause)

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

of

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

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