com.yahoo.bard.webservice.web.endpoints

Class SlicesServlet

java.lang.Object

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

com.yahoo.bard.webservice.web.endpoints.SlicesServlet

@Path(value="/slices")
 @Singleton
public class SlicesServlet
extends EndpointServlet

SlicesServlet supports discovery of performance slices (aka webService PhysicalTables or druid dataSources) and their current data availability intervals. Data intervals impact partial data query routing/slice selection.

Field Summary

Fields inherited from class com.yahoo.bard.webservice.web.endpoints.EndpointServlet

objectMappers

Constructor Summary

Constructors

Constructor and Description
SlicesServlet(PhysicalTableDictionary physicalTableDictionary, RequestMapper requestMapper, DataSourceMetadataService dataSourceMetadataService, ObjectMappersSuite objectMappers, ResponseFormatResolver formatResolver) Constructor.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getSliceBySliceName(String sliceName, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.container.ContainerRequestContext containerRequestContext) Endpoint to get all the dimensions and metrics serviced by a druid slice.
static String	getSliceDetailUrl(String slice, javax.ws.rs.core.UriInfo uriInfo) Get the URL of the slice.
javax.ws.rs.core.Response	getSlices(String perPage, String page, String format, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.container.ContainerRequestContext containerRequestContext) Endpoint to get all the performance slices.

Methods inherited from class com.yahoo.bard.webservice.web.endpoints.EndpointServlet

formatResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

SlicesServlet

@Inject
public SlicesServlet(PhysicalTableDictionary physicalTableDictionary,
                             @Named(value="slicesApiRequestMapper")
                             RequestMapper requestMapper,
                             DataSourceMetadataService dataSourceMetadataService,
                             ObjectMappersSuite objectMappers,
                             ResponseFormatResolver formatResolver)

Constructor.

Parameters:

physicalTableDictionary - Physical Tables that this endpoint is reporting on

requestMapper - Mapper for changing the API request

dataSourceMetadataService - The data source metadata provider

objectMappers - JSON tools

formatResolver - The formatResolver for determining correct response format

Method Detail

getSlices

@GET
 @Timed
public javax.ws.rs.core.Response getSlices(@DefaultValue(value="") @NotNull @QueryParam(value="perPage")
                                                        String perPage,
                                                        @DefaultValue(value="") @NotNull @QueryParam(value="page")
                                                        String page,
                                                        @QueryParam(value="format")
                                                        String format,
                                                        @Context
                                                        javax.ws.rs.core.UriInfo uriInfo,
                                                        @Context
                                                        javax.ws.rs.container.ContainerRequestContext containerRequestContext)

Endpoint to get all the performance slices.

Parameters:

perPage - number of values to return per page

page - the page to start from

format - The name of the output format type

uriInfo - UriInfo of the request

containerRequestContext - The context of data provided by the Jersey container for this request

Returns:

OK(200) else Bad Request(400) Response format:

 
 {
      "slices": [
           { "name" : "slice A", "timeGrain" : "day", "uri" : "http:/.../" },
           { "name" : "slice B", "timeGrain" : "day", "uri" : "http:/.../" }
      ]
 }
 
 

getSliceBySliceName

@GET
 @Timed
 @Produces(value="application/json")
 @Path(value="/{sliceName}")
public javax.ws.rs.core.Response getSliceBySliceName(@PathParam(value="sliceName")
                                                                                                                                    String sliceName,
                                                                                                                                    @Context
                                                                                                                                    javax.ws.rs.core.UriInfo uriInfo,
                                                                                                                                    @Context
                                                                                                                                    javax.ws.rs.container.ContainerRequestContext containerRequestContext)

Endpoint to get all the dimensions and metrics serviced by a druid slice.

Parameters:

sliceName - Physical table name

uriInfo - UriInfo of the request

containerRequestContext - The context of data provided by the Jersey container for this request

Returns:

OK(200) else Bad Request(400). Response format:

 
 {
     "name" : "slice A",
     "timeGrain" : "daily",
     "dimensions" : [
         { "name" : "dimensionA", "uri" : "http://.../" , "intervals" : [ '2010-03-01/2010-10-29'.... ]},
         { "name" : "dimensionB", "uri" : "http://.../" , "intervals" : [ '2010-03-01/2010-10-29'.... ]}
     ],
     "metrics" : [
         { "name" : "metricA", "intervals" : [ '2010-03-01/2010-10-29'.... ]},
         { "name" : "metricB", "intervals" : [ '2010-03-01/2010-10-29'.... ]}
     ]
 }
 
 

getSliceDetailUrl

public static String getSliceDetailUrl(String slice,
                                       javax.ws.rs.core.UriInfo uriInfo)

Get the URL of the slice.

Parameters:

slice - The name of the slice

uriInfo - URI Info for the request

Returns:

The absolute URL for the slice