com.yahoo.bard.webservice.web.responseprocessors

Class MappingResponseProcessor

java.lang.Object

com.yahoo.bard.webservice.web.responseprocessors.MappingResponseProcessor

All Implemented Interfaces:

ResponseProcessor

Direct Known Subclasses:

ResultSetResponseProcessor

public abstract class MappingResponseProcessor
extends Object
implements ResponseProcessor

Response Processor which will perform result set mapping.

Field Summary

Fields

Modifier and Type	Field and Description
protected DataApiRequest	apiRequest
protected javax.ws.rs.core.MultivaluedHashMap<String,Serializable>	headers
protected List<ResultSetMapper>	mappers
protected ObjectMappersSuite	objectMappers
protected ResponseContext	responseContext

Constructor Summary

Constructors

Constructor and Description
MappingResponseProcessor(DataApiRequest apiRequest, ObjectMappersSuite objectMappers) Constructor.

Method Summary

Modifier and Type	Method and Description
protected javax.ws.rs.core.MultivaluedHashMap<String,Serializable>	buildHeaderList() Create headers which belong in the response.
protected List<ResultSetMapper>	buildResultSetMapperList(DataApiRequest apiRequest) Extract all ResultSetMappers from the api request.
DataApiRequest	getDataApiRequest()
javax.ws.rs.core.MultivaluedMap<String,Serializable>	getHeaders()
List<ResultSetMapper>	getMappers()
protected ObjectMappersSuite	getObjectMappers()
ResponseContext	getResponseContext() The response context allows state to be injected from construction and visible across response processor layers as necessary.
HttpErrorCallback	getStandardError(rx.subjects.Subject responseEmitter, DruidAggregationQuery<?> druidQuery) Get the standard error callback.
FailureCallback	getStandardFailure(rx.subjects.Subject responseEmitter, DruidAggregationQuery<?> druidQuery) Get the standard failure callback.
protected ResultSet	mapResultSet(ResultSet resultSet) Builds a mapped result set by running through ResultSetMappers.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yahoo.bard.webservice.web.responseprocessors.ResponseProcessor

getErrorCallback, getFailureCallback, processResponse

Field Detail

apiRequest

protected final DataApiRequest apiRequest

responseContext

protected final ResponseContext responseContext

headers

protected final javax.ws.rs.core.MultivaluedHashMap<String,Serializable> headers

mappers

protected final List<ResultSetMapper> mappers

objectMappers

protected final ObjectMappersSuite objectMappers

Constructor Detail

MappingResponseProcessor

public MappingResponseProcessor(DataApiRequest apiRequest,
                                ObjectMappersSuite objectMappers)

Constructor.

Parameters:

apiRequest - The request for which the response is being processed

objectMappers - Jackson mappers to use for processing JSON

Method Detail

buildResultSetMapperList

protected List<ResultSetMapper> buildResultSetMapperList(DataApiRequest apiRequest)

Extract all ResultSetMappers from the api request.

Parameters:

apiRequest - The query api request

Returns:

a list of all mappers for this apirequest

buildHeaderList

protected javax.ws.rs.core.MultivaluedHashMap<String,Serializable> buildHeaderList()

Create headers which belong in the response.

Returns:

A list of HTTP headers to attach to the response

mapResultSet

protected ResultSet mapResultSet(ResultSet resultSet)

Builds a mapped result set by running through ResultSetMappers.

Parameters:

resultSet - The result set being processed

Returns:

a mapped resultSet

getStandardError

public HttpErrorCallback getStandardError(rx.subjects.Subject responseEmitter,
                                          DruidAggregationQuery<?> druidQuery)

Get the standard error callback.

Parameters:

responseEmitter - Channel to send the error response to

druidQuery - Query for which we got an error

Returns:

the standard error callback

getStandardFailure

public FailureCallback getStandardFailure(rx.subjects.Subject responseEmitter,
                                          DruidAggregationQuery<?> druidQuery)

Get the standard failure callback.

Parameters:

responseEmitter - Channel to send the response to

druidQuery - Query for which we got a failure

Returns:

the standard failure callback

getResponseContext

public ResponseContext getResponseContext()

Description copied from interface: ResponseProcessor

The response context allows state to be injected from construction and visible across response processor layers as necessary.

Specified by:

getResponseContext in interface ResponseProcessor

Returns:

The context data

getHeaders

public javax.ws.rs.core.MultivaluedMap<String,Serializable> getHeaders()

getMappers

public List<ResultSetMapper> getMappers()

getDataApiRequest

public DataApiRequest getDataApiRequest()

getObjectMappers

protected ObjectMappersSuite getObjectMappers()