com.yahoo.bard.webservice.web.security

Class DataApiRequestMapperUtils

java.lang.Object

com.yahoo.bard.webservice.web.security.DataApiRequestMapperUtils

public class DataApiRequestMapperUtils
extends Object

A set of methods for generating utility mappers for ApiRequestMapping chains.

Constructor Summary

Constructors

Constructor and Description
DataApiRequestMapperUtils()

Method Summary

Modifier and Type	Method and Description
static RequestMapper	identityMapper(ResourceDictionaries resourceDictionaries) Create a request mapper that always returns an unmodified request.
static RequestMapper	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataApiRequestMapperUtils

public DataApiRequestMapperUtils()

Method Detail

identityMapper

public static RequestMapper identityMapper(ResourceDictionaries resourceDictionaries)

Create a request mapper that always returns an unmodified request.

Parameters:

resourceDictionaries - The dictionaries used for mapping the request.

Returns:

The request passed in, unmodified.

validationExceptionMapper

public static RequestMapper 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. This can be used to 'cap' a filter path such as a RoleBasedRoutingRequestMapper where the 'default' should only be hit exceptionally.

Parameters:

resourceDictionaries - The dictionaries used for mapping the request.

exceptionSource - A function to create a request validation exception.

Returns:

A request mapper that will always fail on a validation exception.