com.yahoo.bard.webservice.web.endpoints

Class EndpointServlet

java.lang.Object

com.yahoo.bard.webservice.web.endpoints.EndpointServlet

Direct Known Subclasses:

DimensionsServlet, FeatureFlagsServlet, JobsServlet, MetricsServlet, SlicesServlet, TablesServlet

public abstract class EndpointServlet
extends Object

Abstract class making available the common code between the servlets that serve the endpoints.

Field Summary

Fields

Modifier and Type	Field and Description
protected ObjectMappersSuite	objectMappers

Constructor Summary

Constructors

Constructor and Description
EndpointServlet(ObjectMappersSuite objectMappers) Constructor.

Method Summary

Modifier and Type	Method and Description
protected <T> javax.ws.rs.core.Response	formatResponse(ApiRequest apiRequest, Stream<T> rows, String jsonName, List<String> csvColumnNames) Format and build the response as JSON or CSV.

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

Constructor Detail

EndpointServlet

@Inject
public EndpointServlet(ObjectMappersSuite objectMappers)

Constructor.

Parameters:

objectMappers - Shared JSON tools

Method Detail

formatResponse

protected <T> javax.ws.rs.core.Response formatResponse(ApiRequest apiRequest,
                                                       Stream<T> rows,
                                                       String jsonName,
                                                       List<String> csvColumnNames)

Format and build the response as JSON or CSV.

Type Parameters:

T - The type of rows being processed

Parameters:

apiRequest - The api request object

rows - The stream that describes the data to be formatted

jsonName - Top-level title for the JSON data

csvColumnNames - Header for the CSV data

Returns:

The updated response builder with the new link header added