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

Class BasicHttpResponse<SELF extends BasicHttpResponse<SELF>>

java.lang.Object

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

Type Parameters:

SELF - The self type for fluent setters.

All Implemented Interfaces:

HttpMessage, HttpResponse

Direct Known Subclasses:

Accepted, AlreadyReported, Continue, Created, EarlyHints, Found, IMUsed, MovedPermanently, MultipleChoices, MultiStatus, NoContent, NonAuthoritiveInformation, NotModified, Ok, PartialContent, PermanentRedirect, Processing, ResetContent, SeeOther, SwitchingProtocols, TemporaryRedirect, UseProxy

@Marshalled(as=STRING)
public abstract class BasicHttpResponse<SELF extends BasicHttpResponse<SELF>>
extends Object
implements HttpResponse

Basic implementation of the HttpResponse interface.

Although this class implements the various setters defined on the HttpResponse interface, it's in general going to be more efficient to set the status/headers/content of this bean through the builder.

Immutability is expressed with the "funnel + nested Unmodifiable snapshot" paradigm: every mutator (fluent setter and void interface mutator) routes through the single protected modify(Runnable) choke-point, and each concrete leaf gets a nested X.Unmodifiable whose only behavioral override is a throwing modify(...). A leaf's unmodifiable() factory returns a point-in-time snapshot of type X.Unmodifiable; any attempt to set a property on it throws an UnsupportedOperationException.

This is a self-typed (CRTP) root: a leaf declares class Ok extends BasicHttpResponse<Ok> and inherits leaf-typed fluent setters with no covariant overrides.

Notes:

• Beans are not thread safe unless they're marked as unmodifiable.

See Also:

• juneau-rest-common

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BasicHttpResponse(HttpResponse response)	Constructor.
protected	BasicHttpResponse(BasicStatusLine statusLine)	Constructor.
protected	BasicHttpResponse(BasicHttpResponse<?> copyFrom)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
void	addHeader(String name, String value)
void	addHeader(Header value)
protected void	assertStatusCode(HttpResponse response)	Asserts that the specified HTTP response has the same status code as the one on the status line of this bean.
boolean	containsHeader(String name)
boolean	equals(Object o)
protected void	freeze()	Deep-freeze hook invoked from the nested Unmodifiable constructor after the snapshot copy completes.
Header[]	getAllHeaders()
HttpEntity	getEntity()
Header	getFirstHeader(String name)
HeaderList	getHeaders()	Returns access to the underlying builder for the headers.
Header[]	getHeaders(String name)
Header	getLastHeader(String name)
Locale	getLocale()
HttpParams	getParams()
ProtocolVersion	getProtocolVersion()
StatusLine	getStatusLine()
int	hashCode()
HeaderIterator	headerIterator()
HeaderIterator	headerIterator(String name)
boolean	isUnmodifiable()	Returns true if this bean is unmodifiable.
protected SELF	modify(Runnable mutation)	Single mutation funnel — the only choke-point through which all state changes on this bean flow.
void	removeHeader(Header value)
void	removeHeaders(String name)
protected final SELF	self()	Returns this object cast to the self type.
SELF	setContent(String value)	Sets the body on this response.
SELF	setContent(HttpEntity value)	Sets the body on this response.
void	setEntity(HttpEntity entity)
void	setHeader(String name, String value)
void	setHeader(Header value)
SELF	setHeader2(String name, String value)	Sets the specified header to the end of the headers in this builder.
SELF	setHeader2(Header value)	Sets the specified header to the end of the headers in this builder.
SELF	setHeaders(List<Header> values)	Sets the specified headers to the end of the headers in this builder.
void	setHeaders(Header[] values)
SELF	setHeaders(HeaderList value)	Sets the specified headers on this response.
SELF	setHeaders2(Header... values)	Sets the specified headers to the end of the headers in this builder.
void	setLocale(Locale loc)
SELF	setLocale2(Locale value)	Sets the locale used to retrieve reason phrases.
SELF	setLocation(String value)	Specifies the value for the Location header.
SELF	setLocation(URI value)	Specifies the value for the Location header.
void	setParams(HttpParams params)
SELF	setProtocolVersion(ProtocolVersion value)	Sets the protocol version on the status line.
void	setReasonPhrase(String reason)
SELF	setReasonPhrase2(String value)	Sets the reason phrase on the status line.
SELF	setReasonPhraseCatalog(ReasonPhraseCatalog value)	Sets the reason phrase catalog used to retrieve reason phrases.
void	setStatusCode(int code)
SELF	setStatusCode2(int value)	Sets the status code on the status line.
void	setStatusLine(ProtocolVersion ver, int code)
void	setStatusLine(ProtocolVersion ver, int code, String reason)
void	setStatusLine(StatusLine value)
SELF	setStatusLine(BasicStatusLine value)	Sets the protocol version on the status line.
String	toString()
abstract SELF	unmodifiable()	Returns an unmodifiable snapshot of this bean.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

