Class SyncedCachedEnforcer

java.lang.Object

org.casbin.jcasbin.main.CoreEnforcer

org.casbin.jcasbin.main.InternalEnforcer

org.casbin.jcasbin.main.ManagementEnforcer

org.casbin.jcasbin.main.Enforcer

org.casbin.jcasbin.main.SyncedEnforcer

org.casbin.jcasbin.main.SyncedCachedEnforcer

public class SyncedCachedEnforcer
extends SyncedEnforcer

Field Summary

Fields

Modifier and Type	Field	Description
private Cache	cache
private final AtomicBoolean	enableCache
private Duration	expireTime
private static final ReadWriteLock	READ_WRITE_LOCK

Fields inherited from class CoreEnforcer

acceptJsonRequest, adapter, autoBuildRoleLinks, autoNotifyDispatcher, autoNotifyWatcher, autoSave, condRmMap, dispatcher, fm, model, modelPath, rmMap, watcher

Constructor Summary

Constructors

Constructor	Description
SyncedCachedEnforcer()	Default constructor.
SyncedCachedEnforcer(String modelPath)	Initializes an enforcer with a model file.
SyncedCachedEnforcer(String modelPath, String policyFile)	Initializes an enforcer with a model file and a policy file.
SyncedCachedEnforcer(String modelPath, String policyFile, boolean enableLog)	Initializes an enforcer with a model file, a policy file, and a logging flag.
SyncedCachedEnforcer(String modelPath, Adapter adapter)	Initializes an enforcer with a model file and a database adapter.
SyncedCachedEnforcer(Model m)	Initializes an enforcer with a model.
SyncedCachedEnforcer(Model m, Adapter adapter)	Initializes an enforcer with a model and a database adapter.

Method Summary

Modifier and Type	Method	Description
boolean	addPolicies(String[][] rules)	Adds multiple policies while checking and removing the cache.
boolean	addPolicies(List<List<String>> rules)	Adds multiple policies while checking and removing the cache.
boolean	addPolicy(String... params)	Adds a single policy while checking and removing the cache.
private boolean	checkManyAndRemoveCache(String[][] rules)	Checks and removes cache for multiple policies.
private boolean	checkManyAndRemoveCache(List<List<String>> rules)	Checks and removes cache for multiple policies.
private boolean	checkOneAndRemoveCache(String... params)	Checks and removes cache for a single policy.
void	enableCache(boolean enable)	Enables or disables caching.
boolean	enforce(Object... rvals)	Performs an enforcement check based on given parameters, using the cache.
private Boolean	getCachedResult(String key)	Retrieves a cached result based on the given key.
String	getCacheKey(Object... params)	Retrieves a cache key from the given parameters.
private String	getKey(Object... params)	Generates a key based on the given parameters.
void	invalidateCache()	Invalidates the cache by clearing it.
void	loadPolicy()	Loads the policy, clearing the cache if enabled.
boolean	removePolicies(String[][] rules)	Removes multiple policies while checking and removing the cache.
boolean	removePolicies(List<List<String>> rules)	Removes multiple policies while checking and removing the cache.
boolean	removePolicy(String... params)	Removes a single policy while checking and removing the cache.
void	setCache(Cache cache)	Sets a custom cache.
private void	setCachedResult(String key, boolean result, Object... extra)	Sets the cached result.
void	setExpireTime(Duration expireTime)	Sets the cache expiration time.

Methods inherited from class SyncedEnforcer

