com.yahoo.bard.webservice.web.apirequest

Class ApiRequestImpl

java.lang.Object

com.yahoo.bard.webservice.web.apirequest.ApiRequestImpl

All Implemented Interfaces:

ApiRequest

Direct Known Subclasses:

DataApiRequestImpl, DimensionsApiRequestImpl, JobsApiRequestImpl, MetricsApiRequestImpl, SlicesApiRequestImpl, TablesApiRequestImpl

public abstract class ApiRequestImpl
extends Object
implements ApiRequest

API Request. Abstract class offering default implementations for the common components of API request objects.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	asyncAfter
protected javax.ws.rs.core.Response.ResponseBuilder	builder
protected static String	COMMA_AFTER_BRACKET_PATTERN
protected ResponseFormatType	format
protected Pagination<?>	pagination
protected Optional<PaginationParameters>	paginationParameters
protected javax.ws.rs.core.UriInfo	uriInfo

Fields inherited from interface com.yahoo.bard.webservice.web.apirequest.ApiRequest

ASYNCHRONOUS_ASYNC_AFTER_VALUE, SYNCHRONOUS_ASYNC_AFTER_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ApiRequestImpl(ResponseFormatType format, long asyncAfter, Optional<PaginationParameters> paginationParameters, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Response.ResponseBuilder builder) All argument constructor, meant to be used for rewriting apiRequest.
	ApiRequestImpl(String format, String asyncAfter, String perPage, String page, javax.ws.rs.core.UriInfo uriInfo) Parses the API request URL and generates the API request object.
	ApiRequestImpl(String format, String perPage, String page, javax.ws.rs.core.UriInfo uriInfo) Parses the API request URL and generates the API request object.

Method Summary

Modifier and Type	Method and Description
protected void	addPageLink(PaginationLink link, int pageNumber) Add page links to the header of the response builder.
protected void	addPageLink(PaginationLink link, Pagination<?> pages) Add page links to the header of the response builder.
protected ResponseFormatType	generateAcceptFormat(String format) Generates the format in which the response data is expected.
protected long	generateAsyncAfter(String asyncAfterString) Parses the asyncAfter parameter into a long describing how long the user is willing to wait for the results of a synchronous request before the request should become asynchronous.
protected LinkedHashSet<Dimension>	generateDimensions(List<javax.ws.rs.core.PathSegment> apiDimensions, DimensionDictionary dimensionDictionary) Extracts the list of dimension names from the url dimension path segments and generates a set of dimension objects based on it.
ApiFilters	generateFilters(String filterQuery, LogicalTable table, DimensionDictionary dimensionDictionary) Generates filter objects on the based on the filter query in the api request.
protected Granularity	generateGranularity(String granularity, org.joda.time.DateTimeZone dateTimeZone, GranularityParser granularityParser) Generate a Granularity instance based on a path element.
protected Granularity	generateGranularity(String granularity, GranularityParser granularityParser) Generate a Granularity instance based on a path element.
protected static Set<org.joda.time.Interval>	generateIntervals(org.joda.time.DateTime now, String apiIntervalQuery, Granularity granularity, org.joda.time.format.DateTimeFormatter dateTimeFormatter) Extracts the set of intervals from the api request.
protected static Set<org.joda.time.Interval>	generateIntervals(String apiIntervalQuery, Granularity granularity, org.joda.time.format.DateTimeFormatter dateTimeFormatter) Extracts the set of intervals from the api request.
protected LinkedHashSet<LogicalMetric>	generateLogicalMetrics(String apiMetricQuery, MetricDictionary metricDictionary) Extracts the list of metrics from the url metric query string and generates a set of LogicalMetrics.
protected String	generateMetricName(String filterString) Given a single dimension filter string, generate a metric name extension.
protected Optional<PaginationParameters>	generatePaginationParameters(String perPage, String page) Builds the paginationParameters object, if the request provides both a perPage and page field.
protected LogicalTable	generateTable(String tableName, Granularity granularity, LogicalTableDictionary logicalTableDictionary) Extracts a specific logical table object given a valid table name and a valid granularity.
protected org.joda.time.DateTimeZone	generateTimeZone(String timeZoneId, org.joda.time.DateTimeZone systemTimeZone) Get the timezone for the request.
<T> Function<Collection<T>,AllPagesPagination<T>>	getAllPagesPaginationFactory(PaginationParameters paginationParameters) This method returns a Function that can basically take a Collection and return an instance of AllPagesPagination.
static org.joda.time.DateTime	getAsDateTime(org.joda.time.DateTime now, Granularity granularity, String dateText, org.joda.time.format.DateTimeFormatter timeFormatter) Get datetime from the given input text based on granularity.
long	getAsyncAfter() Returns how long the user is willing to wait before a request should go asynchronous.
javax.ws.rs.core.Response.ResponseBuilder	getBuilder() Get the response builder associated with this request.
PaginationParameters	getDefaultPagination() Get the default pagination parameters for this type of API request.
ResponseFormatType	getFormat() Get the type of the requested response format.
<T> Stream<T>	getPage(Collection<T> data) Deprecated. Pagination is moving to a Stream and pushing creation of the page to a more general method (getPage(Pagination)) to allow for more flexibility in how pagination is done.
<T> Stream<T>	getPage(Pagination<T> pagination) Add links to the response builder and return a stream with the requested page from the raw data.
Pagination<?>	getPagination() Get the pagination object associated with this request.
Optional<PaginationParameters>	getPaginationParameters() Get the requested pagination parameters.
javax.ws.rs.core.UriInfo	getUriInfo() Get the uri info.
protected void	validateMetrics(Set<LogicalMetric> logicalMetrics, LogicalTable table) Validate that all metrics are part of the logical table.
protected void	validateRequestDimensions(Set<Dimension> requestDimensions, LogicalTable table) Ensure all request dimensions are part of the logical table.
protected static void	validateTimeAlignment(Granularity granularity, Set<org.joda.time.Interval> intervals) Throw an exception if any of the intervals are not accepted by this granularity.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yahoo.bard.webservice.web.apirequest.ApiRequest

