Allow header accept field as a source of format type

fili-core/src/main/java/com/yahoo/bard/webservice/web/ApiRequest.java

@@ -48,6 +48,7 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.HashMap;
 import java.util.HashSet;
 import java.util.LinkedHashMap;
 import java.util.LinkedHashSet;
@@ -101,6 +102,7 @@ public abstract class ApiRequest {
      * Parses the API request URL and generates the API request object.
      *
      * @param format  response data format JSON or CSV. Default is JSON.
+     * @param headerFormat  The accept field from http request header
      * @param asyncAfter  How long the user is willing to wait for a synchronous request in milliseconds, if null
      * defaults to the system config {@code default_asyncAfter}
      * @param perPage  number of rows to display per page of results. If present in the original request, must be a
@@ -113,13 +115,14 @@ public abstract class ApiRequest {
      */
     public ApiRequest(
             String format,
+            String headerFormat,
             String asyncAfter,
             @NotNull String perPage,
             @NotNull String page,
             UriInfo uriInfo
     ) throws BadApiRequestException {
         this.uriInfo = uriInfo;
-        this.format = generateAcceptFormat(format);
+        this.format = generateAcceptFormat(format, headerFormat);
         this.paginationParameters = generatePaginationParameters(perPage, page);
         this.builder = Response.status(Response.Status.OK);
         this.asyncAfter = generateAsyncAfter(
@@ -134,6 +137,7 @@ public ApiRequest(
      * Parses the API request URL and generates the API request object. Defaults asyncAfter to never.
      *
      * @param format  response data format JSON or CSV. Default is JSON.
+     * @param headerFormat  The accept field from http request header
      * @param perPage  number of rows to display per page of results. If present in the original request, must be a
      * positive integer. If not present, must be the empty string.
      * @param page  desired page of results. If present in the original request, must be a positive integer. If not
@@ -144,11 +148,12 @@ public ApiRequest(
      */
     public ApiRequest(
             String format,
+            final String headerFormat,
             @NotNull String perPage,
             @NotNull String page,
             UriInfo uriInfo
     ) throws BadApiRequestException {
-        this(format, SYNCHRONOUS_REQUEST_FLAG, perPage, page, uriInfo);
+        this(format, headerFormat , SYNCHRONOUS_REQUEST_FLAG, perPage, page, uriInfo);
     }
 
     /**
@@ -588,15 +593,37 @@ protected Map<Dimension, Set<ApiFilter>> generateFilters(
      * Generates the format in which the response data is expected.
      *
      * @param format  Expects a URL format query String.
+     * @param headerFormatString  The accept field from http request header
      *
      * @return Response format type (CSV or JSON).
      * @throws BadApiRequestException if the requested format is not found.
      */
-    protected ResponseFormatType generateAcceptFormat(String format) throws BadApiRequestException {
+    protected ResponseFormatType generateAcceptFormat(
+            String format,
+            final String headerFormatString
+    ) throws BadApiRequestException {
         try {
-            return format == null ?
-                    ResponseFormatType.JSON :
-                    ResponseFormatType.valueOf(format.toUpperCase(Locale.ENGLISH));
+            String headerFormat = null;
+            if (headerFormatString != null) {
+                Map<String, String> acceptFormats = new HashMap<>();
+                acceptFormats.put("application/json", "json");
+                acceptFormats.put("application/vnd.api+json", "jsonapi");
+                acceptFormats.put("text/csv", "csv");
+                for (String acceptFormat : acceptFormats.keySet()) {
+                    if (headerFormatString.contains(acceptFormat)) {
+                        headerFormat = acceptFormats.get(acceptFormat);
+                        break;
+                    }
+                }
+            }
+
+            if (format != null) {
+                return ResponseFormatType.valueOf(format.toUpperCase(Locale.ENGLISH));
+            } else if (headerFormat != null) {
+                return ResponseFormatType.valueOf(headerFormat.toUpperCase(Locale.ENGLISH));
+            } else {
+                return ResponseFormatType.JSON;
+            }
         } catch (IllegalArgumentException e) {
             LOG.error(ACCEPT_FORMAT_INVALID.logFormat(format), e);
             throw new BadApiRequestException(ACCEPT_FORMAT_INVALID.format(format));

fili-core/src/main/java/com/yahoo/bard/webservice/web/DataApiRequest.java

@@ -127,6 +127,7 @@ public class DataApiRequest extends ApiRequest {
      * @param count  count of number of records to be returned in the response
      * @param topN  number of first records per time bucket to be returned in the response
      * @param format  response data format JSON or CSV. Default is JSON.
+     * @param headerFormat  The accept field from http request header
      * @param timeZoneId  a joda time zone id
      * @param asyncAfter  How long the user is willing to wait for a synchronous request in milliseconds
      * @param perPage  number of rows to display per page of results. If present in the original request,
@@ -162,14 +163,15 @@ public DataApiRequest(
             String count,
             String topN,
             String format,
+            String headerFormat,
             String timeZoneId,
             String asyncAfter,
             @NotNull String perPage,
             @NotNull String page,
             UriInfo uriInfo,
             BardConfigResources bardConfigResources
     ) throws BadApiRequestException {
-        super(format, asyncAfter, perPage, page, uriInfo);
+        super(format, headerFormat, asyncAfter, perPage, page, uriInfo);
 
         GranularityParser granularityParser = bardConfigResources.getGranularityParser();
         DimensionDictionary dimensionDictionary = bardConfigResources.getDimensionDictionary();

fili-core/src/main/java/com/yahoo/bard/webservice/web/DimensionsApiRequest.java

@@ -45,6 +45,7 @@ public class DimensionsApiRequest extends ApiRequest {
      * ((field name and operation):((multiple values bounded by [])or(single value))))(followed by , or end of string)
      * }</pre>
      * @param format  response data format JSON or CSV. Default is JSON.
+     * @param headerFormat  The accept field from http request header
      * @param perPage  number of rows to display per page of results. If present in the original request,
      * must be a positive integer. If not present, must be the empty string.
      * @param page  desired page of results. If present in the original request, must be a positive
@@ -64,12 +65,13 @@ public DimensionsApiRequest(
             String dimension,
             String filters,
             String format,
+            String headerFormat,
             @NotNull String perPage,
             @NotNull String page,
             DimensionDictionary dimensionDictionary,
             UriInfo uriInfo
     ) throws BadApiRequestException {
-        super(format, perPage, page, uriInfo);
+        super(format, headerFormat, perPage, page, uriInfo);
 
         // Zero or more grouping dimensions may be specified
         this.dimensions = generateDimensions(dimension, dimensionDictionary);

fili-core/src/main/java/com/yahoo/bard/webservice/web/JobsApiRequest.java

@@ -36,6 +36,7 @@ public class JobsApiRequest extends ApiRequest {
      * Parses the API request URL and generates the Api Request object.
      *
      * @param format  response data format JSON or CSV. Default is JSON.
+     * @param headerFormat  The accept field from http request header
      * @param asyncAfter  How long the user is willing to wait for a synchronous request in milliseconds
      * @param perPage  number of rows to display per page of results. If present in the original request,
      * must be a positive integer. If not present, must be the empty string.
@@ -51,6 +52,7 @@ public class JobsApiRequest extends ApiRequest {
      */
     public JobsApiRequest(
             String format,
+            String headerFormat,
             String asyncAfter,
             @NotNull String perPage,
             @NotNull String page,
@@ -59,7 +61,7 @@ public JobsApiRequest(
             JobPayloadBuilder jobPayloadBuilder,
             ApiJobStore apiJobStore
     ) {
-        super(format, asyncAfter, perPage, page, uriInfo);
+        super(format, headerFormat, asyncAfter, perPage, page, uriInfo);
         this.jobPayloadBuilder = jobPayloadBuilder;
         this.apiJobStore = apiJobStore;
         this.filters = filters;

fili-core/src/main/java/com/yahoo/bard/webservice/web/MetricsApiRequest.java

@@ -35,6 +35,7 @@ public class MetricsApiRequest extends ApiRequest {
      * ((field name and operation):((multiple values bounded by [])or(single value))))(followed by , or end of string)
      * }</pre>
      * @param format  response data format JSON or CSV. Default is JSON.
+     * @param headerFormat  The accept field from http request header
      * @param perPage  number of rows to display per page of results. If present in the original request,
      * must be a positive integer. If not present, must be the empty string.
      * @param page  desired page of results. If present in the original request, must be a positive
@@ -51,12 +52,13 @@ public class MetricsApiRequest extends ApiRequest {
     public MetricsApiRequest(
             String metricName,
             String format,
+            final String headerFormat,
             @NotNull String perPage,
             @NotNull String page,
             MetricDictionary metricDictionary,
             UriInfo uriInfo
     ) throws BadApiRequestException {
-        super(format, perPage, page, uriInfo);
+        super(format, headerFormat, perPage, page, uriInfo);
 
         this.metrics = generateMetrics(metricName, metricDictionary);
 

fili-core/src/main/java/com/yahoo/bard/webservice/web/SlicesApiRequest.java

@@ -49,6 +49,7 @@ public class SlicesApiRequest extends ApiRequest {
      * ((field name and operation):((multiple values bounded by [])or(single value))))(followed by , or end of string)
      * }</pre>
      * @param format  response data format JSON or CSV. Default is JSON.
+     * @param headerFormat  The accept field from http request header
      * @param perPage  number of rows to display per page of results. If present in the original request,
      * must be a positive integer. If not present, must be the empty string.
      * @param page  desired page of results. If present in the original request, must be a positive
@@ -66,13 +67,14 @@ public class SlicesApiRequest extends ApiRequest {
     public SlicesApiRequest(
             String sliceName,
             String format,
+            String headerFormat,
             @NotNull String perPage,
             @NotNull String page,
             PhysicalTableDictionary tableDictionary,
             DataSourceMetadataService dataSourceMetadataService,
             UriInfo uriInfo
     ) throws BadApiRequestException {
-        super(format, perPage, page, uriInfo);
+        super(format, headerFormat, perPage, page, uriInfo);
         this.slices = generateSlices(tableDictionary, uriInfo);
 
         this.slice = sliceName != null ? generateSlice(

fili-core/src/main/java/com/yahoo/bard/webservice/web/TablesApiRequest.java

@@ -61,6 +61,7 @@ public class TablesApiRequest extends ApiRequest {
      * ((field name and operation):((multiple values bounded by [])or(single value))))(followed by , or end of string)
      * }</pre>
      * @param format  response data format JSON or CSV. Default is JSON.
+     * @param headerFormat  The accept field from http request header
      * @param perPage  number of rows to display per page of results. If present in the original request,
      * must be a positive integer. If not present, must be the empty string.
      * @param page  desired page of results. If present in the original request, must be a positive
@@ -78,12 +79,13 @@ public TablesApiRequest(
             String tableName,
             String granularity,
             String format,
+            String headerFormat,
             @NotNull String perPage,
             @NotNull String page,
             UriInfo uriInfo,
             BardConfigResources bardConfigResources
     ) throws BadApiRequestException {
-        super(format, perPage, page, uriInfo);
+        super(format, headerFormat, perPage, page, uriInfo);
 
         this.tables = generateTables(tableName, bardConfigResources.getLogicalTableDictionary());
 
@@ -121,6 +123,7 @@ public TablesApiRequest(
      * @param tableName  Logical table corresponding to the table name specified in the URL
      * @param granularity  Requested time granularity
      * @param format  Response data format JSON or CSV. Default is JSON.
+     * @param headerFormat  The accept field from http request header
      * @param perPage  Number of rows to display per page of results. It must represent a positive integer or an empty
      * string if it's not specified
      * @param page  Desired page of results. It must represent a positive integer or an empty
@@ -143,6 +146,7 @@ public TablesApiRequest(
             String tableName,
             String granularity,
             String format,
+            final String headerFormat,
             @NotNull String perPage,
             @NotNull String page,
             UriInfo uriInfo,
@@ -153,7 +157,7 @@ public TablesApiRequest(
             String filters,
             String timeZoneId
     ) throws BadApiRequestException {
-        super(format, perPage, page, uriInfo);
+        super(format, headerFormat, perPage, page, uriInfo);
 
         LogicalTableDictionary logicalTableDictionary = bardConfigResources.getLogicalTableDictionary();
         this.tables = generateTables(tableName, logicalTableDictionary);

fili-core/src/main/java/com/yahoo/bard/webservice/web/endpoints/DataServlet.java

@@ -366,6 +366,7 @@ public void getData(
                         count,
                         topN,
                         format,
+                        containerRequestContext.getHeaderString("Accept"),
                         timeZone,
                         asyncAfter,
                         perPage,

fili-core/src/main/java/com/yahoo/bard/webservice/web/endpoints/DimensionsServlet.java

@@ -122,6 +122,7 @@ public Response getAllDimensions(
                     null,
                     null,
                     format,
+                    containerRequestContext.getHeaderString("Accept"),
                     perPage,
                     page,
                     dimensionDictionary,
@@ -184,6 +185,7 @@ public Response getDimension(
                     dimensionName,
                     null,
                     null,
+                    containerRequestContext.getHeaderString("Accept"),
                     "",
                     "",
                     dimensionDictionary,
@@ -271,6 +273,7 @@ public Response getDimensionRows(
                     dimensionName,
                     filterQuery,
                     format,
+                    containerRequestContext.getHeaderString("Accept"),
                     perPage,
                     page,
                     dimensionDictionary,

fili-core/src/main/java/com/yahoo/bard/webservice/web/endpoints/FeatureFlagsServlet.java

@@ -32,6 +32,7 @@
 import javax.ws.rs.PathParam;
 import javax.ws.rs.Produces;
 import javax.ws.rs.QueryParam;
+import javax.ws.rs.container.ContainerRequestContext;
 import javax.ws.rs.core.Context;
 import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
@@ -66,12 +67,19 @@ class FeatureFlagApiRequest extends ApiRequest {
          * Constructor.
          *
          * @param format  Format of the request
+         * @param headerFormat  The accept field from http request header
          * @param perPage  How many items to show per page
          * @param page  Which page to show
          * @param uriInfo  URL information about the request
          */
-        FeatureFlagApiRequest(String format, String perPage, String page, UriInfo uriInfo) {
-            super(format, perPage, page, uriInfo);
+        FeatureFlagApiRequest(
+                String format,
+                final String headerFormat,
+                String perPage,
+                String page,
+                UriInfo uriInfo
+        ) {
+            super(format, headerFormat, perPage, page, uriInfo);
         }
     }
 
@@ -101,6 +109,7 @@ class FeatureFlagEntry {
      * @param page the page to start from
      * @param format the format to use
      * @param uriInfo the injected UriInfo
+     * @param containerRequestContext Context from the http request object
      *
      * @return Response Format:
      * <pre><code>
@@ -121,13 +130,20 @@ public Response getFeatureFlagStatusAll(
             @DefaultValue("") @NotNull @QueryParam("perPage") String perPage,
             @DefaultValue("") @NotNull @QueryParam("page") String page,
             @QueryParam("format") String format,
-            @Context UriInfo uriInfo
+            @Context UriInfo uriInfo,
+            @Context final ContainerRequestContext containerRequestContext
     ) {
         try {
             RequestLog.startTiming(this);
             RequestLog.record(new FeatureFlagRequest("all"));
 
-            FeatureFlagApiRequest apiRequest = new FeatureFlagApiRequest(format, perPage, page, uriInfo);
+            FeatureFlagApiRequest apiRequest = new FeatureFlagApiRequest(
+                    format,
+                    containerRequestContext.getHeaderString("Accept"),
+                    perPage,
+                    page,
+                    uriInfo
+            );
 
             List<FeatureFlagEntry> status = flags.getValues().stream()
                     .map(flag -> new FeatureFlagEntry(flag.getName(), flag.isOn()))
@@ -158,6 +174,7 @@ public Response getFeatureFlagStatusAll(
      * @param flagName The feature flag
      * @param format  The format to return results in
      * @param uriInfo  The injected UriInfo
+     * @param containerRequestContext Context from the http request object
      *
      * @return Response Format:
      * <pre><code>
@@ -176,13 +193,20 @@ public Response getFeatureFlagStatusAll(
     public Response getFeatureFlagStatus(
             @PathParam("flagName") String flagName,
             @QueryParam("format") String format,
-            @Context UriInfo uriInfo
+            @Context UriInfo uriInfo,
+            @Context final ContainerRequestContext containerRequestContext
     ) {
         try {
             RequestLog.startTiming(this);
             RequestLog.record(new FeatureFlagRequest(flagName));
 
-            FeatureFlagApiRequest apiRequest = new FeatureFlagApiRequest(format, "", "", uriInfo);
+            FeatureFlagApiRequest apiRequest = new FeatureFlagApiRequest(
+                    format,
+                    containerRequestContext.getHeaderString("Accept"),
+                    "",
+                    "",
+                    uriInfo
+            );
 
             FeatureFlag flag = flags.forName(flagName);
             FeatureFlagEntry status = new FeatureFlagEntry(flag.getName(), flag.isOn());