org.casbin.jcasbin.main

Class SyncedCachedEnforcer

java.lang.Object

org.casbin.jcasbin.main.CoreEnforcer

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	addPolicies(java.util.List<java.util.List<java.lang.String>> rules) Adds multiple policies while checking and removing the cache.
boolean	addPolicies(java.lang.String[][] rules) Adds multiple policies while checking and removing the cache.
boolean	addPolicy(java.lang.String... params) Adds a single policy while checking and removing the cache.
void	buildIncrementalRoleLinks(Model.PolicyOperations op, java.lang.String ptype, java.util.List<java.util.List<java.lang.String>> rules) buildIncrementalRoleLinks provides incremental build the role inheritance relations.
void	enableCache(boolean enable) Enables or disables caching.
boolean	enforce(java.lang.Object... rvals) Performs an enforcement check based on given parameters, using the cache.
java.lang.String	getCacheKey(java.lang.Object... params) Retrieves a cache key from the given parameters.
void	invalidateCache() Invalidates the cache by clearing it.
void	loadPolicy() Loads the policy, clearing the cache if enabled.
boolean	removePolicies(java.util.List<java.util.List<java.lang.String>> rules) Removes multiple policies while checking and removing the cache.
boolean	removePolicies(java.lang.String[][] rules) Removes multiple policies while checking and removing the cache.
boolean	removePolicy(java.lang.String... params) Removes a single policy while checking and removing the cache.
void	setCache(Cache cache) Sets a custom cache.
void	setExpireTime(java.time.Duration expireTime) Sets the cache expiration time.

Methods inherited from class org.casbin.jcasbin.main.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 org.casbin.jcasbin.main.Enforcer

getImplicitPermissionsForUserInDomain, getImplicitUsersForRole, updatePermissionForUser

Methods inherited from class org.casbin.jcasbin.main.ManagementEnforcer

addFunction, getAllNamedSubjects, getPermittedActions

Methods inherited from class org.casbin.jcasbin.main.CoreEnforcer

addNamedDomainLinkConditionFunc, addNamedDomainMatchingFunc, addNamedLinkConditionFunc, addNamedMatchingFunc, buildConditionalRoleLinks, enableAcceptJsonRequest, enableAutoBuildRoleLinks, enableAutoSave, enableEnforce, enableLog, getAdapter, getAviatorEval, getModel, getNamedRoleManager, getRmMap, getRoleManager, 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 java.lang.Object

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

Constructor Detail

SyncedCachedEnforcer

public SyncedCachedEnforcer()

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

SyncedCachedEnforcer

public SyncedCachedEnforcer(java.lang.String modelPath,
                            java.lang.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(java.lang.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(java.lang.String modelPath)

Initializes an enforcer with a model file.

Parameters:

modelPath - The path of the model file.

SyncedCachedEnforcer

public SyncedCachedEnforcer(java.lang.String modelPath,
                            java.lang.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 Detail

enableCache

public void enableCache(boolean enable)

Enables or disables caching.

Parameters:

enable - Whether to enable caching.

enforce

public boolean enforce(java.lang.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(java.lang.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(java.util.List<java.util.List<java.lang.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(java.lang.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(java.lang.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(java.util.List<java.util.List<java.lang.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(java.lang.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.

setExpireTime

public void setExpireTime(java.time.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.

getCacheKey

public java.lang.String getCacheKey(java.lang.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.

invalidateCache

public void invalidateCache()

Invalidates the cache by clearing it.

buildIncrementalRoleLinks

public void buildIncrementalRoleLinks(Model.PolicyOperations op,
                                      java.lang.String ptype,
                                      java.util.List<java.util.List<java.lang.String>> rules)

buildIncrementalRoleLinks provides incremental build the role inheritance relations.

Parameters:

op - Policy operations.

ptype - policy type.

rules - the rules.