Uses of Interface
com.yahoo.bard.webservice.web.apirequest.ApiRequest

Packages that use ApiRequest

Package	Description
com.yahoo.bard.webservice.data
com.yahoo.bard.webservice.web
com.yahoo.bard.webservice.web.apirequest
com.yahoo.bard.webservice.web.endpoints
com.yahoo.bard.webservice.web.security

Uses of ApiRequest in com.yahoo.bard.webservice.data

Methods in com.yahoo.bard.webservice.data with parameters of type ApiRequest

Modifier and Type	Method and Description
javax.ws.rs.core.Response	HttpResponseMaker.buildResponse(PreResponse preResponse, ApiRequest apiRequest) Build complete response.

Constructors in com.yahoo.bard.webservice.data with parameters of type ApiRequest

Constructor and Description
HttpResponseChannel(javax.ws.rs.container.AsyncResponse asyncResponse, ApiRequest apiRequest, HttpResponseMaker httpResponseMaker) Constructor.

Uses of ApiRequest in com.yahoo.bard.webservice.web

Classes in com.yahoo.bard.webservice.web with type parameters of type ApiRequest

Modifier and Type	Class and Description
class	NoOpRequestMapper<T extends ApiRequest> Default RequestMapper implementation.
class	RequestMapper<T extends ApiRequest> RequestMapper will do post processing on a given ApiRequest, such as rewriting or validating queries.

Methods in com.yahoo.bard.webservice.web with parameters of type ApiRequest

Modifier and Type	Method and Description
Optional<ResponseWriter>	FiliResponseWriterSelector.select(ApiRequest request) Selects a ResponseWriter given the format type from request.
Optional<ResponseWriter>	ResponseWriterSelector.select(ApiRequest request) Select ResponseWriter given certain type of format from DataApiRequest.
void	ResponseWriter.write(ApiRequest request, ResponseData responseData, OutputStream os) Serializes the ResultSet (pulled from the ResponseData) and any desired metadata and adds it to the specified output stream.
void	JsonResponseWriter.write(ApiRequest request, ResponseData responseData, OutputStream os) Writes JSON response.
void	FiliResponseWriter.write(ApiRequest request, ResponseData responseData, OutputStream os)
void	JsonApiResponseWriter.write(ApiRequest request, ResponseData responseData, OutputStream os) Writes JSON-API response.
void	CsvResponseWriter.write(ApiRequest request, ResponseData responseData, OutputStream outputStream)

Uses of ApiRequest in com.yahoo.bard.webservice.web.apirequest

Subinterfaces of ApiRequest in com.yahoo.bard.webservice.web.apirequest

Modifier and Type	Interface and Description
interface	DataApiRequest DataApiRequest Request binds, validates, and models the parts of a request to the data endpoint.
interface	DimensionsApiRequest Dimensions API Request.
interface	JobsApiRequest Jobs API Request.
interface	MetricsApiRequest Metrics API Request.
interface	SlicesApiRequest Slices API Request.
interface	TablesApiRequest Tables API Request.

Classes in com.yahoo.bard.webservice.web.apirequest that implement ApiRequest

Modifier and Type	Class and Description
class	ApiRequestImpl API Request.
class	DataApiRequestImpl Data API Request Implementation binds, validates, and models the parts of a request to the data endpoint.
class	DimensionsApiRequestImpl Dimension API Request Implementation binds, validates, and models the parts of a request to the dimension endpoint.
class	JobsApiRequestImpl Jobs API Request Implementation binds, validates, and models the parts of a request to the jobs endpoint.
class	MetricsApiRequestImpl Metrics API Request Implementation binds, validates, and models the parts of a request to the metrics endpoint.
class	SlicesApiRequestImpl Slices API Request Implementation binds, validates, and models the parts of a request to the Slices endpoint.
class	TablesApiRequestImpl Tables API Request Implementation binds, validates, and models the parts of a request to the table endpoint.

Uses of ApiRequest in com.yahoo.bard.webservice.web.endpoints

Methods in com.yahoo.bard.webservice.web.endpoints with parameters of type ApiRequest

Modifier and Type	Method and Description
protected <T> javax.ws.rs.core.Response	EndpointServlet.formatResponse(ApiRequest apiRequest, Stream<T> rows, String jsonName, List<String> csvColumnNames) Format and build the response as JSON or CSV.
protected void	JobsServlet.handleResultsResponse(rx.Observable<PreResponse> preResponseObservable, javax.ws.rs.container.AsyncResponse asyncResponse, ApiRequest apiRequest) Process a request to get job results.

Uses of ApiRequest in com.yahoo.bard.webservice.web.security

Classes in com.yahoo.bard.webservice.web.security with type parameters of type ApiRequest

Modifier and Type	Class and Description
class	ChainingRequestMapper<T extends ApiRequest> An abstract ApiRequest Mapper that allows delegation to a subsequent mapper.
class	RoleBasedRoutingRequestMapper<T extends ApiRequest> A RequestMapper that delegates to the first request mapper in a list which the user has a supporting role for.

Method parameters in com.yahoo.bard.webservice.web.security with type arguments of type ApiRequest

Modifier and Type	Method and Description
static RequestMapper	DataApiRequestMapperUtils.validationExceptionMapper(ResourceDictionaries resourceDictionaries, BiFunction<ApiRequest,javax.ws.rs.container.ContainerRequestContext,RequestValidationException> exceptionSource) Create a requestMapper that always throws a validation exception based on the request.