BasicHttpResponse

protected BasicHttpResponse(BasicHttpResponse<?> copyFrom)

Copy constructor.

Parameters:

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

BasicHttpResponse

protected BasicHttpResponse(BasicStatusLine statusLine)

Constructor.

Parameters:

statusLine - The HTTP status line. Must not be null.

BasicHttpResponse

protected BasicHttpResponse(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.

Method Details

addHeader

public void addHeader(Header value)

Specified by:

addHeader in interface HttpMessage

addHeader

public void addHeader(String name,
 String value)

Specified by:

addHeader in interface HttpMessage

containsHeader

public boolean containsHeader(String name)

Specified by:

containsHeader in interface HttpMessage

getAllHeaders

public Header[] getAllHeaders()

Specified by:

getAllHeaders in interface HttpMessage

getEntity

public HttpEntity getEntity()

Specified by:

getEntity in interface HttpResponse

getFirstHeader

public Header getFirstHeader(String name)

Specified by:

getFirstHeader in interface HttpMessage

getHeaders

public HeaderList getHeaders()

Returns access to the underlying builder for the headers.

Returns:

The underlying builder for the headers.

getHeaders

public Header[] getHeaders(String name)

Specified by:

getHeaders in interface HttpMessage

getLastHeader

public Header getLastHeader(String name)

Specified by:

getLastHeader in interface HttpMessage

getLocale

public Locale getLocale()

Specified by:

getLocale in interface HttpResponse

getParams

public HttpParams getParams()

Specified by:

getParams in interface HttpMessage

getProtocolVersion

public ProtocolVersion getProtocolVersion()

Specified by:

getProtocolVersion in interface HttpMessage

getStatusLine

public StatusLine getStatusLine()

Specified by:

getStatusLine in interface HttpResponse

headerIterator

public HeaderIterator headerIterator()

Specified by:

headerIterator in interface HttpMessage

headerIterator

public HeaderIterator headerIterator(String name)

Specified by:

headerIterator in interface HttpMessage

isUnmodifiable

public boolean isUnmodifiable()

Returns true if this bean is unmodifiable.

Returns:

true if this bean is an UnmodifiableBean snapshot.

removeHeader

public void removeHeader(Header value)

Specified by:

removeHeader in interface HttpMessage

removeHeaders

public void removeHeaders(String name)

Specified by:

removeHeaders in interface HttpMessage

setContent

public SELF setContent(HttpEntity value)

Sets the body on this response.

Parameters:

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

Returns:

This object.

setContent

public SELF setContent(String value)

Sets the body on this response.

Parameters:

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

Returns:

This object.

setEntity

public void setEntity(HttpEntity entity)

Specified by:

setEntity in interface HttpResponse

setHeader

public void setHeader(Header value)

Specified by:

setHeader in interface HttpMessage

setHeader

public void setHeader(String name,
 String value)

Specified by:

setHeader in interface HttpMessage

setHeader2

public SELF setHeader2(Header value)

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

Parameters:

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

Returns:

This object.

setHeader2

public SELF setHeader2(String name,
 String value)

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

Parameters:

name - The header name.

value - The header value.

Returns:

This object.

setHeaders

public void setHeaders(Header[] values)

Specified by:

setHeaders in interface HttpMessage

setHeaders

public SELF setHeaders(HeaderList value)

Sets the specified headers on this response.

Parameters:

value - The new value. Must not be null.

Returns:

This object.

setHeaders

public SELF setHeaders(List<Header> values)

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

Parameters:

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

Returns:

This object.

setHeaders2

public SELF setHeaders2(Header... values)

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

Parameters:

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

Returns:

This object.

setLocale

public void setLocale(Locale loc)

Specified by:

setLocale in interface HttpResponse

setLocale2

public SELF setLocale2(Locale value)

Sets the locale used to retrieve reason phrases.

If not specified, uses Locale.getDefault().

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.

setLocation

public SELF setLocation(String value)

Specifies the value for the Location header.

Parameters:

value - The new header location. Can be null (no-op; the header is left unchanged).

Returns:

This object.

setLocation

public SELF setLocation(URI value)

Specifies the value for the Location header.

Parameters:

value - The new header location. Can be null (no-op; the header is left unchanged).

Returns:

This object.

setParams

public void setParams(HttpParams params)

Specified by:

setParams in interface HttpMessage

setProtocolVersion

public SELF setProtocolVersion(ProtocolVersion value)

Sets the protocol version on the status line.

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

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.

setReasonPhrase

public void setReasonPhrase(String reason)
                     throws IllegalStateException

Specified by:

setReasonPhrase in interface HttpResponse

Throws:

IllegalStateException

setReasonPhrase2

public SELF setReasonPhrase2(String value)

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.

Parameters:

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

Returns:

This object.

setReasonPhraseCatalog

public SELF setReasonPhraseCatalog(ReasonPhraseCatalog value)

Sets the reason phrase catalog used to retrieve reason phrases.

If not specified, uses EnglishReasonPhraseCatalog.

Parameters:

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

Returns:

This object.

setStatusCode

public void setStatusCode(int code)
                   throws IllegalStateException

Specified by:

setStatusCode in interface HttpResponse

Throws:

IllegalStateException

setStatusCode2

public SELF setStatusCode2(int value)

Sets the status code on the status line.

If not specified, 0 will be used.

Parameters:

value - The new value.

Returns:

This object.

setStatusLine

public SELF setStatusLine(BasicStatusLine value)

Sets the protocol version on the status line.

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

Parameters:

value - The new value. Must not be null.

Returns:

This object.

setStatusLine

public void setStatusLine(ProtocolVersion ver,
 int code)

Specified by:

setStatusLine in interface HttpResponse

setStatusLine

public void setStatusLine(ProtocolVersion ver,
 int code,
 String reason)

Specified by:

setStatusLine in interface HttpResponse

setStatusLine

public void setStatusLine(StatusLine value)

Specified by:

setStatusLine in interface HttpResponse

unmodifiable

public abstract SELF unmodifiable()

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

Returns:

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

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

self

protected final SELF self()

Returns this object cast to the self type.

Returns:

This object.

modify

protected SELF modify(Runnable mutation)

Single mutation funnel — the only choke-point through which all state changes on this bean flow.

Every mutator (fluent setter and void interface mutator) routes through this method. The nested Unmodifiable snapshot overrides only this method to throw, which freezes the entire mutation surface with a single override.

Parameters:

mutation - The state change to apply.

Returns:

This object.

freeze

protected void freeze()

Deep-freeze hook invoked from the nested Unmodifiable constructor after the snapshot copy completes.

The mutable sub-beans are frozen here by direct field assignment (never via a setter, which would route through the throwing modify(Runnable) and blow up during construction). A leaf that adds its own mutable sub-bean overrides this method (calling super.freeze() first).

assertStatusCode

protected void assertStatusCode(HttpResponse response)
                         throws IllegalArgumentException

Asserts that the specified HTTP response has the same status code as the one on the status line of this bean.

Parameters:

response - The HTTP response to check. Must not be null.

Throws:

IllegalArgumentException - If status code is not what was expected.