org.hawkular.metrics.api.servlet.rx

Class ObservableServlet

java.lang.Object

org.hawkular.metrics.api.servlet.rx.ObservableServlet

public class ObservableServlet
extends Object

An Observable interface to Servlet API

Author:

Jitendra Kotamraju, Michael Burman

Constructor Summary

Constructors

Constructor and Description
ObservableServlet()

Method Summary

Modifier and Type	Method and Description
static rx.Observable<Void>	create(javax.servlet.ServletOutputStream out) Observes ServletOutputStream.
static rx.Observable<Void>	write(rx.Observable<byte[]> data, javax.servlet.ServletOutputStream out) Writes the given Observable data to ServletOutputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObservableServlet

public ObservableServlet()

Method Detail

create

public static rx.Observable<Void> create(javax.servlet.ServletOutputStream out)

Observes ServletOutputStream.

This method uses Servlet 3.1 non-blocking API callback mechanisms. When the container notifies that HTTP response can be written, the subscribed Observer's onNext method is invoked.

Before calling this method, a web application must put the corresponding HTTP request into asynchronous mode.

Parameters:

out - servlet output stream

Returns:

Observable of HTTP response write ready events

write

public static rx.Observable<Void> write(rx.Observable<byte[]> data,
                                        javax.servlet.ServletOutputStream out)

Writes the given Observable data to ServletOutputStream.

This method uses Servlet 3.1 non-blocking API callback mechanisms. When the HTTP request data becomes available to be read, the subscribed Observer's onNext method is invoked. Similarly, when all data for the HTTP request has been read, the subscribed Observer's onCompleted method is invoked.

Before calling this method, a web application must put the corresponding HTTP request into asynchronous mode.

Parameters:

data -

out - servlet output stream

Returns: