com.yahoo.bard.webservice.web

Class RequestMapper<T extends ApiRequest>

java.lang.Object

com.yahoo.bard.webservice.web.RequestMapper<T>

Type Parameters:

T - Type of API Request this RequestMapper will work on

Direct Known Subclasses:

ChainingRequestMapper, DimensionApiRequestMapper, NoOpRequestMapper, RoleBasedRoutingRequestMapper

public abstract class RequestMapper<T extends ApiRequest>
extends Object

RequestMapper will do post processing on a given ApiRequest, such as rewriting or validating queries.

Constructor Summary

Constructors

Constructor and Description
RequestMapper(ResourceDictionaries resourceDictionaries) Constructor.

Method Summary

Modifier and Type	Method and Description
abstract T	apply(T request, javax.ws.rs.container.ContainerRequestContext context) Rewrite and Validate the ApiRequest(e.g.
ResourceDictionaries	getResourceDictionaries()

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestMapper

public RequestMapper(@NotNull
                     ResourceDictionaries resourceDictionaries)

Constructor.

Parameters:

resourceDictionaries - The dictionaries to use for request mapping.

Method Detail

apply

public abstract T apply(T request,
                        javax.ws.rs.container.ContainerRequestContext context)
                 throws RequestValidationException

Rewrite and Validate the ApiRequest(e.g. Security check, permission check).

This should throw an exception if the given/converted request is not valid.

Parameters:

request - the apiRequest to rewrite

context - the ContainerRequestContext

Returns:

a reference to an apiRequest, either the original one or a rewritten one

Throws:

RequestValidationException - with the HTTP status and user-facing error msg to abort with if the request is not valid

getResourceDictionaries

public ResourceDictionaries getResourceDictionaries()