generateDateTimeFormatter

Field Detail

COMMA_AFTER_BRACKET_PATTERN

protected static final String COMMA_AFTER_BRACKET_PATTERN

See Also:

Constant Field Values

format

protected final ResponseFormatType format

paginationParameters

protected final Optional<PaginationParameters> paginationParameters

uriInfo

protected final javax.ws.rs.core.UriInfo uriInfo

builder

protected final javax.ws.rs.core.Response.ResponseBuilder builder

pagination

protected Pagination<?> pagination

asyncAfter

protected final long asyncAfter

Constructor Detail

ApiRequestImpl

public ApiRequestImpl(String format,
                      String asyncAfter,
                      @NotNull
                      String perPage,
                      @NotNull
                      String page,
                      javax.ws.rs.core.UriInfo uriInfo)
               throws BadApiRequestException

Parses the API request URL and generates the API request object.

Parameters:

format - response data format JSON or CSV. Default is JSON.

asyncAfter - How long the user is willing to wait for a synchronous request in milliseconds, if null defaults to the system config default_asyncAfter

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.

page - desired page of results. If present in the original request, must be a positive integer. If not present, must be the empty string.

uriInfo - The URI of the request object.

Throws:

BadApiRequestException - if pagination parameters in the API request are not positive integers.

ApiRequestImpl

public ApiRequestImpl(String format,
                      @NotNull
                      String perPage,
                      @NotNull
                      String page,
                      javax.ws.rs.core.UriInfo uriInfo)
               throws BadApiRequestException

Parses the API request URL and generates the API request object. Defaults asyncAfter to never.

Parameters:

format - response data format JSON or CSV. Default is JSON.

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.

page - desired page of results. If present in the original request, must be a positive integer. If not present, must be the empty string.

uriInfo - The URI of the request object.

Throws:

BadApiRequestException - if pagination parameters in the API request are not positive integers.

ApiRequestImpl

protected ApiRequestImpl(ResponseFormatType format,
                         long asyncAfter,
                         Optional<PaginationParameters> paginationParameters,
                         javax.ws.rs.core.UriInfo uriInfo,
                         javax.ws.rs.core.Response.ResponseBuilder builder)

All argument constructor, meant to be used for rewriting apiRequest.

Parameters:

format - The format of the response

asyncAfter - How long the user is willing to wait for a synchronous request, in milliseconds

paginationParameters - The parameters used to describe pagination

uriInfo - The uri details

builder - The response builder for this request

Method Detail

generateGranularity

protected Granularity generateGranularity(@NotNull
                                          String granularity,
                                          @NotNull
                                          org.joda.time.DateTimeZone dateTimeZone,
                                          @NotNull
                                          GranularityParser granularityParser)
                                   throws BadApiRequestException

Generate a Granularity instance based on a path element.

Parameters:

granularity - A string representation of the granularity

dateTimeZone - The time zone to use for this granularity

granularityParser - The parser for granularity

Returns:

A granularity instance with time zone information

Throws:

BadApiRequestException - if the string matches no meaningful granularity

generateGranularity

protected Granularity generateGranularity(String granularity,
                                          GranularityParser granularityParser)
                                   throws BadApiRequestException

Generate a Granularity instance based on a path element.

Parameters:

granularity - A string representation of the granularity

granularityParser - The parser for granularity

Returns:

A granularity instance without time zone information

Throws:

BadApiRequestException - if the string matches no meaningful granularity

generateDimensions

protected LinkedHashSet<Dimension> generateDimensions(List<javax.ws.rs.core.PathSegment> apiDimensions,
                                                      DimensionDictionary dimensionDictionary)
                                               throws BadApiRequestException

Extracts the list of dimension names from the url dimension path segments and generates a set of dimension objects based on it.

Parameters:

apiDimensions - Dimension path segments from the URL.

dimensionDictionary - Dimension dictionary contains the map of valid dimension names and dimension objects.

Returns:

Set of dimension objects.

Throws:

BadApiRequestException - if an invalid dimension is requested.

validateRequestDimensions

protected void validateRequestDimensions(Set<Dimension> requestDimensions,
                                         LogicalTable table)
                                  throws BadApiRequestException

Ensure all request dimensions are part of the logical table.

Parameters:

requestDimensions - The dimensions being requested

table - The logical table being checked

Throws:

BadApiRequestException - if any of the dimensions do not match the logical table

generateMetricName

protected String generateMetricName(String filterString)

Given a single dimension filter string, generate a metric name extension.

Parameters:

filterString - Single dimension filter string.

Returns:

Metric name extension created for the filter.

generateLogicalMetrics

protected LinkedHashSet<LogicalMetric> generateLogicalMetrics(String apiMetricQuery,
                                                              MetricDictionary metricDictionary)

Extracts the list of metrics from the url metric query string and generates a set of LogicalMetrics.

If the query contains undefined metrics, BadApiRequestException will be thrown.

Parameters:

apiMetricQuery - URL query string containing the metrics separated by ','

metricDictionary - Metric dictionary contains the map of valid metric names and logical metric objects

Returns:

set of metric objects

validateMetrics

protected void validateMetrics(Set<LogicalMetric> logicalMetrics,
                               LogicalTable table)
                        throws BadApiRequestException

Validate that all metrics are part of the logical table.

Parameters:

logicalMetrics - The set of metrics being validated

table - The logical table for the request

Throws:

BadApiRequestException - if the requested metrics are not in the logical table

generateIntervals

protected static Set<org.joda.time.Interval> generateIntervals(String apiIntervalQuery,
                                                               Granularity granularity,
                                                               org.joda.time.format.DateTimeFormatter dateTimeFormatter)
                                                        throws BadApiRequestException

Extracts the set of intervals from the api request.

Parameters:

apiIntervalQuery - API string containing the intervals in ISO 8601 format, values separated by ','.

granularity - The granularity to generate the date based on period or macros.

dateTimeFormatter - The formatter to parse date time interval segments

Returns:

Set of jodatime interval objects.

Throws:

BadApiRequestException - if the requested interval is not found.

generateIntervals

