org.osgl.mvc.result

Class Forbidden

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

All Implemented Interfaces:

Serializable

public class Forbidden
extends ErrorResult

HTTP 403 Forbidden

See Also:

Serialized Form

Nested Class Summary

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

Result.Payload

Field Summary

Fields

Modifier and Type	Field and Description
static Forbidden	INSTANCE The static instance of Forbidden result.

Constructor Summary

Constructors

Constructor and Description
Forbidden()
Forbidden(int errorCode)
Forbidden(int errorCode, String message, Object... args)
Forbidden(int errorCode, Throwable cause)
Forbidden(int errorCode, Throwable cause, String message, Object... args)
Forbidden(String message, Object... args)
Forbidden(Throwable cause)
Forbidden(Throwable cause, String message, Object... args)

Method Summary

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

Field Detail

INSTANCE

public static final Forbidden INSTANCE

The static instance of Forbidden result.

Constructor Detail

Forbidden

public Forbidden()

Forbidden

public Forbidden(int errorCode)

Forbidden

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

Forbidden

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

Forbidden

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

Forbidden

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

Forbidden

public Forbidden(Throwable cause)

Forbidden

public Forbidden(int errorCode,
                 Throwable cause)

Method Detail

get

public static Forbidden get()

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

of

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

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

of

public static Forbidden of(Throwable cause)

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

of

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

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

of

public static Forbidden of(int errorCode)

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

of

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

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

of

public static Forbidden of(int errorCode,
                           Throwable cause)

Returns a static Forbidden 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:

errorCode - the app defined error code

Returns:

a static Forbidden instance as described above

of

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

Returns a static Forbidden 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:

errorCode - the app defined error code

message - the message

args - the message arguments

Returns:

a static Forbidden instance as described above

of

@Deprecated
public static Forbidden of(Throwable cause,
                                       int errorCode)

Deprecated.

Returns a static Forbidden 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

This method is deprecated. Please use of(int, Throwable) instead

Parameters:

cause - the cause

errorCode - the app defined error code

Returns:

a static Forbidden instance as described above

of

@Deprecated
public static Forbidden of(Throwable cause,
                                       int errorCode,
                                       String message,
                                       Object... args)

Deprecated.

Returns a static Forbidden 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

This is deprecated. Please use of(int, Throwable, String, Object...) instead

Parameters:

cause - the cause

errorCode - the app defined error code

message - the message

args - the message arguments

Returns:

a static Forbidden instance as described above