Package org.apache.juneau.http.response

Class Ok

java.lang.Object

org.apache.juneau.http.response.BasicHttpResponse

org.apache.juneau.http.response.Ok

All Implemented Interfaces:

HttpMessage, HttpResponse

@Response
@StatusCode(200)
@Schema(description="OK")
public class Ok
extends BasicHttpResponse

Represents an HTTP 200 OK response.

Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action.

See Also:

• juneau-rest-common

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
Ok()	Constructor.
Ok(HttpResponse response)	Constructor.
Ok(Ok copyFrom)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
Ok	copy()	Creates a builder for this class initialized with the contents of this bean.
Ok	setContent(String value)	Sets the body on this response.
Ok	setContent(HttpEntity value)	Sets the body on this response.
Ok	setHeader2(String name, String value)	Sets the specified header to the end of the headers in this builder.
Ok	setHeader2(Header value)	Sets the specified header to the end of the headers in this builder.
Ok	setHeaders(List<Header> values)	Sets the specified headers to the end of the headers in this builder.
Ok	setHeaders(HeaderList value)	Sets the specified headers on this response.
Ok	setHeaders2(Header... values)	Sets the specified headers to the end of the headers in this builder.
Ok	setLocale2(Locale value)	Sets the locale used to retrieve reason phrases.
Ok	setLocation(String value)	Specifies the value for the Location header.
Ok	setLocation(URI value)	Specifies the value for the Location header.
Ok	setProtocolVersion(ProtocolVersion value)	Sets the protocol version on the status line.
Ok	setReasonPhrase2(String value)	Sets the reason phrase on the status line.
Ok	setReasonPhraseCatalog(ReasonPhraseCatalog value)	Sets the reason phrase catalog used to retrieve reason phrases.
Ok	setStatusCode2(int value)	Sets the status code on the status line.
Ok	setStatusLine(BasicStatusLine value)	Sets the protocol version on the status line.
Ok	setUnmodifiable()	Specifies whether this bean should be unmodifiable.

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

addHeader, addHeader, assertModifiable, assertStatusCode, containsHeader, getAllHeaders, getEntity, getFirstHeader, getHeaders, getHeaders, getLastHeader, getLocale, getParams, getProtocolVersion, getStatusLine, headerIterator, headerIterator, isUnmodifiable, removeHeader, removeHeaders, setEntity, setHeader, setHeader, setHeaders, setLocale, setParams, setReasonPhrase, setStatusCode, setStatusLine, setStatusLine, setStatusLine, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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 Ok INSTANCE

Default unmodifiable instance

OK

public static final Ok OK

Reusable unmodifiable instance

Constructor Details

Ok

public Ok()

Constructor.

Ok

public Ok(Ok copyFrom)

Copy constructor.

Parameters:

copyFrom - The bean to copy from.

Ok

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

Method Details

copy

public Ok copy()

Creates a builder for this class initialized with the contents of this bean.

Returns:

A new builder bean.

setContent

public Ok setContent(String value)

Description copied from class: BasicHttpResponse

Sets the body on this response.

Overrides:

setContent in class BasicHttpResponse

Parameters:

value - The body on this response.

Returns:

This object.

setContent

public Ok setContent(HttpEntity value)

Description copied from class: BasicHttpResponse

Sets the body on this response.

Overrides:

setContent in class BasicHttpResponse

Parameters:

value - The body on this response.

Returns:

This object.

setHeader2

public Ok setHeader2(Header value)

Description copied from class: BasicHttpResponse

Sets the specified header to the end of the headers in this builder.

Overrides:

setHeader2 in class BasicHttpResponse

Parameters:

value - The header to add. null values are ignored.

Returns:

This object.

setHeader2

public Ok setHeader2(String name,
 String value)

Description copied from class: BasicHttpResponse

Sets the specified header to the end of the headers in this builder.

Overrides:

setHeader2 in class BasicHttpResponse

Parameters:

name - The header name.

value - The header value.

Returns:

This object.

setHeaders

public Ok setHeaders(List<Header> values)

Description copied from class: BasicHttpResponse

Sets the specified headers to the end of the headers in this builder.

Overrides:

setHeaders in class BasicHttpResponse

Parameters:

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

Returns:

This object.

setHeaders

public Ok setHeaders(HeaderList value)

Description copied from class: BasicHttpResponse

Sets the specified headers on this response.

Overrides:

setHeaders in class BasicHttpResponse

Parameters:

value - The new value.

Returns:

This object.

setHeaders2

public Ok setHeaders2(Header... values)

Description copied from class: BasicHttpResponse

Sets the specified headers to the end of the headers in this builder.

Overrides:

setHeaders2 in class BasicHttpResponse

Parameters:

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

Returns:

This object.

setLocale2

public Ok setLocale2(Locale value)

Description copied from class: BasicHttpResponse

Sets the locale used to retrieve reason phrases.

If not specified, uses Locale.getDefault().

Overrides:

setLocale2 in class BasicHttpResponse

Parameters:

value - The new value.

Returns:

This object.

setLocation

public Ok setLocation(String value)

Description copied from class: BasicHttpResponse

Specifies the value for the Location header.

Overrides:

setLocation in class BasicHttpResponse

Parameters:

value - The new header location.

Returns:

This object.

setLocation

public Ok setLocation(URI value)

Description copied from class: BasicHttpResponse

Specifies the value for the Location header.

Overrides:

setLocation in class BasicHttpResponse

Parameters:

value - The new header location.

Returns:

This object.

setProtocolVersion

public Ok setProtocolVersion(ProtocolVersion value)

Description copied from class: BasicHttpResponse

Sets the protocol version on the status line.

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

Overrides:

setProtocolVersion in class BasicHttpResponse

Parameters:

value - The new value.

Returns:

This object.

setReasonPhrase2

public Ok setReasonPhrase2(String value)

Description copied from class: BasicHttpResponse

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 BasicHttpResponse

Parameters:

value - The new value.

Returns:

This object.

setReasonPhraseCatalog

public Ok setReasonPhraseCatalog(ReasonPhraseCatalog value)

Description copied from class: BasicHttpResponse

Sets the reason phrase catalog used to retrieve reason phrases.

If not specified, uses EnglishReasonPhraseCatalog.

Overrides:

setReasonPhraseCatalog in class BasicHttpResponse

Parameters:

value - The new value.

Returns:

This object.

setStatusCode2

public Ok setStatusCode2(int value)

Description copied from class: BasicHttpResponse

Sets the status code on the status line.

If not specified, 0 will be used.

Overrides:

setStatusCode2 in class BasicHttpResponse

Parameters:

value - The new value.

Returns:

This object.

setStatusLine

public Ok setStatusLine(BasicStatusLine value)

Description copied from class: BasicHttpResponse

Sets the protocol version on the status line.

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

Overrides:

setStatusLine in class BasicHttpResponse

Parameters:

value - The new value.

Returns:

This object.

setUnmodifiable

public Ok setUnmodifiable()

Description copied from class: BasicHttpResponse

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 BasicHttpResponse

Returns:

This object.