protected static Set<org.joda.time.Interval> generateIntervals(org.joda.time.DateTime now,
                                                               String apiIntervalQuery,
                                                               Granularity granularity,
                                                               org.joda.time.format.DateTimeFormatter dateTimeFormatter)
                                                        throws BadApiRequestException

Extracts the set of intervals from the api request.

Parameters:

now - The 'now' for which time macros will be relatively calculated

apiIntervalQuery - API string containing the intervals in ISO 8601 format, values separated by ','.

granularity - The granularity to generate the date based on period or macros.

dateTimeFormatter - The formatter to parse date time interval segments

Returns:

Set of jodatime interval objects.

Throws:

BadApiRequestException - if the requested interval is not found.

generateFilters

public ApiFilters generateFilters(String filterQuery,
                                  LogicalTable table,
                                  DimensionDictionary dimensionDictionary)
                           throws BadApiRequestException

Generates filter objects on the based on the filter query in the api request.

Parameters:

filterQuery - Expects a URL filter query String in the format: (dimension name).(fieldname)-(operation):[?(value or comma separated values)]?

table - The logical table for the data request

dimensionDictionary - DimensionDictionary

Returns:

Set of filter objects.

Throws:

BadApiRequestException - if the filter query string does not match required syntax, or the filter contains a 'startsWith' or 'contains' operation while the BardFeatureFlag.DATA_STARTS_WITH_CONTAINS_ENABLED is off.

getAsDateTime

public static org.joda.time.DateTime getAsDateTime(org.joda.time.DateTime now,
                                                   Granularity granularity,
                                                   String dateText,
                                                   org.joda.time.format.DateTimeFormatter timeFormatter)
                                            throws BadApiRequestException

Get datetime from the given input text based on granularity.

Parameters:

now - current datetime to compute the floored date based on granularity

granularity - granularity to truncate the given date to.

dateText - start/end date text which could be actual date or macros

timeFormatter - a time zone adjusted date time formatter

Returns:

joda datetime of the given start/end date text or macros

Throws:

BadApiRequestException - if the granularity is "all" and a macro is used

generateTimeZone

protected org.joda.time.DateTimeZone generateTimeZone(String timeZoneId,
                                                      org.joda.time.DateTimeZone systemTimeZone)

Get the timezone for the request.

Parameters:

timeZoneId - String of the TimeZone ID

systemTimeZone - TimeZone of the system to use if there is no timeZoneId

Returns:

the request's TimeZone

validateTimeAlignment

protected static void validateTimeAlignment(Granularity granularity,
                                            Set<org.joda.time.Interval> intervals)
                                     throws BadApiRequestException

Throw an exception if any of the intervals are not accepted by this granularity.

Parameters:

granularity - The granularity whose alignment is being tested.

intervals - The intervals being tested.

Throws:

BadApiRequestException - if the granularity does not align to the intervals

generateAcceptFormat

protected ResponseFormatType generateAcceptFormat(String format)
                                           throws BadApiRequestException

Generates the format in which the response data is expected.

Parameters:

format - Expects a URL format query String.

Returns:

Response format type (CSV or JSON).

Throws:

BadApiRequestException - if the requested format is not found.

generatePaginationParameters

protected Optional<PaginationParameters> generatePaginationParameters(String perPage,
                                                                      String page)
                                                               throws BadApiRequestException

Builds the paginationParameters object, if the request provides both a perPage and page field.

Parameters:

perPage - The number of rows per page.

page - The page to display.

Returns:

An Optional wrapping a PaginationParameters if both 'perPage' and 'page' exist.

Throws:

BadApiRequestException - if 'perPage' or 'page' is not a positive integer, or if either one is empty string but not both.

generateTable

protected LogicalTable generateTable(String tableName,
                                     Granularity granularity,
                                     LogicalTableDictionary logicalTableDictionary)
                              throws BadApiRequestException

Extracts a specific logical table object given a valid table name and a valid granularity.

Parameters:

tableName - logical table corresponding to the table name specified in the URL

granularity - logical table corresponding to the table name specified in the URL

logicalTableDictionary - Logical table dictionary contains the map of valid table names and table objects.

Returns:

Set of logical table objects.

