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

Class Ok

java.lang.Object

org.apache.juneau.http.classic.response.BasicHttpResponse<Ok>

org.apache.juneau.http.classic.response.Ok

All Implemented Interfaces:

HttpMessage, HttpResponse

Direct Known Subclasses:

Ok.Unmodifiable

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

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

Nested Class Summary

Nested Classes

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

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	unmodifiable()	Returns an unmodifiable snapshot of this bean.

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

addHeader, addHeader, assertStatusCode, containsHeader, equals, freeze, getAllHeaders, getEntity, getFirstHeader, getHeaders, getHeaders, getLastHeader, getLocale, getParams, getProtocolVersion, getStatusLine, hashCode, headerIterator, headerIterator, isUnmodifiable, modify, removeHeader, removeHeaders, self, setContent, setContent, setEntity, setHeader, setHeader, setHeader2, setHeader2, setHeaders, setHeaders, setHeaders, setHeaders2, setLocale, setLocale2, setLocation, setLocation, setParams, setProtocolVersion, setReasonPhrase, setReasonPhrase2, setReasonPhraseCatalog, setStatusCode, setStatusCode2, setStatusLine, setStatusLine, setStatusLine, setStatusLine, toString

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 Ok INSTANCE

Default unmodifiable instance

OK

public static final Ok OK

Reusable unmodifiable instance

Constructor Details

Ok

public Ok()

Constructor.

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:

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

Ok

public Ok(Ok copyFrom)

Copy constructor.

Parameters:

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

Method Details

copy

public Ok copy()

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

Returns:

A new builder bean.

unmodifiable

public Ok unmodifiable()

Description copied from class: BasicHttpResponse

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

Specified by:

unmodifiable in class BasicHttpResponse<Ok>

Returns:

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