org.osgl.mvc.result

Class PreconditionRequired

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

All Implemented Interfaces:

Serializable

public class PreconditionRequired
extends ErrorResult

The origin server requires the request to be conditional. Intended to prevent the ‘lost update’ problem, where a client GETs a resource’s state, modifies it, and PUTs it back to the server, when meanwhile a third party has modified the state on the server, leading to a conflict."

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

Method Summary

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

PreconditionRequired

public PreconditionRequired()

PreconditionRequired

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

PreconditionRequired

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

PreconditionRequired

public PreconditionRequired(Throwable cause)

PreconditionRequired

public PreconditionRequired(int errorCode)

PreconditionRequired

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

PreconditionRequired

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

PreconditionRequired

public PreconditionRequired(int errorCode,
                            Throwable cause)

Method Detail

get

public static PreconditionRequired get()

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

of

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

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

of

public static PreconditionRequired of(Throwable cause)

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

of

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

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

of

public static PreconditionRequired of(int errorCode)

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

of

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

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

of

public static PreconditionRequired of(int errorCode,
                                      Throwable cause)

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

of

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

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