Package org.omegazero.http.common

Class HTTPResponse

java.lang.Object

org.omegazero.common.util.SimpleAttachmentContainer

org.omegazero.http.common.HTTPHeaderContainer

org.omegazero.http.common.HTTPMessage

org.omegazero.http.common.HTTPResponse

All Implemented Interfaces:

Serializable, org.omegazero.common.util.AttachmentContainer

public class HTTPResponse
extends HTTPMessage

Represents a HTTP response, a specific type of HTTPMessage.

Since:

1.2.1

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	status	The HTTP response status.

Fields inherited from class org.omegazero.http.common.HTTPMessage

chunkedTransfer, createdTime, httpVersion, locked, other

Fields inherited from class org.omegazero.http.common.HTTPHeaderContainer

headerFields

Fields inherited from class org.omegazero.common.util.SimpleAttachmentContainer

attachments

Constructor Summary

Constructors

Constructor	Description
HTTPResponse(int status, String version, HTTPHeaderContainer headers)	Creates a new HTTPResponse.
HTTPResponse(HTTPResponse response)	Copies the given HTTPResponse.

Method Summary

Modifier and Type	Method	Description
HTTPRequest	getOther()	Returns the other HTTPMessage of the HTTP message exchange this HTTPMessage is part of.
int	getStatus()	Returns the HTTP response status code of this HTTPResponse.
boolean	hasResponseBody()	Determines whether this HTTPResponse has a response body if initiated by the given request.
static boolean	hasResponseBody(int status)	Determines whether responses with the given status code should have a response body.
boolean	hasResponseBody(HTTPRequest request)	Determines whether this HTTPResponse has a response body if initiated by the given request.
boolean	isIntermediateMessage()	Determines whether this HTTPResponse is an intermediate message, meaning it is followed up by another HTTPResponse to complete the HTTP exchange or it has some other special meaning.
String	responseLine()	Generates a HTTP/1-style response line of the form HTTP/[version] [status].
void	setStatus(int status)	Sets the HTTP response status code of this HTTPResponse.

Methods inherited from class org.omegazero.http.common.HTTPMessage

checkLocked, getCreatedTime, getHttpVersion, isChunkedTransfer, isLocked, lock, setChunkedTransfer, setHttpVersion, setOther

Methods inherited from class org.omegazero.http.common.HTTPHeaderContainer

addHeader, addHeader, appendHeader, appendHeader, appendHeader, deleteHeader, deleteHeader, editHeader, extractHeader, extractHeaders, fromLegacy, getHeader, getHeader, getHeader, getHeader, getHeaderCount, headerExists, headerIterator, headerNameCount, headerNameSet, headers, headerSet, setHeader, toString

Methods inherited from class org.omegazero.common.util.SimpleAttachmentContainer

getAttachment, hasAttachment, removeAttachment, setAttachment

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.omegazero.common.util.AttachmentContainer

requireAttachment

Field Details

status

protected int status

The HTTP response status.

Constructor Details

HTTPResponse

public HTTPResponse(int status,
 String version,
 HTTPHeaderContainer headers)

Creates a new HTTPResponse.

Note that no deep copy of the headers will be created, meaning changes made to the given HTTPHeaderContainer will reflect on this HTTPResponse.

Parameters:

status - The HTTP response status code

version - The HTTP version

headers - The HTTP headers, or null to create an empty set of headers

HTTPResponse

public HTTPResponse(HTTPResponse response)

Copies the given HTTPResponse.

Parameters:

response - The HTTPResponse to copy from

See Also:

• HTTPMessage(HTTPMessage)

Method Details

responseLine

public String responseLine()

Generates a HTTP/1-style response line of the form HTTP/[version] [status].

Returns:

A response line

getStatus

public int getStatus()

Returns the HTTP response status code of this HTTPResponse.

Returns:

The HTTP response status code

See Also:

• setStatus(int)

setStatus

public void setStatus(int status)

Sets the HTTP response status code of this HTTPResponse.

Parameters:

status - The new HTTP response status code

Throws:

IllegalStateException - If this HTTPMessage is locked

See Also:

• getStatus()

isIntermediateMessage

public boolean isIntermediateMessage()

Determines whether this HTTPResponse is an intermediate message, meaning it is followed up by another HTTPResponse to complete the HTTP exchange or it has some other special meaning.

This applies to responses with 1xx response codes.

Returns:

true if this HTTPResponse is an intermediate message

hasResponseBody

public boolean hasResponseBody()

Determines whether this HTTPResponse has a response body if initiated by the given request. This is true if this response's status has a response body, and the request that initiated this response did not use the HEAD method, or the CONNECT method with a 2xx response status.

A call to this method is equivalent to a call to

 
 response.hasResponseBody(response.getOther());
 
 

Returns:

true if this HTTPResponse should contain a response body

See Also:

• hasResponseBody(HTTPRequest)
• hasResponseBody(int)

hasResponseBody

public boolean hasResponseBody(HTTPRequest request)

Determines whether this HTTPResponse has a response body if initiated by the given request. This is true if this response's status has a response body, and the given request did not use the HEAD method, or the CONNECT method with a 2xx response status.

Parameters:

request - The request to check with. May be null, in which case only the response status is checked

Returns:

true if this HTTPResponse should contain a response body if initiated by the given request

See Also:

• hasResponseBody()
• hasResponseBody(int)

getOther

public HTTPRequest getOther()

Description copied from class: HTTPMessage

Returns the other HTTPMessage of the HTTP message exchange this HTTPMessage is part of. This may be null.

For example, for HTTPRequests, this would be the response of the request, and vice versa.

Overrides:

getOther in class HTTPMessage

Returns:

The other HTTPMessage involved in the HTTP message exchange

hasResponseBody

public static boolean hasResponseBody(int status)

Determines whether responses with the given status code should have a response body. Responses with statuses 1xx, 204, and 304 do not have a response body.

Parameters:

status - A HTTP status code

Returns:

true if a response with the given status code should have a response body

See Also:

• hasResponseBody()