org.camunda.bpm.engine.impl.db

Class AuthorizationCheck

java.lang.Object

org.camunda.bpm.engine.impl.db.AuthorizationCheck

All Implemented Interfaces:

Serializable

public class AuthorizationCheck
extends Object
implements Serializable

Input for the authorization check algorithm

Author:

Daniel Meyer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	authDefaultPerm the default permissions to use if no matching authorization can be found.
protected List<String>	authGroupIds the ids of the groups to check permissions for
protected String	authUserId the id of the user to check permissions for
protected boolean	historicInstancePermissionsEnabled
protected boolean	isAuthorizationCheckEnabled If true authorization check is enabled.
protected boolean	isRevokeAuthorizationCheckEnabled Indicates if the revoke authorization checks are enabled or not.
protected CompositePermissionCheck	permissionChecks
protected boolean	shouldPerformAuthorizatioCheck If true authorization check is performed.
protected boolean	useLeftJoin

Constructor Summary

Constructors

Constructor and Description
AuthorizationCheck()
AuthorizationCheck(String authUserId, List<String> authGroupIds, CompositePermissionCheck permissionCheck, boolean isRevokeAuthorizationCheckEnabled)

Method Summary

Modifier and Type	Method and Description
void	addAtomicPermissionCheck(PermissionCheck permissionCheck)
int	getAuthDefaultPerm()
List<String>	getAuthGroupIds()
String	getAuthUserId()
boolean	getIsAuthorizationCheckEnabled()
CompositePermissionCheck	getPermissionChecks()
boolean	getShouldPerformAuthorizatioCheck() is used by myBatis
boolean	isAuthorizationCheckEnabled()
boolean	isHistoricInstancePermissionsEnabled() Used in SQL mapping
protected boolean	isPermissionChecksEmpty()
boolean	isRevokeAuthorizationCheckEnabled()
boolean	isUseLeftJoin()
void	setAtomicPermissionChecks(List<PermissionCheck> permissionChecks)
void	setAuthDefaultPerm(int authDefaultPerm)
void	setAuthGroupIds(List<String> authGroupIds)
void	setAuthorizationCheckEnabled(boolean isAuthorizationCheckPerformed)
void	setAuthUserId(String authUserId)
void	setHistoricInstancePermissionsEnabled(boolean historicInstancePermissionsEnabled)
void	setPermissionChecks(CompositePermissionCheck permissionChecks)
void	setRevokeAuthorizationCheckEnabled(boolean isRevokeAuthorizationCheckEnabled)
void	setShouldPerformAuthorizatioCheck(boolean shouldPerformAuthorizatioCheck)
void	setUseLeftJoin(boolean useLeftJoin)
boolean	shouldPerformAuthorizatioCheck()

Methods inherited from class java.lang.Object

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

Field Detail

isAuthorizationCheckEnabled

protected boolean isAuthorizationCheckEnabled

If true authorization check is enabled. for This switch is useful when implementing a query which may perform an authorization check only under certain circumstances.

shouldPerformAuthorizatioCheck

protected boolean shouldPerformAuthorizatioCheck

If true authorization check is performed.

isRevokeAuthorizationCheckEnabled

protected boolean isRevokeAuthorizationCheckEnabled

Indicates if the revoke authorization checks are enabled or not. The authorization checks without checking revoke permissions are much more faster.

authUserId

protected String authUserId

the id of the user to check permissions for

authGroupIds

protected List<String> authGroupIds

the ids of the groups to check permissions for

authDefaultPerm

protected int authDefaultPerm

the default permissions to use if no matching authorization can be found.

permissionChecks

protected CompositePermissionCheck permissionChecks

historicInstancePermissionsEnabled

protected boolean historicInstancePermissionsEnabled

useLeftJoin

protected boolean useLeftJoin

Constructor Detail

AuthorizationCheck

public AuthorizationCheck()

AuthorizationCheck

public AuthorizationCheck(String authUserId,
                          List<String> authGroupIds,
                          CompositePermissionCheck permissionCheck,
                          boolean isRevokeAuthorizationCheckEnabled)

Method Detail

isAuthorizationCheckEnabled

public boolean isAuthorizationCheckEnabled()

getIsAuthorizationCheckEnabled

public boolean getIsAuthorizationCheckEnabled()

setAuthorizationCheckEnabled

public void setAuthorizationCheckEnabled(boolean isAuthorizationCheckPerformed)

shouldPerformAuthorizatioCheck

public boolean shouldPerformAuthorizatioCheck()

getShouldPerformAuthorizatioCheck

public boolean getShouldPerformAuthorizatioCheck()

is used by myBatis

setShouldPerformAuthorizatioCheck

public void setShouldPerformAuthorizatioCheck(boolean shouldPerformAuthorizatioCheck)

isPermissionChecksEmpty

protected boolean isPermissionChecksEmpty()

getAuthUserId

public String getAuthUserId()

setAuthUserId

public void setAuthUserId(String authUserId)

getAuthGroupIds

public List<String> getAuthGroupIds()

setAuthGroupIds

public void setAuthGroupIds(List<String> authGroupIds)

getAuthDefaultPerm

public int getAuthDefaultPerm()

setAuthDefaultPerm

public void setAuthDefaultPerm(int authDefaultPerm)

getPermissionChecks

public CompositePermissionCheck getPermissionChecks()

setAtomicPermissionChecks

public void setAtomicPermissionChecks(List<PermissionCheck> permissionChecks)

addAtomicPermissionCheck

public void addAtomicPermissionCheck(PermissionCheck permissionCheck)

setPermissionChecks

public void setPermissionChecks(CompositePermissionCheck permissionChecks)

isRevokeAuthorizationCheckEnabled

public boolean isRevokeAuthorizationCheckEnabled()

setRevokeAuthorizationCheckEnabled

public void setRevokeAuthorizationCheckEnabled(boolean isRevokeAuthorizationCheckEnabled)

setHistoricInstancePermissionsEnabled

public void setHistoricInstancePermissionsEnabled(boolean historicInstancePermissionsEnabled)

isHistoricInstancePermissionsEnabled

public boolean isHistoricInstancePermissionsEnabled()

Used in SQL mapping

isUseLeftJoin

public boolean isUseLeftJoin()

setUseLeftJoin

public void setUseLeftJoin(boolean useLeftJoin)