com.yahoo.bard.webservice.web.security

Class RoleBasedRoutingRequestMapper<T extends ApiRequest>

java.lang.Object

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

com.yahoo.bard.webservice.web.security.RoleBasedRoutingRequestMapper<T>

Type Parameters:

T - Type of API Request this RequestMapper will work on

public class RoleBasedRoutingRequestMapper<T extends ApiRequest>
extends RequestMapper<T>

A RequestMapper that delegates to the first request mapper in a list which the user has a supporting role for.

Constructor Summary

Constructors

Constructor and Description
RoleBasedRoutingRequestMapper(ResourceDictionaries resourceDictionaries, LinkedHashMap<String,RequestMapper<T>> prioritizedRoleBasedMappers, RequestMapper<T> defaultMapper) Constructor.

Method Summary

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

Methods inherited from class com.yahoo.bard.webservice.web.RequestMapper

getResourceDictionaries

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleBasedRoutingRequestMapper

public RoleBasedRoutingRequestMapper(ResourceDictionaries resourceDictionaries,
                                     LinkedHashMap<String,RequestMapper<T>> prioritizedRoleBasedMappers,
                                     @NotNull
                                     RequestMapper<T> defaultMapper)

Constructor.

Parameters:

resourceDictionaries - The dictionaries to use for request mapping.

prioritizedRoleBasedMappers - A map of roles to mappers for each role, with a deterministic entry order.

defaultMapper - The default mapper to apply if no other roles match. (should not be null to avoid default access by all)

Method Detail

apply

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

Description copied from class: RequestMapper

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

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

Specified by:

apply in class RequestMapper<T extends ApiRequest>

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