io.reactivex.netty.protocol.http.client

Class HttpClientResponse<T>

java.lang.Object

io.reactivex.netty.protocol.http.client.HttpClientResponse<T>

Direct Known Subclasses:

HttpClientResponseImpl, WebSocketResponse

public abstract class HttpClientResponse<T>
extends java.lang.Object

HTTP response for HttpClient

Thread safety

This object is not thread-safe and must not be used by multiple threads.

Mutability

Headers and trailing headers can be mutated for this response.

Constructor Summary

Constructors

Constructor and Description
HttpClientResponse()

Method Summary

Modifier and Type	Method and Description
abstract HttpClientResponse<T>	addCookie(io.netty.handler.codec.http.cookie.Cookie cookie) Adds the passed cookie to this response.
abstract HttpClientResponse<T>	addDateHeader(java.lang.CharSequence name, java.util.Date value) Adds the passed header as a date value to this response.
abstract HttpClientResponse<T>	addDateHeader(java.lang.CharSequence name, java.lang.Iterable<java.util.Date> values) Adds multiple date values for the passed header name to this response.
abstract HttpClientResponse<T>	addHeader(java.lang.CharSequence name, java.lang.Iterable<java.lang.Object> values) Adds an HTTP header with the passed name and values to this response.
abstract HttpClientResponse<T>	addHeader(java.lang.CharSequence name, java.lang.Object value) Adds an HTTP header with the passed name and value to this response.
abstract boolean	containsHeader(java.lang.CharSequence name) Checks if there is a header with the passed name in this response.
abstract boolean	containsHeader(java.lang.CharSequence name, java.lang.CharSequence value, boolean ignoreCaseValue) Checks if there is a header with the passed name and value in this response.
abstract rx.Observable<java.lang.Void>	discardContent() Marks the content to be discarded.
abstract java.util.List<java.lang.String>	getAllHeaderValues(java.lang.CharSequence name) Returns the values of headers with the specified name
abstract io.reactivex.netty.channel.ContentSource<T>	getContent() Returns the content as a stream.
abstract io.reactivex.netty.channel.ContentSource<ServerSentEvent>	getContentAsServerSentEvents() Returns the content as a stream of Server sent events.
abstract long	getContentLength() Returns the length of the content.
abstract long	getContentLength(long defaultValue) Returns the length of the content.
abstract java.util.Map<java.lang.String,java.util.Set<io.netty.handler.codec.http.cookie.Cookie>>	getCookies() Returns an immutable map of cookie names and cookies contained in this response.
abstract long	getDateHeader(java.lang.CharSequence name) Returns the date header value with the specified header name.
abstract long	getDateHeader(java.lang.CharSequence name, long defaultValue) Returns the date header value with the specified header name.
abstract java.lang.String	getHeader(java.lang.CharSequence name) Returns the value of a header with the specified name.
abstract java.lang.String	getHeader(java.lang.CharSequence name, java.lang.String defaultValue) Returns the value of a header with the specified name.
abstract java.util.Set<java.lang.String>	getHeaderNames() Returns a new Set that contains the names of all headers in this response.
abstract java.lang.String	getHost(java.lang.String defaultValue) Returns the value of the "Host" header.
abstract java.lang.String	getHostHeader() Returns the value of the "Host" header.
abstract io.netty.handler.codec.http.HttpVersion	getHttpVersion() Returns the HTTP version for this response.
abstract int	getIntHeader(java.lang.CharSequence name) Returns the integer header value with the specified header name.
abstract int	getIntHeader(java.lang.CharSequence name, int defaultValue) Returns the integer header value with the specified header name.
abstract io.netty.handler.codec.http.HttpResponseStatus	getStatus() Returns the HTTP status for this response.
abstract java.util.Iterator<java.util.Map.Entry<java.lang.CharSequence,java.lang.CharSequence>>	headerIterator() Returns an iterator over the header entries.
abstract boolean	isContentLengthSet() Returns true if and only if this response has the content-length header set.
abstract boolean	isKeepAlive() Returns true if and only if the connection can remain open and thus 'kept alive'.
abstract boolean	isTransferEncodingChunked() Checks to see if the transfer encoding of this response is chunked
abstract HttpClientResponse<T>	removeHeader(java.lang.CharSequence name) Removes the passed header from this response.
abstract HttpClientResponse<T>	setDateHeader(java.lang.CharSequence name, java.util.Date value) Overwrites the current value, if any, of the passed header to the passed date value for this response.
abstract HttpClientResponse<T>	setDateHeader(java.lang.CharSequence name, java.lang.Iterable<java.util.Date> values) Overwrites the current value, if any, of the passed header to the passed date values for this response.
abstract HttpClientResponse<T>	setHeader(java.lang.CharSequence name, java.lang.Iterable<java.lang.Object> values) Overwrites the current value, if any, of the passed header to the passed values for this response.
abstract HttpClientResponse<T>	setHeader(java.lang.CharSequence name, java.lang.Object value) Overwrites the current value, if any, of the passed header to the passed value for this response.
java.lang.String	toString()
abstract <TT> HttpClientResponse<TT>	transformContent(rx.Observable.Transformer<T,TT> transformer) Transforms the type of objects read from the content of this response, using the supplied transformer.
abstract io.reactivex.netty.channel.Connection<?,?>	unsafeConnection() Returns the underlying connection on which this response was received.
abstract io.netty.channel.Channel	unsafeNettyChannel() Returns the underlying channel on which this response was received.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClientResponse

