Package org.apache.juneau.http.response

Class Forbidden

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

All Implemented Interfaces:

Serializable, HttpMessage, HttpResponse

@Response
@StatusCode(403)
@Schema(description="Forbidden")
public class Forbidden
extends BasicHttpException

Exception representing an HTTP 403 (Forbidden).

The request was valid, but the server is refusing action.
The user might not have the necessary permissions for a resource, or may need an account of some sort.

See Also:

• juneau-rest-common

Field Summary

Fields

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

Method Summary

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

Reusable unmodifiable instance

Constructor Details

Forbidden

public Forbidden(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.

Forbidden

public Forbidden()

Constructor.

Forbidden

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

Constructor.

Parameters:

msg - The message. Can be null.

args - Optional MessageFormat-style arguments in the message.

Forbidden

public Forbidden(Throwable cause)

Constructor.

Parameters:

cause - The cause. Can be null.

Forbidden

public Forbidden(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.

Forbidden

protected Forbidden(Forbidden copyFrom)

Copy constructor.

Parameters:

copyFrom - The bean to copy.

Method Details

copy

public Forbidden copy()

Creates a modifiable copy of this bean.

Returns:

A new modifiable bean.

setMessage

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

Overrides:

setMessage in class BasicHttpException

setUnmodifiable

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