Package org.apache.juneau.http.response

Class UnavailableForLegalReasons

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.juneau.BasicRuntimeException

org.apache.juneau.http.response.BasicHttpException

org.apache.juneau.http.response.UnavailableForLegalReasons

All Implemented Interfaces:

Serializable, HttpMessage, HttpResponse

@Response
@StatusCode(451)
@Schema(description="Unavailable For Legal Reasons")
public class UnavailableForLegalReasons
extends BasicHttpException

Exception representing an HTTP 451 (Unavailable For Legal Reasons).

A server operator has received a legal demand to deny access to a resource or to a set of resources that includes the requested resource.

See Also:

• juneau-rest-common

Field Summary

Fields

Modifier and Type	Field	Description
static final UnavailableForLegalReasons	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
	UnavailableForLegalReasons()	Constructor.
	UnavailableForLegalReasons(String msg, Object... args)	Constructor.
	UnavailableForLegalReasons(Throwable cause)	Constructor.
	UnavailableForLegalReasons(Throwable cause, String msg, Object... args)	Constructor.
	UnavailableForLegalReasons(HttpResponse response)	Constructor.
protected	UnavailableForLegalReasons(UnavailableForLegalReasons copyFrom)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
UnavailableForLegalReasons	copy()	Creates a modifiable copy of this bean.
UnavailableForLegalReasons	setHeader2(String name, Object value)	Sets a header on this response.
UnavailableForLegalReasons	setHeaders(HeaderList value)	Sets the specified headers on this response.
UnavailableForLegalReasons	setHeaders2(Header... values)	Sets multiple headers on this response.
UnavailableForLegalReasons	setLocale2(Locale value)	Sets the locale used to retrieve reason phrases.
UnavailableForLegalReasons	setMessage(String message, Object... args)
UnavailableForLegalReasons	setProtocolVersion(ProtocolVersion value)	Sets the protocol version on the status line.
UnavailableForLegalReasons	setReasonPhrase2(String value)	Sets the reason phrase on the status line.
UnavailableForLegalReasons	setReasonPhraseCatalog(ReasonPhraseCatalog value)	Sets the reason phrase catalog used to retrieve reason phrases.
UnavailableForLegalReasons	setStatusCode2(int code)	Same as BasicHttpException.setStatusCode(int) but returns this object.
UnavailableForLegalReasons	setStatusLine(BasicStatusLine value)	Sets the protocol version on the status line.
UnavailableForLegalReasons	setUnmodifiable()	Specifies whether this bean should be unmodifiable.

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

addHeader, addHeader, assertStatusCode, containsHeader, getAllHeaders, getEntity, getFirstHeader, getFullStackMessage, getHeaders, getHeaders, getLastHeader, getLocale, getMessage, getParams, getProtocolVersion, getRootCause, getStatusLine, hashCode, headerIterator, headerIterator, removeHeader, removeHeaders, setContent, setContent, setEntity, setHeader, setHeader, setHeaders, setHeaders, setLocale, setParams, setReasonPhrase, setStatusCode, setStatusLine, setStatusLine, setStatusLine, toString

Methods inherited from class org.apache.juneau.BasicRuntimeException

assertModifiable, fillInStackTrace, getCause, initCause, isUnmodifiable, setStackTrace, unwrap

Methods inherited from class java.lang.Throwable

addSuppressed, getCause, getLocalizedMessage, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace

Methods inherited from class java.lang.Object

clone, equals, 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 UnavailableForLegalReasons INSTANCE

Reusable unmodifiable instance

Constructor Details

UnavailableForLegalReasons

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

Constructor.

Parameters:

cause - The caused-by exception. Can be null.

msg - The message. Can be null.

args - The message arguments.

UnavailableForLegalReasons

public UnavailableForLegalReasons()

Constructor.

UnavailableForLegalReasons

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

Constructor.

Parameters:

msg - The message. Can be null.

args - Optional MessageFormat-style arguments in the message.

UnavailableForLegalReasons

public UnavailableForLegalReasons(Throwable cause)

Constructor.

Parameters:

cause - The cause. Can be null.

UnavailableForLegalReasons

public UnavailableForLegalReasons(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:

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

UnavailableForLegalReasons

protected UnavailableForLegalReasons(UnavailableForLegalReasons copyFrom)

Copy constructor.

Parameters:

copyFrom - The bean to copy.

Method Details

copy

public UnavailableForLegalReasons copy()

Creates a modifiable copy of this bean.

Returns:

A new modifiable bean.

setMessage

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

Overrides:

setMessage in class BasicHttpException

setUnmodifiable

public UnavailableForLegalReasons setUnmodifiable()

Description copied from class: BasicHttpException

Specifies whether this bean should be unmodifiable.

When enabled, attempting to set any properties on this bean will cause an UnsupportedOperationException.

Overrides:

setUnmodifiable in class BasicHttpException

Returns:

This object.

setHeader2

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

Returns:

This object.

setHeaders2

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

Returns:

This object.

setProtocolVersion

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

Returns:

This object.

setReasonPhrase2

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

Returns:

This object.

setReasonPhraseCatalog

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

Returns:

This object.

setStatusCode2

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

Returns:

This object.