Throws:

BadApiRequestException - Invalid table exception if the table dictionary returns a null.

getFormat

public ResponseFormatType getFormat()

Description copied from interface: ApiRequest

Get the type of the requested response format.

Specified by:

getFormat in interface ApiRequest

Returns:

The format of the response for this API request.

getPaginationParameters

public Optional<PaginationParameters> getPaginationParameters()

Description copied from interface: ApiRequest

Get the requested pagination parameters.

Specified by:

getPaginationParameters in interface ApiRequest

Returns:

The pagination parameters for this API request

getUriInfo

public javax.ws.rs.core.UriInfo getUriInfo()

Description copied from interface: ApiRequest

Get the uri info.

Specified by:

getUriInfo in interface ApiRequest

Returns:

The uri info of this API request

getPagination

public Pagination<?> getPagination()

Description copied from interface: ApiRequest

Get the pagination object associated with this request. This object has valid contents after a call to ApiRequest.getPage(java.util.Collection<T>)

Specified by:

getPagination in interface ApiRequest

Returns:

The pagination object.

getAsyncAfter

public long getAsyncAfter()

Description copied from interface: ApiRequest

Returns how long the user is willing to wait before a request should go asynchronous.

Specified by:

getAsyncAfter in interface ApiRequest

Returns:

The maximum number of milliseconds the request is allowed to take before going from synchronous to asynchronous

getBuilder

public javax.ws.rs.core.Response.ResponseBuilder getBuilder()

Description copied from interface: ApiRequest

Get the response builder associated with this request.

Specified by:

getBuilder in interface ApiRequest

Returns:

The response builder.

getDefaultPagination

public PaginationParameters getDefaultPagination()

Description copied from interface: ApiRequest

Get the default pagination parameters for this type of API request.

Specified by:

getDefaultPagination in interface ApiRequest

Returns:

The uri info of this type of API request

addPageLink

protected void addPageLink(PaginationLink link,
                           Pagination<?> pages)

Add page links to the header of the response builder.

Parameters:

link - The type of the link to add.

pages - The paginated set of results containing the pages being linked to.

addPageLink

protected void addPageLink(PaginationLink link,
                           int pageNumber)

Add page links to the header of the response builder.

Parameters:

link - The type of the link to add.

pageNumber - Number of the page to add the link for.

getPage

@Deprecated
public <T> Stream<T> getPage(Collection<T> data)

Deprecated. Pagination is moving to a Stream and pushing creation of the page to a more general method (getPage(Pagination)) to allow for more flexibility in how pagination is done.

Add links to the response builder and return a stream with the requested page from the raw data.

Specified by:

getPage in interface ApiRequest

Type Parameters:

T - The type of the collection elements

Parameters:

data - The data to be paginated.

Returns:

A stream corresponding to the requested page.

getPage

public <T> Stream<T> getPage(Pagination<T> pagination)

Add links to the response builder and return a stream with the requested page from the raw data.

Specified by:

getPage in interface ApiRequest

Type Parameters:

T - The type of the collection elements

Parameters:

pagination - The pagination object

Returns:

A stream corresponding to the requested page.

getAllPagesPaginationFactory

public <T> Function<Collection<T>,AllPagesPagination<T>> getAllPagesPaginationFactory(PaginationParameters paginationParameters)

This method returns a Function that can basically take a Collection and return an instance of AllPagesPagination.

Type Parameters:

T - The type of items in the Collection which needs to be paginated

Parameters:

paginationParameters - The PaginationParameters to be used to generate AllPagesPagination instance

Returns:

A Function that takes a Collection and returns an instance of AllPagesPagination

generateAsyncAfter

protected long generateAsyncAfter(String asyncAfterString)
                           throws BadApiRequestException

Parses the asyncAfter parameter into a long describing how long the user is willing to wait for the results of a synchronous request before the request should become asynchronous.

Parameters:

asyncAfterString - asyncAfter should be either a string representation of a long, or the String never

Returns:

A long describing how long the user is willing to wait

Throws:

BadApiRequestException - if asyncAfterString is neither the string representation of a natural number, nor never