public HttpClientResponse()

Method Detail

getHttpVersion

public abstract io.netty.handler.codec.http.HttpVersion getHttpVersion()

Returns the HTTP version for this response.

Returns:

The HTTP version for this response.

getStatus

public abstract io.netty.handler.codec.http.HttpResponseStatus getStatus()

Returns the HTTP status for this response.

Returns:

The HTTP status for this response.

getCookies

public abstract java.util.Map<java.lang.String,java.util.Set<io.netty.handler.codec.http.cookie.Cookie>> getCookies()

Returns an immutable map of cookie names and cookies contained in this response.

Returns:

An immutable map of cookie names and cookies contained in this response.

containsHeader

public abstract boolean containsHeader(java.lang.CharSequence name)

Checks if there is a header with the passed name in this response.

Parameters:

name - Name of the header.

Returns:

true if there is a header with the passed name in this response.

containsHeader

public abstract boolean containsHeader(java.lang.CharSequence name,
                                       java.lang.CharSequence value,
                                       boolean ignoreCaseValue)

Checks if there is a header with the passed name and value in this response.

Parameters:

name - Name of the header.

value - Value of the header.

ignoreCaseValue - true then the value comparision is done ignoring case.

Returns:

true if there is a header with the passed name and value in this response.

headerIterator

public abstract java.util.Iterator<java.util.Map.Entry<java.lang.CharSequence,java.lang.CharSequence>> headerIterator()

Returns an iterator over the header entries. Multiple values for the same header appear as separate entries in the returned iterator.

Returns:

An iterator over the header entries

getHeader

public abstract java.lang.String getHeader(java.lang.CharSequence name)

Returns the value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.

Parameters:

name - The name of the header to search

Returns:

The first header value or null if there is no such header

getHeader

public abstract java.lang.String getHeader(java.lang.CharSequence name,
                                           java.lang.String defaultValue)

Returns the value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.

Parameters:

name - The name of the header to search

defaultValue - Default if the header does not exist.

Returns:

The first header value or defaultValue if there is no such header

getAllHeaderValues

public abstract java.util.List<java.lang.String> getAllHeaderValues(java.lang.CharSequence name)

Returns the values of headers with the specified name

Parameters:

name - The name of the headers to search

Returns:

A List of header values which will be empty if no values are found

getContentLength

public abstract long getContentLength()

Returns the length of the content.

Returns:

the content length

Throws:

java.lang.NumberFormatException - if the message does not have the "Content-Length" header or its value is not a number.

