com.yahoo.bard.webservice.web.filters

Class RoleBasedAuthFilter

java.lang.Object

com.yahoo.bard.webservice.web.filters.RoleBasedAuthFilter

All Implemented Interfaces:

javax.ws.rs.container.ContainerRequestFilter

@Singleton
 @Priority(value=4)
public class RoleBasedAuthFilter
extends Object
implements javax.ws.rs.container.ContainerRequestFilter

RoleBasedAuthFilter - Filter servlet calls based on the user Role.

Constructor Summary

Constructors

Constructor and Description
RoleBasedAuthFilter(com.fasterxml.jackson.databind.ObjectMapper mapper) Constructor.

Method Summary

Modifier and Type	Method and Description
void	filter(javax.ws.rs.container.ContainerRequestContext containerRequestContext)
protected boolean	isBypassMethod(javax.ws.rs.container.ContainerRequestContext containerRequestContext) Returns true to bypass the filter if the request is a Http OPTIONS method to allow CORS by default.
protected boolean	isUserInRole(List<String> allowedUserRoles, javax.ws.rs.container.ContainerRequestContext containerRequestContext) Checks if an user role belongs to the list of allowed roles.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleBasedAuthFilter

@Inject
public RoleBasedAuthFilter(com.fasterxml.jackson.databind.ObjectMapper mapper)

Constructor.

Parameters:

mapper - JSON mapper to use

Method Detail

filter

public void filter(javax.ws.rs.container.ContainerRequestContext containerRequestContext)
            throws IOException

Specified by:

filter in interface javax.ws.rs.container.ContainerRequestFilter

Throws:

IOException

isBypassMethod

protected boolean isBypassMethod(javax.ws.rs.container.ContainerRequestContext containerRequestContext)

Returns true to bypass the filter if the request is a Http OPTIONS method to allow CORS by default.

Parameters:

containerRequestContext - Request context containing request method information

Returns:

true to bypass the filter, and false otherwise

isUserInRole

protected boolean isUserInRole(List<String> allowedUserRoles,
                               javax.ws.rs.container.ContainerRequestContext containerRequestContext)

Checks if an user role belongs to the list of allowed roles.

Parameters:

allowedUserRoles - List of allowed roles

containerRequestContext - Request context contains the user role information

Returns:

boolean based on the user role