addGroupingPolicies, addGroupingPolicies, addGroupingPolicy, addGroupingPolicy, addNamedGroupingPolicies, addNamedGroupingPolicies, addNamedGroupingPolicy, addNamedGroupingPolicy, addNamedPolicies, addNamedPoliciesEx, addNamedPolicy, addNamedPolicy, addPermissionForUser, addPermissionForUser, addPolicy, addRoleForUser, addRoleForUserInDomain, batchEnforce, batchEnforceWithMatcher, buildRoleLinks, clearPolicy, deletePermission, deletePermission, deletePermissionForUser, deletePermissionForUser, deletePermissionsForUser, deleteRole, deleteRoleForUser, deleteRoleForUserInDomain, deleteRolesForUser, deleteUser, enforceEx, enforceExWithMatcher, enforceWithMatcher, getAllActions, getAllNamedActions, getAllNamedObjects, getAllNamedRoles, getAllObjects, getAllRoles, getAllSubjects, getFilteredGroupingPolicy, getFilteredNamedGroupingPolicy, getFilteredNamedPolicy, getFilteredPolicy, getGroupingPolicy, getImplicitPermissionsForUser, getImplicitRolesForUser, getNamedGroupingPolicy, getNamedImplicitPermissionsForUser, getNamedPermissionsForUser, getNamedPolicy, getPermissionsForUser, getPermissionsForUserInDomain, getPolicy, getRolesForUser, getRolesForUserInDomain, getUsersForRole, getUsersForRoleInDomain, hasGroupingPolicy, hasGroupingPolicy, hasNamedGroupingPolicy, hasNamedGroupingPolicy, hasNamedPolicy, hasNamedPolicy, hasPermissionForUser, hasPermissionForUser, hasPolicy, hasPolicy, hasRoleForUser, isAutoLoadingRunning, loadFilteredPolicy, removeFilteredGroupingPolicy, removeFilteredNamedGroupingPolicy, removeFilteredNamedPolicy, removeFilteredPolicy, removeGroupingPolicies, removeGroupingPolicies, removeGroupingPolicy, removeGroupingPolicy, removeNamedGroupingPolicies, removeNamedGroupingPolicies, removeNamedGroupingPolicy, removeNamedGroupingPolicy, removeNamedPolicies, removeNamedPolicy, removeNamedPolicy, removePolicy, savePolicy, setWatcher, startAutoLoadPolicy, stopAutoLoadPolicy, updateGroupingPolicy, updateNamedGroupingPolicy, updateNamedPolicy, updatePolicy

Methods inherited from class Enforcer

getImplicitPermissionsForUserInDomain, getImplicitUsersForRole, updatePermissionForUser

Methods inherited from class ManagementEnforcer

addFunction, getAllNamedSubjects, getPermittedActions

Methods inherited from class InternalEnforcer

addPolicies, addPolicy, buildIncrementalRoleLinks, getDomainIndex, removeFilteredPolicy, removePolicies, removePolicy, updatePolicy

Methods inherited from class CoreEnforcer

addNamedDomainLinkConditionFunc, addNamedDomainMatchingFunc, addNamedLinkConditionFunc, addNamedMatchingFunc, buildConditionalRoleLinks, enableAcceptJsonRequest, enableAutoBuildRoleLinks, enableAutoSave, enableEnforce, enableLog, getAdapter, getAviatorEval, getModel, getNamedRoleManager, getRmMap, getRoleManager, initialize, isAutoNotifyDispatcher, isAutoNotifyWatcher, isFiltered, loadModel, mustUseDispatcher, newModel, newModel, newModel, resetExpressionEvaluator, setAdapter, setAutoNotifyDispatcher, setAutoNotifyWatcher, setAviatorEvaluator, setDispatcher, setEffector, setModel, setNamedDomainLinkConditionFuncParams, setNamedLinkConditionFuncParams, setNamedRoleManager, setRoleManager, setRoleManager, validateEnforce

Methods inherited from class Object

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

Field Details

expireTime

private Duration expireTime

cache

private Cache cache

enableCache

private final AtomicBoolean enableCache

READ_WRITE_LOCK

private static final ReadWriteLock READ_WRITE_LOCK

Constructor Details

SyncedCachedEnforcer

public SyncedCachedEnforcer()

Default constructor. Initializes a new SyncedCachedEnforcer with a default cache.

SyncedCachedEnforcer

public SyncedCachedEnforcer(String modelPath,
 String policyFile)

Initializes an enforcer with a model file and a policy file.

Parameters:

modelPath - The path of the model file.

policyFile - The path of the policy file.

SyncedCachedEnforcer

public SyncedCachedEnforcer(String modelPath,
 Adapter adapter)

Initializes an enforcer with a model file and a database adapter.

Parameters:

modelPath - The path of the model file.

adapter - The adapter for the database.

SyncedCachedEnforcer

public SyncedCachedEnforcer(Model m,
 Adapter adapter)

Initializes an enforcer with a model and a database adapter.

Parameters:

m - The model.

adapter - The adapter for the database.

SyncedCachedEnforcer

