io.reactivex.netty.protocol.http.server

Class HttpServerRequest<T>

java.lang.Object

io.reactivex.netty.protocol.http.server.HttpServerRequest<T>

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

HTTP server request

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
HttpServerRequest()

Method Summary

Modifier and Type	Method and Description
abstract HttpServerRequest<T>	addCookie(io.netty.handler.codec.http.cookie.Cookie cookie) Adds the passed cookie to this request.
abstract HttpServerRequest<T>	addDateHeader(java.lang.CharSequence name, java.util.Date value) Adds the passed header as a date value to this request.
abstract HttpServerRequest<T>	addDateHeader(java.lang.CharSequence name, java.lang.Iterable<java.util.Date> values) Adds multiple date values for the passed header name to this request.
abstract HttpServerRequest<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 request.
abstract HttpServerRequest<T>	addHeader(java.lang.CharSequence name, java.lang.Object value) Adds an HTTP header with the passed name and value to this request.
abstract boolean	containsHeader(java.lang.CharSequence name) Checks if there is a header with the passed name in this request.
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 request.
abstract rx.Observable<java.lang.Void>	discardContent() Subscribes to the content and discards.
abstract rx.Observable<java.lang.Void>	dispose() Disposes this request.
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 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 request.
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	getDecodedPath() Returns the decoded URI path for this request.
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 request.
abstract java.lang.String	getHostHeader() Returns the value of the "Host" header.
abstract java.lang.String	getHostHeader(java.lang.String defaultValue) Returns the value of the "Host" header.
abstract io.netty.handler.codec.http.HttpMethod	getHttpMethod() Returns the HTTP method for this request.
abstract io.netty.handler.codec.http.HttpVersion	getHttpVersion() Returns the HTTP version for this request.
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 java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getQueryParameters() Returns an immutable map of query parameter names and values contained in this request.
abstract java.lang.String	getRawQueryString() Returns the query string for this request.
abstract java.lang.String	getUri() Returns the raw URI for the request, including path and query parameters.
abstract java.util.Iterator<java.util.Map.Entry<java.lang.CharSequence,java.lang.CharSequence>>	headerIterator() Returns an iterator over the header entries.
abstract boolean	is100ContinueExpected() Returns true if and only if this request contains the "Expect: 100-continue" header.
abstract boolean	isContentLengthSet() Returns true if and only if this request 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 request is chunked
abstract boolean	isWebSocketUpgradeRequested() Checks to see if upgrade to websocket protocol is requested by this HTTP request.
abstract HttpServerRequest<T>	removeHeader(java.lang.CharSequence name) Removes the passed header from this request.
abstract HttpServerRequest<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 request.
abstract HttpServerRequest<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 request.
abstract HttpServerRequest<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 request.
abstract HttpServerRequest<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 request.
java.lang.String	toString()
abstract <X> HttpServerRequest<X>	transformContent(rx.Observable.Transformer<T,X> transformer) Creates a new HttpServerRequest instance modifying the content type using the passed transformer.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpServerRequest

public HttpServerRequest()

Method Detail

getHttpMethod

public abstract io.netty.handler.codec.http.HttpMethod getHttpMethod()

Returns the HTTP method for this request.

Returns:

The HTTP method for this request.

getHttpVersion

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

Returns the HTTP version for this request.

Returns:

The HTTP version for this request.

getUri

public abstract java.lang.String getUri()

Returns the raw URI for the request, including path and query parameters. The URI is not decoded.

Returns:

The raw URI for the request.

getDecodedPath

public abstract java.lang.String getDecodedPath()

Returns the decoded URI path for this request.

Returns:

The decoded URI path for this request.

getRawQueryString

public abstract java.lang.String getRawQueryString()

Returns the query string for this request. The query string is not decoded.

Returns:

The query string for this request.

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

Returns:

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

getQueryParameters

public abstract java.util.Map<java.lang.String,java.util.List<java.lang.String>> getQueryParameters()

Returns an immutable map of query parameter names and values contained in this request. The names and values for the query parameters will be decoded.

Returns:

An immutable map of query parameter names and values contained in this request.

containsHeader

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

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

Parameters:

name - Name of the header.

Returns:

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

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

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

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)

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

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.

getHostHeader

public abstract java.lang.String getHostHeader(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

is100ContinueExpected

public abstract boolean is100ContinueExpected()

Returns true if and only if this request contains the "Expect: 100-continue" header.

isContentLengthSet

public abstract boolean isContentLengthSet()

Returns true if and only if this request 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 request 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 request. Note that modifying the returned Set will not affect the state of this request.

addHeader

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

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

Parameters:

name - Name of the header.

value - Value for the header.

Returns:

this

addCookie

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

Adds the passed cookie to this request.

Parameters:

cookie - Cookie to add.

Returns:

this

addDateHeader

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

Adds the passed header as a date value to this request. 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 HttpServerRequest<T> addDateHeader(java.lang.CharSequence name,
                                                   java.lang.Iterable<java.util.Date> values)

Adds multiple date values for the passed header name to this request. 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 HttpServerRequest<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 request.

Parameters:

name - Name of the header.

values - Values for the header.

Returns:

this

setDateHeader

public abstract HttpServerRequest<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 request. 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 HttpServerRequest<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 request.

Parameters:

name - Name of the header.

value - Value of the header.

Returns:

this

setDateHeader

public abstract HttpServerRequest<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 request. 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 HttpServerRequest<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 request.

Parameters:

name - Name of the header.

values - Values of the header.

Returns:

this

removeHeader

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

Removes the passed header from this request.

Parameters:

name - Name of the header.

Returns:

this

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

Subscribes to the content and discards.

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.

dispose

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

Disposes this request. If the content is not yet subscribed, will subscribe and discard the same.

Returns:

An Observable, subscription to which will dispose this request. If the content is not yet subscribed then this is the same as discardContent().

isWebSocketUpgradeRequested

public abstract boolean isWebSocketUpgradeRequested()

Checks to see if upgrade to websocket protocol is requested by this HTTP request.

Returns:

true if upgrade to websocket is requested.

transformContent

public abstract <X> HttpServerRequest<X> transformContent(rx.Observable.Transformer<T,X> transformer)

Creates a new HttpServerRequest instance modifying the content type using the passed transformer.

Type Parameters:

X - New type of the content.

Parameters:

transformer - Transformer to transform the content stream.

Returns:

A new instance of HttpServerRequest with the transformed content stream.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object