Package org.apache.juneau.http.classic.response

Class Locked

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.juneau.commons.BasicRuntimeException

org.apache.juneau.marshall.BasicRuntimeException

org.apache.juneau.http.classic.response.BasicHttpException

org.apache.juneau.http.classic.response.Locked

All Implemented Interfaces:

Serializable, HttpMessage, HttpResponse

Direct Known Subclasses:

Locked.Unmodifiable

@Response
@StatusCode(423)
@Schema(description="Locked")
public class Locked
extends BasicHttpException

Exception representing an HTTP 423 (Locked).

The resource that is being accessed is locked.

See Also:

• juneau-rest-common

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final Locked	INSTANCE	Reusable unmodifiable instance
static final String	REASON_PHRASE	Reason phrase
static final int	STATUS_CODE	HTTP status code

Constructor Summary

Constructors

Modifier	Constructor	Description
	Locked()	Constructor.
	Locked(String msg, Object... args)	Constructor.
	Locked(Throwable cause)	Constructor.
	Locked(Throwable cause, String msg, Object... args)	Constructor.
	Locked(HttpResponse response)	Constructor.
protected	Locked(Locked copyFrom)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
Locked	copy()	Creates a modifiable copy of this bean.
Locked	setContent(String value)	Sets the body on this response.
Locked	setContent(HttpEntity value)	Sets the body on this response.
Locked	setHeader2(String name, Object value)	Sets a header on this response.
Locked	setHeaders(List<Header> values)	Sets the specified headers on this response.
Locked	setHeaders(HeaderList value)	Sets the specified headers on this response.
Locked	setHeaders2(Header... values)	Sets multiple headers on this response.
Locked	setLocale2(Locale value)	Sets the locale used to retrieve reason phrases.
Locked	setMessage(String message, Object... args)	Sets the detail message on this exception.
Locked	setProtocolVersion(ProtocolVersion value)	Sets the protocol version on the status line.
Locked	setReasonPhrase2(String value)	Sets the reason phrase on the status line.
Locked	setReasonPhraseCatalog(ReasonPhraseCatalog value)	Sets the reason phrase catalog used to retrieve reason phrases.
Locked	setStatusCode2(int code)	Same as BasicHttpException.setStatusCode(int) but returns this object.
Locked	setStatusLine(BasicStatusLine value)	Sets the protocol version on the status line.
Locked	unmodifiable()	Returns an unmodifiable snapshot of this bean.

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

addHeader, addHeader, assertStatusCode, containsHeader, equals, freeze, getAllHeaders, getEntity, getFirstHeader, getFullStackMessage, getHeaders, getHeaders, getLastHeader, getLocale, getMessage, getParams, getProtocolVersion, getRootCause, getStatusLine, hashCode, headerIterator, headerIterator, isUnmodifiable, modify, removeHeader, removeHeaders, setEntity, setHeader, setHeader, setHeaders, setLocale, setParams, setReasonPhrase, setStatusCode, setStatusLine, setStatusLine, 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

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

INSTANCE

public static final Locked INSTANCE

Reusable unmodifiable instance

Constructor Details

Locked

public Locked()

Constructor.

Locked

public Locked(HttpResponse response)

Constructor.

This is the constructor used when parsing an HTTP response.

Parameters:

response - The HTTP response to copy from. Must not be null.

Throws:

IllegalArgumentException - If HTTP response status code does not match what was expected.

Locked

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

Constructor.

Parameters:

msg - The message. Can be null, in which case the reason phrase is used as the message.

args - Optional String.format-style arguments in the message.

Locked

public Locked(Throwable cause)

Constructor.

Parameters:

cause - The cause. Can be null, in which case the reason phrase is used as the message and no cause is chained.

Locked

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

Constructor.

Parameters:

cause - The caused-by exception. Can be null (no cause is chained).

msg - The message. Can be null, in which case the cause's message is used, or the reason phrase if the cause is also null or has no message.

args - The message arguments.

Locked

protected Locked(Locked copyFrom)

Copy constructor.

Parameters:

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

Method Details

copy

public Locked copy()

Creates a modifiable copy of this bean.

Returns:

A new modifiable bean.

setContent

public Locked setContent(HttpEntity value)

