Package org.apache.juneau.http.response

Class PreconditionRequired

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.juneau.http.response.BasicHttpException

org.apache.juneau.http.response.PreconditionRequired

All Implemented Interfaces:

Serializable, HttpResponseMessage

Direct Known Subclasses:

PreconditionRequired.Unmodifiable

public class PreconditionRequired
extends BasicHttpException

Represents an HTTP 428 Precondition Required error response.

The origin server requires the request to be conditional.

See Also:

• Next-Generation REST Client

Since:

9.2.1

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PreconditionRequired.Unmodifiable	Unmodifiable point-in-time snapshot of the enclosing PreconditionRequired exception.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REASON_PHRASE	Reason phrase
static final int	STATUS_CODE	HTTP status code

Constructor Summary

Constructors

Constructor	Description
PreconditionRequired()	Constructor with no message.
PreconditionRequired(String msg, Object... args)	Constructor with a String.format-style message.
PreconditionRequired(Throwable cause)	Constructor with a cause.
PreconditionRequired(Throwable cause, String msg, Object... args)	Constructor with a cause and a String.format-style message.
PreconditionRequired(PreconditionRequired copyFrom)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
PreconditionRequired	unmodifiable()	Returns an unmodifiable snapshot of this bean.

Methods inherited from class org.apache.juneau.http.response.BasicHttpException

addHeader, addHeader, equals, freeze, getBody, getFullStackMessage, getHeaders, getLocale, getMessage, getRootCause, getStatusCode, getStatusLine, hashCode, isUnmodifiable, modify, setBody, setContent, setContent, setHeader, setHeader, setHeaders, setHeaders, setLocale, setProtocolVersion, setReasonPhrase, setStatusCode, setStatusLine, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.juneau.http.response.HttpResponseMessage

getFirstHeader, getHeaders

Field Details

STATUS_CODE

public static final int STATUS_CODE

HTTP status code

See Also:

• Constant Field Values

REASON_PHRASE

public static final String REASON_PHRASE

Reason phrase

See Also:

• Constant Field Values

Constructor Details

PreconditionRequired

public PreconditionRequired()

Constructor with no message.

PreconditionRequired

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

Constructor with a String.format-style message.

Parameters:

msg - The detail message. May be null. Treated as a String.format-style format string (%s placeholders) when args is non-empty.

args - Optional message arguments.

PreconditionRequired

public PreconditionRequired(Throwable cause)

Constructor with a cause.

Parameters:

cause - The cause. May be null.

PreconditionRequired

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

Constructor with a cause and a String.format-style message.

Parameters:

cause - The cause. May be null.

msg - The detail message. May be null. Treated as a String.format-style format string (%s placeholders) when args is non-empty.

args - Optional message arguments.

PreconditionRequired

public PreconditionRequired(PreconditionRequired copyFrom)

Copy constructor.

Parameters:

copyFrom - The instance to copy. Must not be null.

Method Details

unmodifiable

public PreconditionRequired unmodifiable()

Description copied from class: BasicHttpException

Returns an unmodifiable snapshot of this bean.

The returned instance is a point-in-time copy of the leaf's nested Unmodifiable type; any attempt to set a property on it throws an UnsupportedOperationException. This method is idempotent: if this bean is already unmodifiable it returns itself rather than taking another snapshot. The receiver is left unchanged (and still modifiable unless it was already unmodifiable).

Overrides:

unmodifiable in class BasicHttpException

Returns:

An unmodifiable snapshot of this bean, or this bean if it is already unmodifiable.