org.camunda.bpm.cockpit.plugin.resource

Class AbstractCockpitPluginResource

java.lang.Object

org.camunda.bpm.webapp.plugin.resource.AbstractAppPluginResource<CockpitPlugin>

org.camunda.bpm.cockpit.plugin.resource.AbstractCockpitPluginResource

Direct Known Subclasses:

AbstractPluginResource

public class AbstractCockpitPluginResource
extends AbstractAppPluginResource<CockpitPlugin>

Base class for implementing a plugin REST resource.

Author:

Daniel Meyer

Field Summary

Fields inherited from class org.camunda.bpm.webapp.plugin.resource.AbstractAppPluginResource

engineName, runtimeDelegate

Constructor Summary

Constructors

Constructor and Description
AbstractCockpitPluginResource(String engineName)

Method Summary

Modifier and Type	Method and Description
protected void	addPermissionCheck(QueryParameters<?> query, Resource resource, String queryParam, Permission permission) Add a new PermissionCheck with the given values.
protected void	configureAuthorizationCheck(QueryParameters<?> query) Configure the authorization check for the given QueryParameters.
protected void	configureTenantCheck(QueryParameters<?> query) Configure the tenant check for the given QueryParameters.
protected CommandExecutor	getCommandExecutor() Return a CommandExecutor for the current engine to execute plugin commands.
protected Authentication	getCurrentAuthentication() Return the current authentication.
protected QueryService	getQueryService() Return a QueryService for the current engine to execute queries against the engine datbase.
protected boolean	isAuthorizationEnabled() Return true if authorization is enabled.
protected boolean	isCamundaAdmin(Authentication authentication) Return true if the given authentication contains the group Groups.CAMUNDA_ADMIN.
protected boolean	isTenantCheckEnabled() Return true if tenant check is enabled.

Methods inherited from class org.camunda.bpm.webapp.plugin.resource.AbstractAppPluginResource

getProcessEngine

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCockpitPluginResource

public AbstractCockpitPluginResource(String engineName)

Method Detail

getCommandExecutor

protected CommandExecutor getCommandExecutor()

Return a CommandExecutor for the current engine to execute plugin commands.

Returns:

getQueryService

protected QueryService getQueryService()

Return a QueryService for the current engine to execute queries against the engine datbase.

Returns:

isAuthorizationEnabled

protected boolean isAuthorizationEnabled()

Return true if authorization is enabled.

isTenantCheckEnabled

protected boolean isTenantCheckEnabled()

Return true if tenant check is enabled.

isCamundaAdmin

protected boolean isCamundaAdmin(Authentication authentication)

Return true if the given authentication contains the group Groups.CAMUNDA_ADMIN.

getCurrentAuthentication

protected Authentication getCurrentAuthentication()

Return the current authentication.

configureAuthorizationCheck

protected void configureAuthorizationCheck(QueryParameters<?> query)

Configure the authorization check for the given QueryParameters.

configureTenantCheck

protected void configureTenantCheck(QueryParameters<?> query)

Configure the tenant check for the given QueryParameters.

addPermissionCheck

protected void addPermissionCheck(QueryParameters<?> query,
                                  Resource resource,
                                  String queryParam,
                                  Permission permission)

Add a new PermissionCheck with the given values.