Package io.camunda.security.reader

Interface ResourceAccessController

public interface ResourceAccessController

A ResourceAccessController enhances any get and search with additional ResourceAccessChecks to be applied executing them. However, any implementation of the ResourceAccessController may decide to deny access immediately, and by that, to not execute the read (i.e., get or search) at all and throw an exception instead.

Method Summary

Modifier and Type	Method	Description
<T> T	doGet(SecurityContext securityContext, Function<ResourceAccessChecks,T> resourceChecksApplier)	Called before doing a get to retrieve a single resource.
<T> T	doSearch(SecurityContext securityContext, Function<ResourceAccessChecks,T> resourceChecksApplier)	Called before doing a search by query.
default boolean	isAnonymousAuthentication(CamundaAuthentication authentication)	Returns true if the given authentication is anonymous
boolean	supports(SecurityContext securityContext)	Returns true if the given securityContext is supported by this ResourceAccessController *

Method Details

doGet

<T> T doGet(SecurityContext securityContext,
 Function<ResourceAccessChecks,T> resourceChecksApplier)

Called before doing a get to retrieve a single resource.

Parameters:

securityContext - contains the CamundaAuthentication and the required authorization to be checked.

resourceChecksApplier - will be used to pass required @ResourceAccessChecks to the actual reader

doSearch

<T> T doSearch(SecurityContext securityContext,
 Function<ResourceAccessChecks,T> resourceChecksApplier)

Called before doing a search by query.

Parameters:

securityContext - contains the CamundaAuthentication and the required authorization to be checked.

resourceChecksApplier - will be used to pass required @ResourceAccessChecks to the actual reader

supports

boolean supports(SecurityContext securityContext)

Returns true if the given securityContext is supported by this ResourceAccessController *

isAnonymousAuthentication

default boolean isAnonymousAuthentication(CamundaAuthentication authentication)

Returns true if the given authentication is anonymous. *