io.reactivex.netty.protocol.http.server

Class HttpServerResponse<C>

java.lang.Object

rx.Observable<java.lang.Void>

io.reactivex.netty.protocol.http.server.ResponseContentWriter<C>

io.reactivex.netty.protocol.http.server.HttpServerResponse<C>

Type Parameters:

C - The type of objects written as the content of the response.

Direct Known Subclasses:

HttpServerResponseImpl

public abstract class HttpServerResponse<C>
extends ResponseContentWriter<C>

An HTTP server response.

Thread safety

This object is not thread safe and should not be accessed from multiple threads.

Nested Class Summary

Nested classes/interfaces inherited from class rx.Observable

rx.Observable.OnSubscribe<T>, rx.Observable.Operator<R,T>, rx.Observable.Transformer<T,R>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpServerResponse(rx.Observable.OnSubscribe<java.lang.Void> f)

Method Summary

Modifier and Type	Method and Description
abstract WebSocketHandshaker	acceptWebSocketUpgrade(WebSocketHandler handler) Accepts the upgrade to websockets, if requested and after sending a successful handshake response, invokes the passed handler to handle the websocket connection.
abstract HttpServerResponse<C>	addCookie(io.netty.handler.codec.http.cookie.Cookie cookie) Adds the passed cookie to this response.
abstract HttpServerResponse<C>	addDateHeader(java.lang.CharSequence name, java.util.Date value) Adds the passed header as a date value to this response.
abstract HttpServerResponse<C>	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 HttpServerResponse<C>	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 HttpServerResponse<C>	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>	dispose() Disposes this response.
abstract HttpServerResponse<C>	flushOnlyOnReadComplete() This is a performance optimization to not flush the channel on every response send.
abstract java.util.List<java.lang.String>	getAllHeaderValues(java.lang.CharSequence name) Returns the values of headers with the specified name
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 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 status of this response.
abstract HttpServerResponse<C>	removeHeader(java.lang.CharSequence name) Removes the passed header from this response.
abstract ResponseContentWriter<C>	sendHeaders() Sends the headers for this response when the returned Observable is subscribed.
abstract HttpServerResponse<C>	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 HttpServerResponse<C>	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 HttpServerResponse<C>	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 HttpServerResponse<C>	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.
abstract HttpServerResponse<C>	setStatus(io.netty.handler.codec.http.HttpResponseStatus status) Sets the status for the response.
abstract HttpServerResponse<C>	setTransferEncodingChunked() Sets the HTTP transfer encoding to chunked for this response.
abstract <CC> HttpServerResponse<CC>	transformContent(io.reactivex.netty.channel.AllocatingTransformer<CC,C> transformer) Creates a new HttpServerResponse instance modifying the content type using the passed transformer.
abstract HttpServerResponse<ServerSentEvent>	transformToServerSentEvents() Converts this response to enable writing ServerSentEvents.
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 io.reactivex.netty.protocol.http.server.ResponseContentWriter

write, write, write, write, writeAndFlushOnEach, writeBytes, writeBytes, writeBytes, writeBytes, writeBytesAndFlushOnEach, writeString, writeString, writeString, writeString, writeStringAndFlushOnEach

Methods inherited from class rx.Observable

all, amb, amb, amb, amb, amb, amb, amb, amb, amb, ambWith, asObservable, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, cache, cache, cast, collect, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, compose, concat, concat, concat, concat, concat, concat, concat, concat, concat, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatMap, concatMapEager, concatMapEager, concatWith, contains, count, countLong, create, debounce, debounce, debounce, defaultIfEmpty, defer, delay, delay, delay, delay, delaySubscription, delaySubscription, delaySubscription, dematerialize, distinct, distinct, distinctUntilChanged, distinctUntilChanged, doOnCompleted, doOnEach, doOnEach, doOnError, doOnNext, doOnRequest, doOnSubscribe, doOnTerminate, doOnUnsubscribe, elementAt, elementAtOrDefault, empty, error, exists, extend, filter, finallyDo, first, first, firstOrDefault, firstOrDefault, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMapIterable, flatMapIterable, forEach, forEach, forEach, from, from, from, from, from, fromCallable, groupBy, groupBy, groupJoin, ignoreElements, interval, interval, interval, interval, isEmpty, join, just, just, just, just, just, just, just, just, just, just, last, last, lastOrDefault, lastOrDefault, lift, limit, map, materialize, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeWith, nest, never, observeOn, ofType, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureDrop, onBackpressureDrop, onBackpressureLatest, onErrorResumeNext, onErrorResumeNext, onErrorReturn, onExceptionResumeNext, publish, publish, range, range, reduce, reduce, repeat, repeat, repeat, repeat, repeatWhen, repeatWhen, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, retry, retry, retry, retryWhen, retryWhen, sample, sample, sample, scan, scan, sequenceEqual, sequenceEqual, serialize, share, single, single, singleOrDefault, singleOrDefault, skip, skip, skip, skipLast, skipLast, skipLast, skipUntil, skipWhile, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, subscribe, subscribe, subscribe, subscribe, subscribe, subscribe, subscribeOn, switchIfEmpty, switchMap, switchOnNext, take, take, take, takeFirst, takeLast, takeLast, takeLast, takeLast, takeLast, takeLastBuffer, takeLastBuffer, takeLastBuffer, takeLastBuffer, takeLastBuffer, takeUntil, takeUntil, takeWhile, throttleFirst, throttleFirst, throttleLast, throttleLast, throttleWithTimeout, throttleWithTimeout, timeInterval, timeInterval, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timer, timer, timer, timer, timestamp, timestamp, toBlocking, toList, toMap, toMap, toMap, toMultimap, toMultimap, toMultimap, toMultimap, toSingle, toSortedList, toSortedList, toSortedList, toSortedList, unsafeSubscribe, unsubscribeOn, using, using, window, window, window, window, window, window, window, window, window, window, window, window, withLatestFrom, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zipWith, zipWith

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpServerResponse

