com.yahoo.bard.webservice.data

Class HttpResponseMaker

java.lang.Object

com.yahoo.bard.webservice.data.HttpResponseMaker

@Singleton
public class HttpResponseMaker
extends Object

Translates a PreResponse into an HTTP Response containing the results of a query.

Field Summary

Fields

Modifier and Type	Field and Description
protected DimensionDictionary	dimensionDictionary
protected ObjectMappersSuite	objectMappers
protected ResponseWriter	responseWriter

Constructor Summary

Constructors

Constructor and Description
HttpResponseMaker(ObjectMappersSuite objectMappers, DimensionDictionary dimensionDictionary, ResponseWriter responseWriter) Class constructor.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	buildErrorResponse(int statusCode, String reason, String description, DruidQuery<?> druidQuery) Prepare Response object from error details with reason and description.
javax.ws.rs.core.Response	buildResponse(PreResponse preResponse, ApiRequest apiRequest) Build complete response.
protected ResponseData	buildResponseData(ResultSet resultSet, LinkedHashSet<String> apiMetricColumnNames, LinkedHashMap<Dimension,LinkedHashSet<DimensionField>> requestedApiDimensionFields, SimplifiedIntervalList partialIntervals, SimplifiedIntervalList volatileIntervals, Pagination pagination, Map<String,URI> paginationLinks) Builds a ResponseData object.

Methods inherited from class java.lang.Object

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

Field Detail

objectMappers

protected final ObjectMappersSuite objectMappers

dimensionDictionary

protected final DimensionDictionary dimensionDictionary

responseWriter

protected final ResponseWriter responseWriter

Constructor Detail

HttpResponseMaker

@Inject
public HttpResponseMaker(ObjectMappersSuite objectMappers,
                                 DimensionDictionary dimensionDictionary,
                                 ResponseWriter responseWriter)

Class constructor.

Parameters:

objectMappers - Mappers object for serialization

dimensionDictionary - The dimension dictionary from which to look up dimensions by name

responseWriter - Serializer which takes responseData and apiRequest, outputs formatted data stream.

Method Detail

buildResponse

public javax.ws.rs.core.Response buildResponse(PreResponse preResponse,
                                               ApiRequest apiRequest)

Build complete response.

Parameters:

preResponse - PreResponse object which contains result set, response context and headers

apiRequest - ApiRequest object which contains request related information

Returns:

Completely built response with headers and result set

buildErrorResponse

public javax.ws.rs.core.Response buildErrorResponse(int statusCode,
                                                    String reason,
                                                    String description,
                                                    DruidQuery<?> druidQuery)

Prepare Response object from error details with reason and description.

Parameters:

statusCode - Error status code

reason - Brief reason about the error

description - Description of the error

druidQuery - Druid query associated with the an error

Returns:

Publishable Response object

buildResponseData

protected ResponseData buildResponseData(ResultSet resultSet,
                                         LinkedHashSet<String> apiMetricColumnNames,
                                         LinkedHashMap<Dimension,LinkedHashSet<DimensionField>> requestedApiDimensionFields,
                                         SimplifiedIntervalList partialIntervals,
                                         SimplifiedIntervalList volatileIntervals,
                                         Pagination pagination,
                                         Map<String,URI> paginationLinks)

Builds a ResponseData object.

Parameters:

resultSet - ResultSet to turn into response

apiMetricColumnNames - The names of the logical metrics requested

requestedApiDimensionFields - The fields for each dimension that should be shown in the response

partialIntervals - intervals over which partial data exists

volatileIntervals - intervals over which data is understood as 'best-to-date'

pagination - The object containing the pagination information. Null if we are not paginating

paginationLinks - A mapping from link names to links to be added to the end of the JSON response

Returns:

a new ResponseData object