Description copied from class: BasicHttpException

Sets the body on this response.

Overrides:

setContent in class BasicHttpException

Parameters:

value - The body on this response. Can be null to unset the property.

Returns:

This object.

setContent

public Locked setContent(String value)

Description copied from class: BasicHttpException

Sets the body on this response.

Overrides:

setContent in class BasicHttpException

Parameters:

value - The body on this response. Can be null (treated as an empty string).

Returns:

This object.

setHeader2

public Locked setHeader2(String name,
 Object value)

Description copied from class: BasicHttpException

Sets a header on this response.

Overrides:

setHeader2 in class BasicHttpException

Parameters:

name - The header name.

value - The header value.

Returns:

This object.

setHeaders

public Locked setHeaders(HeaderList value)

Description copied from class: BasicHttpException

Sets the specified headers on this response.

Overrides:

setHeaders in class BasicHttpException

Parameters:

value - The new value. Must not be null.

Returns:

This object.

setHeaders

public Locked setHeaders(List<Header> values)

Description copied from class: BasicHttpException

Sets the specified headers on this response.

Overrides:

setHeaders in class BasicHttpException

Parameters:

values - The headers to set. null values are ignored.

Returns:

This object.

setHeaders2

public Locked setHeaders2(Header... values)

Description copied from class: BasicHttpException

Sets multiple headers on this response.

Overrides:

setHeaders2 in class BasicHttpException

Parameters:

values - The headers to add.

Returns:

This object.

setLocale2

public Locked setLocale2(Locale value)

Description copied from class: BasicHttpException

Sets the locale used to retrieve reason phrases.

If not specified, uses Locale.getDefault().

Overrides:

setLocale2 in class BasicHttpException

Parameters:

value - The new value. Can be null. The effect is implementation-dependent, depending on the configured ReasonPhraseCatalog (e.g. ignored by EnglishReasonPhraseCatalog).

Returns:

This object.

setMessage

public Locked setMessage(String message,
 Object... args)

Description copied from class: BasicRuntimeException

Sets the detail message on this exception.

Overrides:

setMessage in class BasicHttpException

Parameters:

message - The message.

args - The message args.

Returns:

This object.

setProtocolVersion

public Locked setProtocolVersion(ProtocolVersion value)

Description copied from class: BasicHttpException

Sets the protocol version on the status line.

If not specified, "HTTP/1.1" will be used.

Overrides:

setProtocolVersion in class BasicHttpException

Parameters:

value - The new value. Can be null, in which case the default protocol version is cleared and BasicStatusLine.getProtocolVersion() returns null.

Returns:

This object.

setReasonPhrase2

public Locked setReasonPhrase2(String value)

Description copied from class: BasicHttpException

Sets the reason phrase on the status line.

If not specified, the reason phrase will be retrieved from the reason phrase catalog using the locale on this builder.

Overrides:

setReasonPhrase2 in class BasicHttpException

Parameters:

value - The new value. Can be null to fall back to the reason phrase catalog.

Returns:

This object.

setReasonPhraseCatalog

public Locked setReasonPhraseCatalog(ReasonPhraseCatalog value)

Description copied from class: BasicHttpException

Sets the reason phrase catalog used to retrieve reason phrases.

If not specified, uses EnglishReasonPhraseCatalog.

Overrides:

setReasonPhraseCatalog in class BasicHttpException

Parameters:

value - The new value. Can be null to fall back to EnglishReasonPhraseCatalog.INSTANCE.

Returns:

This object.

setStatusCode2

public Locked setStatusCode2(int code)
                      throws IllegalStateException

Description copied from class: BasicHttpException

Same as BasicHttpException.setStatusCode(int) but returns this object.

Overrides:

setStatusCode2 in class BasicHttpException

Parameters:

code - The new status code.

Returns:

This object.

Throws:

IllegalStateException - If status code could not be set.

setStatusLine

public Locked setStatusLine(BasicStatusLine value)

Description copied from class: BasicHttpException

Sets the protocol version on the status line.

If not specified, "HTTP/1.1" will be used.

Overrides:

setStatusLine in class BasicHttpException

Parameters:

value - The new value. Must not be null.

Returns:

This object.

unmodifiable

public Locked 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.