com.yahoo.bard.webservice.web.util

Class ResponseFormat

java.lang.Object

com.yahoo.bard.webservice.web.util.ResponseFormat

public class ResponseFormat
extends Object

A utility class for sharing Response logic between metadata and data endpoints.

Constructor Summary

Constructors

Constructor and Description
ResponseFormat()

Method Summary

Modifier and Type	Method and Description
static String	getCsvContentDispositionValue(javax.ws.rs.core.UriInfo uriInfo) This method will get the path segments and the interval (if it is part of the request) from the apiRequest and create a content-disposition header value with a proposed filename in the following format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseFormat

public ResponseFormat()

Method Detail

getCsvContentDispositionValue

public static String getCsvContentDispositionValue(javax.ws.rs.core.UriInfo uriInfo)

This method will get the path segments and the interval (if it is part of the request) from the apiRequest and create a content-disposition header value with a proposed filename in the following format.

If the path segments are ["data", "datasource", "granularity", "dim1"] and the query params have interval {"dateTime": "a/b"}, then the result would be "attachment; filename=data-datasource-granularity-dim1_a_b.csv". For a dimension query without a "dateTime" query param and path segments ["dimensions", "datasource", "dim1"], then the result would be "attachment; filename=dimensions-datasource-dim1.csv".

Parameters:

uriInfo - UriInfo of the request

Returns:

A content disposition header telling the browser the name of the CSV file to be downloaded