org.osgl.mvc.result

Class TooManyRequests

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

All Implemented Interfaces:

Serializable

public class TooManyRequests
extends ErrorResult

The user has sent too many requests in a given amount of time. Intended for use with rate-limiting schemes.

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 TooManyRequests	INSTANCE The static instance of TooManyRequests result.

Constructor Summary

Constructors

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

Method Summary

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

The static instance of TooManyRequests result.

Constructor Detail

TooManyRequests

public TooManyRequests()

TooManyRequests

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

TooManyRequests

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

TooManyRequests

public TooManyRequests(Throwable cause)

TooManyRequests

public TooManyRequests(int errorCode)

TooManyRequests

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

TooManyRequests

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

TooManyRequests

public TooManyRequests(int errorCode,
                       Throwable cause)

Method Detail

get

public static TooManyRequests get()

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

of

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

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

of

public static TooManyRequests of(Throwable cause)

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

of

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

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

of

public static TooManyRequests of(int errorCode)

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

of

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

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

of

public static TooManyRequests of(int errorCode,
                                 Throwable cause)

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

of

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

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