com.yahoo.bard.webservice.web.endpoints

Class MetricsServlet

java.lang.Object

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

com.yahoo.bard.webservice.web.endpoints.MetricsServlet

@Path(value="/metrics")
 @Singleton
public class MetricsServlet
extends EndpointServlet

Resource code for metric resource endpoints.

Field Summary

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

objectMappers

Constructor Summary

Constructors

Constructor and Description
MetricsServlet(MetricDictionary metricDictionary, LogicalTableDictionary logicalTableDictionary, RequestMapper requestMapper, ObjectMappersSuite objectMappers, ResponseFormatResolver formatResolver) Constructor.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getAllLogicalMetrics(String perPage, String page, String format, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.container.ContainerRequestContext containerRequestContext) Get all the logical metrics as a summary list.
static Map<String,Object>	getLogicalMetricFullView(LogicalMetric logicalMetric, LogicalTableDictionary logicalTableDictionary, javax.ws.rs.core.UriInfo uriInfo) Get the full view of the logical metric.
static Set<Map<String,String>>	getLogicalMetricListSummaryView(Collection<LogicalMetric> logicalMetrics, javax.ws.rs.core.UriInfo uriInfo) Get the summary list view of the logical metrics.
static Map<String,String>	getLogicalMetricSummaryView(LogicalMetric logicalMetric, javax.ws.rs.core.UriInfo uriInfo) Get the summary view of the logical metric.
static String	getLogicalMetricUrl(LogicalMetric logicalMetric, javax.ws.rs.core.UriInfo uriInfo) Get the URL of the logical metric.
javax.ws.rs.core.Response	getMetric(String metricName, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.container.ContainerRequestContext containerRequestContext) Get the details of a specific logical metric.

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

MetricsServlet

@Inject
public MetricsServlet(MetricDictionary metricDictionary,
                              LogicalTableDictionary logicalTableDictionary,
                              @Named(value="metricsApiRequestMapper")
                              RequestMapper requestMapper,
                              ObjectMappersSuite objectMappers,
                              ResponseFormatResolver formatResolver)

Constructor.

Parameters:

metricDictionary - Metrics to know about

logicalTableDictionary - Logical tables to know about

requestMapper - Mapper to change the API request if needed

objectMappers - JSON tools

formatResolver - The formatResolver for determining correct response format

Method Detail

getAllLogicalMetrics

@GET
 @Timed
public javax.ws.rs.core.Response getAllLogicalMetrics(@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)

Get all the logical metrics as a summary list.

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:

The list of logical metrics

{ "metrics": <List of Metric Summaries> }

See Also:

getLogicalMetricListSummaryView(Collection, UriInfo)

getMetric

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

Get the details of a specific logical metric.

Parameters:

metricName - Logical metric name

uriInfo - UriInfo of the request

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

Returns:

The logical metric

See Also:

getLogicalMetricFullView(LogicalMetric, LogicalTableDictionary, UriInfo)

getLogicalMetricListSummaryView

public static Set<Map<String,String>> getLogicalMetricListSummaryView(Collection<LogicalMetric> logicalMetrics,
                                                                      javax.ws.rs.core.UriInfo uriInfo)

Get the summary list view of the logical metrics.

Parameters:

logicalMetrics - Collection of logical metrics to get the summary view for

uriInfo - UriInfo of the request

Returns:

Summary list view of the logical metrics

getLogicalMetricSummaryView

public static Map<String,String> getLogicalMetricSummaryView(LogicalMetric logicalMetric,
                                                             javax.ws.rs.core.UriInfo uriInfo)

Get the summary view of the logical metric.

Parameters:

logicalMetric - Logical metric to get the view of

uriInfo - UriInfo of the request

Returns:

Summary view of the logical metric

getLogicalMetricFullView

public static Map<String,Object> getLogicalMetricFullView(LogicalMetric logicalMetric,
                                                          LogicalTableDictionary logicalTableDictionary,
                                                          javax.ws.rs.core.UriInfo uriInfo)

Get the full view of the logical metric.

Parameters:

logicalMetric - Logical metric to get the view of

logicalTableDictionary - Logical Table Dictionary to look up the logical tables this metric is on

uriInfo - UriInfo of the request

Returns:

Full view of the logical metric

getLogicalMetricUrl

public static String getLogicalMetricUrl(LogicalMetric logicalMetric,
                                         javax.ws.rs.core.UriInfo uriInfo)

Get the URL of the logical metric.

Parameters:

logicalMetric - Logical metric to get the URL of

uriInfo - URI Info for the request

Returns:

The absolute URL for the logical metric