protected HttpServerResponse(rx.Observable.OnSubscribe<java.lang.Void> f)

Method Detail

getStatus

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

Returns the status of this response. If the status is not explicitly set, the default value is HttpResponseStatus.OK

Returns:

The status of 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.

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

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.

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

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 HttpServerResponse<C> 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 HttpServerResponse<C> 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 HttpServerResponse<C> 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 HttpServerResponse<C> 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 HttpServerResponse<C> 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 HttpServerResponse<C> 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 HttpServerResponse<C> 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 HttpServerResponse<C> 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 HttpServerResponse<C> 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 HttpServerResponse<C> removeHeader(java.lang.CharSequence name)

Removes the passed header from this response.

Parameters:

name - Name of the header.

Returns:

this

setStatus

public abstract HttpServerResponse<C> setStatus(io.netty.handler.codec.http.HttpResponseStatus status)

Sets the status for the response.

Parameters:

status - Status to set.

Returns:

this

setTransferEncodingChunked

public abstract HttpServerResponse<C> setTransferEncodingChunked()

Sets the HTTP transfer encoding to chunked for this response. This delegates to HttpHeaders.setTransferEncodingChunked(HttpMessage)

Returns:

this

flushOnlyOnReadComplete

public abstract HttpServerResponse<C> flushOnlyOnReadComplete()

This is a performance optimization to not flush the channel on every response send.

When NOT to use

This can be used only when the processing for a server is not asynchronous, in which case, one would have to flush the responses written explicitly (done on completion of the Observable written). Something like this:

     resp.sendHeaders()
         .writeStringAndFlushOnEach(Observable.interval(1, TimeUnit.SECONDS))
                                              .map(aLong -> "Interval =>" + aLong)
                                   )
     

When to use

This can be used when the response is written synchronously from a RequestHandler, something like:

     response.writeString(Observable.just("Hello world");
     

When set, this will make the channel to be flushed only when all the requests available on the channel are read. Thus, making it possible to do a gathering write for all pipelined requests on a connection. This reduces the number of system calls and is helpful in "Hello World" benchmarks.

sendHeaders

public abstract ResponseContentWriter<C> sendHeaders()

Sends the headers for this response when the returned Observable is subscribed. Alternatively, one can continue to write contents using the returned ResponseContentWriter

Returns:

ResponseContentWriter which can be subscribed to only send the headers or to write payload.

transformToServerSentEvents

@Experimental
public abstract HttpServerResponse<ServerSentEvent> transformToServerSentEvents()

Converts this response to enable writing ServerSentEvents.

Returns:

This response with writing of ServerSentEvent enabled.

transformContent

public abstract <CC> HttpServerResponse<CC> transformContent(io.reactivex.netty.channel.AllocatingTransformer<CC,C> transformer)

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

Type Parameters:

CC - New type of the content.

Parameters:

transformer - Transformer to transform the content stream.

Returns:

A new instance of HttpServerResponse with the transformed content stream.

acceptWebSocketUpgrade

public abstract WebSocketHandshaker acceptWebSocketUpgrade(WebSocketHandler handler)

Accepts the upgrade to websockets, if requested and after sending a successful handshake response, invokes the passed handler to handle the websocket connection. If any changes to this response are required for the handshake, they should be done before invoking this method.

Returns:

WebSocketHandshaker for sending a handshake to the client. Subscription to the handshaker, will send the handshake.

dispose

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

Disposes this response. If the response is not yet set then this will attempt to send an error response if the connection is still open.

Returns:

An Observable, subscription to which will dispose this response.

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.