getContentLength

public abstract long getContentLength(long defaultValue)

Returns the length of the content.

Parameters:

defaultValue - Default value if the message does not have a "Content-Length" header or its value is not a number

Returns:

the content length or defaultValue if this message does not have the "Content-Length" header or its value is not a number

getDateHeader

public abstract long getDateHeader(java.lang.CharSequence name)
                            throws java.text.ParseException

Returns the date header value with the specified header name. If there are more than one header value for the specified header name, the first value is returned. The value is parsed as per the HTTP specifications using the format:

"E, dd MMM yyyy HH:mm:ss z"

Parameters:

name - The name of the header to search

Returns:

the header value

Throws:

java.text.ParseException - if there is no such header or the header value is not a formatted date

getDateHeader

public abstract long getDateHeader(java.lang.CharSequence name,
                                   long defaultValue)

Returns the date header value with the specified header name. If there are more than one header value for the specified header name, the first value is returned. The value is parsed as per the HTTP specifications using the format:

"E, dd MMM yyyy HH:mm:ss z"

Parameters:

name - The name of the header to search

defaultValue - Default value if there is no header with this name.

Returns:

the header value or defaultValue if there is no header with this name.

getHostHeader

public abstract java.lang.String getHostHeader()

Returns the value of the "Host" header.

getHost

public abstract java.lang.String getHost(java.lang.String defaultValue)

Returns the value of the "Host" header.

Parameters:

defaultValue - Default if the header does not exist.

Returns:

The value of the "Host" header or defaultValue if there is no such header.

getIntHeader

public abstract int getIntHeader(java.lang.CharSequence name)

Returns the integer header value with the specified header name. If there are more than one header value for the specified header name, the first value is returned.

Parameters:

name - The name of the header to search

Returns:

the header value

Throws:

java.lang.NumberFormatException - if there is no such header or the header value is not a number

getIntHeader

public abstract int getIntHeader(java.lang.CharSequence name,
                                 int defaultValue)

Returns the integer header value with the specified header name. If there are more than one header value for the specified header name, the first value is returned.

Parameters:

name - The name of the header to search

defaultValue - Default if the header does not exist.

Returns:

the header value or the defaultValue if there is no such header or the header value is not a number

isContentLengthSet

public abstract boolean isContentLengthSet()

Returns true if and only if this response has the content-length header set.

isKeepAlive

public abstract boolean isKeepAlive()

Returns true if and only if the connection can remain open and thus 'kept alive'. This methods respects the value of the "Connection" header first and then the return value of HttpVersion.isKeepAliveDefault().

isTransferEncodingChunked

public abstract boolean isTransferEncodingChunked()

Checks to see if the transfer encoding of this response is chunked

Returns:

True if transfer encoding is chunked, otherwise false

getHeaderNames

public abstract java.util.Set<java.lang.String> getHeaderNames()

Returns a new Set that contains the names of all headers in this response. Note that modifying the returned Set will not affect the state of this response.

addHeader

public abstract HttpClientResponse<T> addHeader(java.lang.CharSequence name,
                                                java.lang.Object value)

Adds an HTTP header with the passed name and value to this response.

Parameters:

name - Name of the header.

value - Value for the header.

Returns:

this

addCookie

public abstract HttpClientResponse<T> addCookie(io.netty.handler.codec.http.cookie.Cookie cookie)

Adds the passed cookie to this response.

Parameters:

cookie - Cookie to add.

Returns:

this

addDateHeader

public abstract HttpClientResponse<T> addDateHeader(java.lang.CharSequence name,
                                                    java.util.Date value)

Adds the passed header as a date value to this response. The date is formatted using netty's HttpHeaders.addDateHeader(HttpMessage, CharSequence, Date) which formats the date as per the HTTP specifications into the format:

"E, dd MMM yyyy HH:mm:ss z"

Parameters:

name - Name of the header.

value - Value of the header.

Returns:

this

addDateHeader

