com.yahoo.bard.webservice.data

Class HttpResponseChannel

java.lang.Object

com.yahoo.bard.webservice.data.HttpResponseChannel

All Implemented Interfaces:

rx.Observer<PreResponse>

public class HttpResponseChannel
extends Object
implements rx.Observer<PreResponse>

Converts preResponse/errorResponse into HTTP Responses, and ships them immediately to the client.

Constructor Summary

Constructors

Constructor and Description
HttpResponseChannel(javax.ws.rs.container.AsyncResponse asyncResponse, ApiRequest apiRequest, HttpResponseMaker httpResponseMaker) Constructor.

Method Summary

Modifier and Type	Method and Description
void	onCompleted()
void	onError(Throwable responseException) Method to handle an error case from its observables.
void	onNext(PreResponse preResponse)

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpResponseChannel

public HttpResponseChannel(javax.ws.rs.container.AsyncResponse asyncResponse,
                           ApiRequest apiRequest,
                           HttpResponseMaker httpResponseMaker)

Constructor.

Parameters:

asyncResponse - An async response that we can use to respond asynchronously

apiRequest - Api request object with all the associated info with it

httpResponseMaker - Helper class instance to prepare the response object

Method Detail

onCompleted

public void onCompleted()

Specified by:

onCompleted in interface rx.Observer<PreResponse>

onError

public void onError(Throwable responseException)

Method to handle an error case from its observables. Default argument for this method is Throwable. Customized this argument as Exception which contains the attributes to prepare the error Response. If the throwable is not the type of `ResponseException`, then it will be re-thrown as RuntimeException.

Specified by:

onError in interface rx.Observer<PreResponse>

Parameters:

responseException - An object contains error response attributes wrapped along with an Exception object

onNext

public void onNext(PreResponse preResponse)

Specified by:

onNext in interface rx.Observer<PreResponse>