Package dev.galasa.framework.api.common

Class ProtectedRoute

java.lang.Object

dev.galasa.framework.api.common.BaseRoute

dev.galasa.framework.api.common.ProtectedRoute

All Implemented Interfaces:

IRoute

public abstract class ProtectedRoute
extends BaseRoute

This is an abstract class that represents a route protected under a JWT challenge and RBAC. Requests to protected routes will always contain an 'Authorization' header with a bearer token.

Field Summary

Fields

Modifier and Type	Field	Description
protected RBACService	rbacService
protected RBACValidator	rbacValidator

Fields inherited from class dev.galasa.framework.api.common.BaseRoute

gson, logger

Constructor Summary

Constructors

Constructor	Description
ProtectedRoute(ResponseBuilder responseBuilder, String path, RBACService rbacService)

Method Summary

Modifier and Type	Method	Description
boolean	isActionPermitted(BuiltInAction action, String loginId)	Checks if the given action is permitted for the user that sent the given request
protected void	validateActionPermitted(BuiltInAction action, String loginId)

Methods inherited from class dev.galasa.framework.api.common.BaseRoute

checkJsonElementIsValidJSON, checkRequestHasContent, getPathRegex, getResponseBuilder, getResponseType, getSupportedQueryParameterNames, handleDeleteRequest, handleGetRequest, handlePostRequest, handlePutRequest, parseRequestBody, validateAcceptHeader

Methods inherited from class java.lang.Object

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

Field Details

rbacService

protected RBACService rbacService

rbacValidator

protected RBACValidator rbacValidator

Constructor Details

ProtectedRoute

public ProtectedRoute(ResponseBuilder responseBuilder,
 String path,
 RBACService rbacService)

Method Details

validateActionPermitted

protected void validateActionPermitted(BuiltInAction action,
 String loginId)
                                throws InternalServletException

Throws:

InternalServletException

isActionPermitted

public boolean isActionPermitted(BuiltInAction action,
 String loginId)
                          throws InternalServletException

Description copied from interface: IRoute

Checks if the given action is permitted for the user that sent the given request

Parameters:

action - the action being performed

loginId - the login ID of the user sending a request to this route

Returns:

true if the user is allowed to perform the given action, false otherwise

Throws:

InternalServletException - if there was an issue accessing the RBAC service