Package org.apache.juneau.http.response

Class BasicHttpResponse

java.lang.Object

org.apache.juneau.http.response.BasicHttpResponse

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

@BeanIgnore
public class BasicHttpResponse
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.

If the unmodifiable flag is set on this bean, calls to the setters will throw UnsupportedOperationException exceptions.

Notes:

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

See Also:

• juneau-rest-common Basics

Constructor Summary

Constructors

Constructor	Description
BasicHttpResponse(HttpResponse response)	Constructor.
BasicHttpResponse(BasicStatusLine statusLine)	Constructor.
BasicHttpResponse(BasicHttpResponse copyFrom)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
void	addHeader(String name, String value)
void	addHeader(Header value)
protected final void	assertModifiable()	Throws an UnsupportedOperationException if the unmodifiable flag is set on this bean.
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)
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()
HeaderIterator	headerIterator()
HeaderIterator	headerIterator(String name)
boolean	isUnmodifiable()	Returns true if this bean is unmodifiable.
void	removeHeader(Header value)
void	removeHeaders(String name)
BasicHttpResponse	setContent(String value)	Sets the body on this response.
BasicHttpResponse	setContent(HttpEntity value)	Sets the body on this response.
void	setEntity(HttpEntity entity)
void	setHeader(String name, String value)
void	setHeader(Header value)
BasicHttpResponse	setHeader2(String name, String value)	Sets the specified header to the end of the headers in this builder.
BasicHttpResponse	setHeader2(Header value)	Sets the specified header to the end of the headers in this builder.
BasicHttpResponse	setHeaders(List<Header> values)	Sets the specified headers to the end of the headers in this builder.
void	setHeaders(Header[] values)
BasicHttpResponse	setHeaders(HeaderList value)	Sets the specified headers on this response.
BasicHttpResponse	setHeaders2(Header... values)	Sets the specified headers to the end of the headers in this builder.
void	setLocale(Locale loc)
BasicHttpResponse	setLocale2(Locale value)	Sets the locale used to retrieve reason phrases.
BasicHttpResponse	setLocation(String value)	Specifies the value for the Location header.
BasicHttpResponse	setLocation(URI value)	Specifies the value for the Location header.
void	setParams(HttpParams params)
BasicHttpResponse	setProtocolVersion(ProtocolVersion value)	Sets the protocol version on the status line.
void	setReasonPhrase(String reason)
BasicHttpResponse	setReasonPhrase2(String value)	Sets the reason phrase on the status line.
BasicHttpResponse	setReasonPhraseCatalog(ReasonPhraseCatalog value)	Sets the reason phrase catalog used to retrieve reason phrases.
void	setStatusCode(int code)
BasicHttpResponse	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)
BasicHttpResponse	setStatusLine(BasicStatusLine value)	Sets the protocol version on the status line.
BasicHttpResponse	setUnmodifiable()	Specifies whether this bean should be unmodifiable.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

BasicHttpResponse

public BasicHttpResponse(BasicHttpResponse copyFrom)

Copy constructor.

Parameters:

copyFrom - The bean to copy from.

BasicHttpResponse

public BasicHttpResponse(BasicStatusLine statusLine)

Constructor.

Parameters:

statusLine - The HTTP status line.

BasicHttpResponse

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

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 BasicHttpResponse setContent(HttpEntity value)

Sets the body on this response.

Parameters:

value - The body on this response.

Returns:

This object.

setContent

public BasicHttpResponse setContent(String value)

Sets the body on this response.

Parameters:

value - The body on this response.

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 BasicHttpResponse 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 BasicHttpResponse 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 BasicHttpResponse setHeaders(HeaderList value)

Sets the specified headers on this response.

Parameters:

value - The new value.

Returns:

This object.

setHeaders

public BasicHttpResponse 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 BasicHttpResponse 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 BasicHttpResponse setLocale2(Locale value)

Sets the locale used to retrieve reason phrases.

If not specified, uses Locale.getDefault().

Parameters:

value - The new value.

Returns:

This object.

setLocation

public BasicHttpResponse setLocation(String value)

Specifies the value for the Location header.

Parameters:

value - The new header location.

Returns:

This object.

setLocation

public BasicHttpResponse setLocation(URI value)

Specifies the value for the Location header.

Parameters:

value - The new header location.

Returns:

This object.

setParams

public void setParams(HttpParams params)

Specified by:

setParams in interface HttpMessage

setProtocolVersion

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

Returns:

This object.

setReasonPhrase

public void setReasonPhrase(String reason)
                     throws IllegalStateException

Specified by:

setReasonPhrase in interface HttpResponse

Throws:

IllegalStateException

setReasonPhrase2

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

Returns:

This object.

setReasonPhraseCatalog

public BasicHttpResponse setReasonPhraseCatalog(ReasonPhraseCatalog value)

Sets the reason phrase catalog used to retrieve reason phrases.

If not specified, uses EnglishReasonPhraseCatalog.

Parameters:

value - The new value.

Returns:

This object.

setStatusCode

public void setStatusCode(int code)
                   throws IllegalStateException

Specified by:

setStatusCode in interface HttpResponse

Throws:

IllegalStateException

setStatusCode2

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

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

setUnmodifiable

public BasicHttpResponse setUnmodifiable()

Specifies whether this bean should be unmodifiable.

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

Returns:

This object.

toString

public String toString()

Overrides:

toString in class Object

assertModifiable

protected final void assertModifiable()

Throws an UnsupportedOperationException if the unmodifiable flag is set on this bean.

assertStatusCode

protected void assertStatusCode(HttpResponse response)
                         throws AssertionError

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:

AssertionError - If status code is not what was expected.