public abstract HttpClientResponse<T> addDateHeader(java.lang.CharSequence name,
                                                    java.lang.Iterable<java.util.Date> values)

Adds multiple date values for the passed header name to this response. The date values are formatted using netty's HttpHeaders.addDateHeader(HttpMessage, CharSequence, Date) which formats the date as per the HTTP specifications into the format:

"E, dd MMM yyyy HH:mm:ss z"

Parameters:

name - Name of the header.

values - Values for the header.

Returns:

this

addHeader

public abstract HttpClientResponse<T> addHeader(java.lang.CharSequence name,
                                                java.lang.Iterable<java.lang.Object> values)

Adds an HTTP header with the passed name and values to this response.

Parameters:

name - Name of the header.

values - Values for the header.

Returns:

this

setDateHeader

public abstract HttpClientResponse<T> setDateHeader(java.lang.CharSequence name,
                                                    java.util.Date value)

Overwrites the current value, if any, of the passed header to the passed date value for this response. The date is formatted using netty's HttpHeaders.addDateHeader(HttpMessage, CharSequence, Date) which formats the date as per the HTTP specifications into the format:

"E, dd MMM yyyy HH:mm:ss z"

Parameters:

name - Name of the header.

value - Value of the header.

Returns:

this

setHeader

public abstract HttpClientResponse<T> setHeader(java.lang.CharSequence name,
                                                java.lang.Object value)

Overwrites the current value, if any, of the passed header to the passed value for this response.

Parameters:

name - Name of the header.

value - Value of the header.

Returns:

this

setDateHeader

public abstract HttpClientResponse<T> setDateHeader(java.lang.CharSequence name,
                                                    java.lang.Iterable<java.util.Date> values)

Overwrites the current value, if any, of the passed header to the passed date values for this response. The date is formatted using netty's HttpHeaders.addDateHeader(HttpMessage, CharSequence, Date) which formats the date as per the HTTP specifications into the format:

"E, dd MMM yyyy HH:mm:ss z"

Parameters:

name - Name of the header.

values - Values of the header.

Returns:

this

setHeader

public abstract HttpClientResponse<T> setHeader(java.lang.CharSequence name,
                                                java.lang.Iterable<java.lang.Object> values)

Overwrites the current value, if any, of the passed header to the passed values for this response.

Parameters:

name - Name of the header.

values - Values of the header.

Returns:

this

removeHeader

public abstract HttpClientResponse<T> removeHeader(java.lang.CharSequence name)

Removes the passed header from this response.

Parameters:

name - Name of the header.

Returns:

this

getContentAsServerSentEvents

public abstract io.reactivex.netty.channel.ContentSource<ServerSentEvent> getContentAsServerSentEvents()

Returns the content as a stream of Server sent events. There can only be one Subscriber to the returned Observable, any subsequent subscriptions will get an error.

Returns:

Stream of content as ServerSentEvent messages.

getContent

public abstract io.reactivex.netty.channel.ContentSource<T> getContent()

Returns the content as a stream. There can only be one Subscriber to the returned Observable, any subsequent subscriptions will get an error.

Returns:

Stream of content.

discardContent

public abstract rx.Observable<java.lang.Void> discardContent()

Marks the content to be discarded. This means that the content can not be read from this response from now.

Returns:

An Observable, subscription to which will discard the content. This Observable will error/complete when the content errors/completes and unsubscription from here will unsubscribe from the content.

transformContent

public abstract <TT> HttpClientResponse<TT> transformContent(rx.Observable.Transformer<T,TT> transformer)

Transforms the type of objects read from the content of this response, using the supplied transformer.

Returns:

A new instance of HttpClientResponse with transformed content.

unsafeNettyChannel

public abstract io.netty.channel.Channel unsafeNettyChannel()

Returns the underlying channel on which this response was received.

Returns:

The underlying channel on which this response was received.

unsafeConnection

public abstract io.reactivex.netty.channel.Connection<?,?> unsafeConnection()

Returns the underlying connection on which this response was received.

Returns:

The underlying connection on which this response was received.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object