com.yahoo.bard.webservice.web.security

Class ChainingRequestMapper<T extends ApiRequest>

java.lang.Object

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

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

Type Parameters:

T - Type of API Request this RequestMapper will work on

Direct Known Subclasses:

RoleDimensionApiFilterRequestMapper

public abstract class ChainingRequestMapper<T extends ApiRequest>
extends RequestMapper<T>

An abstract ApiRequest Mapper that allows delegation to a subsequent mapper.

Constructor Summary

Constructors

Constructor and Description
ChainingRequestMapper(ResourceDictionaries resourceDictionaries) Constructor.
ChainingRequestMapper(ResourceDictionaries resourceDictionaries, RequestMapper<T> next) 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.
protected abstract T	internalApply(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

ChainingRequestMapper

public ChainingRequestMapper(@NotNull
                             ResourceDictionaries resourceDictionaries)

Constructor.

Parameters:

resourceDictionaries - The dictionaries to use for request mapping.

ChainingRequestMapper

public ChainingRequestMapper(@NotNull
                             ResourceDictionaries resourceDictionaries,
                             @NotNull
                             RequestMapper<T> next)

Constructor.

Parameters:

resourceDictionaries - The dictionaries to use for request mapping.

next - The next request mapper to process this ApiRequest

Method Detail

apply

public final 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.

Specified by:

apply in class RequestMapper<T extends ApiRequest>

Parameters:

request - the apiRequest to rewrite

context - the ContainerRequestContext containing user and request information

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

internalApply

protected abstract T internalApply(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 containing user and request information

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