public SyncedCachedEnforcer(Model m)

Initializes an enforcer with a model.

Parameters:

m - The model.

SyncedCachedEnforcer

public SyncedCachedEnforcer(String modelPath)

Initializes an enforcer with a model file.

Parameters:

modelPath - The path of the model file.

SyncedCachedEnforcer

public SyncedCachedEnforcer(String modelPath,
 String policyFile,
 boolean enableLog)

Initializes an enforcer with a model file, a policy file, and a logging flag.

Parameters:

modelPath - The path of the model file.

policyFile - The path of the policy file.

enableLog - Whether to enable logging for Casbin.

Method Details

enableCache

public void enableCache(boolean enable)

Enables or disables caching.

Parameters:

enable - Whether to enable caching.

enforce

public boolean enforce(Object... rvals)

Performs an enforcement check based on given parameters, using the cache.

Overrides:

enforce in class SyncedEnforcer

Parameters:

rvals - Parameters for the enforcement check.

Returns:

The result of the enforcement check.

loadPolicy

public void loadPolicy()

Loads the policy, clearing the cache if enabled.

Overrides:

loadPolicy in class SyncedEnforcer

addPolicy

public boolean addPolicy(String... params)

Adds a single policy while checking and removing the cache.

Overrides:

addPolicy in class SyncedEnforcer

Parameters:

params - Policy parameters.

Returns:

Whether the addition was successful.

addPolicies

public boolean addPolicies(List<List<String>> rules)

Adds multiple policies while checking and removing the cache.

Overrides:

addPolicies in class SyncedEnforcer

Parameters:

rules - Policy rules.

Returns:

Whether the addition was successful.

addPolicies

public boolean addPolicies(String[][] rules)

Adds multiple policies while checking and removing the cache.

Overrides:

addPolicies in class SyncedEnforcer

Parameters:

rules - Policy rules.

Returns:

Whether the addition was successful.

removePolicy

public boolean removePolicy(String... params)

Removes a single policy while checking and removing the cache.

Overrides:

removePolicy in class SyncedEnforcer

Parameters:

params - Policy parameters.

Returns:

Whether the removal was successful.

removePolicies

public boolean removePolicies(List<List<String>> rules)

Removes multiple policies while checking and removing the cache.

Overrides:

removePolicies in class SyncedEnforcer

Parameters:

rules - Policy rules.

Returns:

Whether the removal was successful.

removePolicies

public boolean removePolicies(String[][] rules)

Removes multiple policies while checking and removing the cache.

Overrides:

removePolicies in class SyncedEnforcer

Parameters:

rules - Policy rules.

Returns:

Whether the removal was successful.

getCachedResult

private Boolean getCachedResult(String key)

Retrieves a cached result based on the given key.

Parameters:

key - The cache key.

Returns:

The cached result.

setExpireTime

public void setExpireTime(Duration expireTime)

Sets the cache expiration time.

Parameters:

expireTime - The expiration time.

setCache

public void setCache(Cache cache)

Sets a custom cache.

Parameters:

cache - The custom cache.

setCachedResult

private void setCachedResult(String key,
 boolean result,
 Object... extra)

Sets the cached result.

Parameters:

key - The cache key.

result - The enforcement check result.

extra - Additional parameters.

getCacheKey

public String getCacheKey(Object... params)

Retrieves a cache key from the given parameters.

Parameters:

params - The parameters for generating the key.

Returns:

The generated cache key as a string.

getKey

private String getKey(Object... params)

Generates a key based on the given parameters.

Parameters:

params - Parameters.

Returns:

The generated key.

invalidateCache

public void invalidateCache()

Invalidates the cache by clearing it.

checkOneAndRemoveCache

private boolean checkOneAndRemoveCache(String... params)

Checks and removes cache for a single policy.

Parameters:

params - Policy parameters.

Returns:

Whether the check was successful.

checkManyAndRemoveCache

private boolean checkManyAndRemoveCache(List<List<String>> rules)

Checks and removes cache for multiple policies.

Parameters:

rules - Policy rules.

Returns:

Whether the check was successful.

checkManyAndRemoveCache

private boolean checkManyAndRemoveCache(String[][] rules)

Checks and removes cache for multiple policies.

Parameters:

rules - Policy rules.

Returns:

Whether the check was successful.