com.yahoo.bard.webservice.web.handlers

Class RequestHandlerUtils

java.lang.Object

com.yahoo.bard.webservice.web.handlers.RequestHandlerUtils

public class RequestHandlerUtils
extends Object

A static utility class for assisting request processing.

Constructor Summary

Constructors

Constructor and Description
RequestHandlerUtils()

Method Summary

Modifier and Type	Method and Description
static javax.ws.rs.core.Response	makeErrorResponse(int statusCode, String reason, String description, DruidQuery<?> druidQuery, com.fasterxml.jackson.databind.ObjectWriter writer) Builds error response for Web Service.
static javax.ws.rs.core.Response	makeErrorResponse(javax.ws.rs.core.Response.StatusType status, DruidQuery<?> druidQuery, Throwable cause, com.fasterxml.jackson.databind.ObjectWriter writer) Builds error response from exception.
static javax.ws.rs.core.Response	makeErrorResponse(javax.ws.rs.core.Response.StatusType status, Throwable cause, com.fasterxml.jackson.databind.ObjectWriter writer) Builds error response from exception without group by.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestHandlerUtils

public RequestHandlerUtils()

Method Detail

makeErrorResponse

public static javax.ws.rs.core.Response makeErrorResponse(javax.ws.rs.core.Response.StatusType status,
                                                          Throwable cause,
                                                          com.fasterxml.jackson.databind.ObjectWriter writer)

Builds error response from exception without group by.

Parameters:

status - the response status

cause - exception

writer - The Writer to use for writing errors

Returns:

Response

makeErrorResponse

public static javax.ws.rs.core.Response makeErrorResponse(javax.ws.rs.core.Response.StatusType status,
                                                          DruidQuery<?> druidQuery,
                                                          Throwable cause,
                                                          com.fasterxml.jackson.databind.ObjectWriter writer)

Builds error response from exception.

Parameters:

status - the response status

druidQuery - failed Druid Query if available or null

cause - exception

writer - The Writer to use for writing errors

Returns:

Response

makeErrorResponse

public static javax.ws.rs.core.Response makeErrorResponse(int statusCode,
                                                          String reason,
                                                          String description,
                                                          DruidQuery<?> druidQuery,
                                                          com.fasterxml.jackson.databind.ObjectWriter writer)

Builds error response for Web Service. Example with a groupBy query:

 {
     "status" : 500
     "statusName" : "INTERNAL_SERVER_ERROR",
     "reason" : "Request failed.",
     "description" : "",
     "druidQuery" : {
         "queryType" : "groupBy",
         "dataSource" : { "name" : "slice_pr_ptf_ptfv_us_pf", "type" : "table" },
         "dimensions" : [ "login_state","product_region","platform","platform_version"],
         "aggregations" : [
             { "name" : "pageViews", "fieldName" : "other_page_views", "type" : "longSum" }
         ],
         "postAggregations" : [ ],
         "intervals" : [ "2014-06-01T00:00:00.000Z/2014-06-01T00:00:00.000Z" ],
         "granularity" : { "type" : "period", "period" : "P1W" }
     }
 }
 

Parameters:

statusCode - the response status code

reason - error type

description - error description

druidQuery - failed Druid Query if available or null

writer - the writer to use for writing errors

Returns:

Response