org.casbin.jcasbin.main

Class CoreEnforcer

java.lang.Object

org.casbin.jcasbin.main.CoreEnforcer

Direct Known Subclasses:

ManagementEnforcer

public class CoreEnforcer
extends java.lang.Object

CoreEnforcer defines the core functionality of an enforcer.

Constructor Summary

Constructors

Constructor and Description
CoreEnforcer()

Method Summary

Modifier and Type	Method and Description
void	buildRoleLinks() buildRoleLinks manually rebuild the role inheritance relations.
void	clearPolicy() clearPolicy clears all policy.
void	enableAutoBuildRoleLinks(boolean autoBuildRoleLinks) enableAutoBuildRoleLinks controls whether to save a policy rule automatically to the adapter when it is added or removed.
void	enableAutoSave(boolean autoSave) enableAutoSave controls whether to save a policy rule automatically to the adapter when it is added or removed.
void	enableEnforce(boolean enable) enableEnforce changes the enforcing state of Casbin, when Casbin is disabled, all access will be allowed by the enforce() function.
void	enableLog(boolean enable) enableLog changes whether to print Casbin log to the standard output.
boolean	enforce(java.lang.Object... rvals) enforce decides whether a "subject" can access a "object" with the operation "action", input parameters are usually: (sub, obj, act).
Adapter	getAdapter() getAdapter gets the current adapter.
Model	getModel() getModel gets the current model.
boolean	isAutoNotifyWatcher()
boolean	isFiltered() isFiltered returns true if the loaded policy has been filtered.
void	loadFilteredPolicy(java.lang.Object filter) loadFilteredPolicy reloads a filtered policy from file/database.
void	loadModel() loadModel reloads the model from the model CONF file.
void	loadPolicy() loadPolicy reloads the policy from file/database.
static Model	newModel() newModel creates a model.
static Model	newModel(java.lang.String text) newModel creates a model.
static Model	newModel(java.lang.String modelPath, java.lang.String unused) newModel creates a model.
void	resetExpressionEvaluator() Invalidate cache of compiled model matcher expression.
void	savePolicy() savePolicy saves the current policy (usually after changed with Casbin API) back to file/database.
void	setAdapter(Adapter adapter) setAdapter sets the current adapter.
void	setAutoNotifyWatcher(boolean autoNotifyWatcher)
void	setEffector(Effector eft) setEffector sets the current effector.
void	setModel(Model model) setModel sets the current model.
void	setRoleManager(RoleManager rm) SetRoleManager sets the current role manager.
void	setWatcher(Watcher watcher) setWatcher sets the current watcher.
boolean	validateEnforce(java.lang.Object... rvals)

Methods inherited from class java.lang.Object

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

Constructor Detail

CoreEnforcer

public CoreEnforcer()

Method Detail

newModel

public static Model newModel()

newModel creates a model.

Returns:

an empty model.

newModel

public static Model newModel(java.lang.String text)

newModel creates a model.

Parameters:

text - the model text.

Returns:

the model.

newModel

public static Model newModel(java.lang.String modelPath,
                             java.lang.String unused)

newModel creates a model.

Parameters:

modelPath - the path of the model file.

unused - unused parameter, just for differentiating with newModel(String text).

Returns:

the model.

loadModel

public void loadModel()

loadModel reloads the model from the model CONF file. Because the policy is attached to a model, so the policy is invalidated and needs to be reloaded by calling LoadPolicy().

getModel

public Model getModel()

getModel gets the current model.

Returns:

the model of the enforcer.

setModel

public void setModel(Model model)

setModel sets the current model.

Parameters:

model - the model.

getAdapter

public Adapter getAdapter()

getAdapter gets the current adapter.

Returns:

the adapter of the enforcer.

setAdapter

public void setAdapter(Adapter adapter)

setAdapter sets the current adapter.

Parameters:

adapter - the adapter.

setWatcher

public void setWatcher(Watcher watcher)

setWatcher sets the current watcher.

Parameters:

watcher - the watcher.

setRoleManager

public void setRoleManager(RoleManager rm)

SetRoleManager sets the current role manager.

Parameters:

rm - the role manager.

setEffector

public void setEffector(Effector eft)

setEffector sets the current effector.

Parameters:

eft - the effector.

clearPolicy

public void clearPolicy()

clearPolicy clears all policy.

loadPolicy

public void loadPolicy()

loadPolicy reloads the policy from file/database.

loadFilteredPolicy

public void loadFilteredPolicy(java.lang.Object filter)

loadFilteredPolicy reloads a filtered policy from file/database.

Parameters:

filter - the filter used to specify which type of policy should be loaded.

isFiltered

public boolean isFiltered()

isFiltered returns true if the loaded policy has been filtered.

Returns:

if the loaded policy has been filtered.

savePolicy

public void savePolicy()

savePolicy saves the current policy (usually after changed with Casbin API) back to file/database.

enableEnforce

public void enableEnforce(boolean enable)

enableEnforce changes the enforcing state of Casbin, when Casbin is disabled, all access will be allowed by the enforce() function.

Parameters:

enable - whether to enable the enforcer.

enableLog

public void enableLog(boolean enable)

enableLog changes whether to print Casbin log to the standard output.

Parameters:

enable - whether to enable Casbin's log.

enableAutoSave

public void enableAutoSave(boolean autoSave)

enableAutoSave controls whether to save a policy rule automatically to the adapter when it is added or removed.

Parameters:

autoSave - whether to enable the AutoSave feature.

enableAutoBuildRoleLinks

public void enableAutoBuildRoleLinks(boolean autoBuildRoleLinks)

enableAutoBuildRoleLinks controls whether to save a policy rule automatically to the adapter when it is added or removed.

Parameters:

autoBuildRoleLinks - whether to automatically build the role links.

buildRoleLinks

public void buildRoleLinks()

buildRoleLinks manually rebuild the role inheritance relations.

enforce

public boolean enforce(java.lang.Object... rvals)

enforce decides whether a "subject" can access a "object" with the operation "action", input parameters are usually: (sub, obj, act).

Parameters:

rvals - the request needs to be mediated, usually an array of strings, can be class instances if ABAC is used.

Returns:

whether to allow the request.

validateEnforce

public boolean validateEnforce(java.lang.Object... rvals)

resetExpressionEvaluator

public void resetExpressionEvaluator()

Invalidate cache of compiled model matcher expression. This is done automatically most of the time, but you may need to call it explicitly if you manipulate directly Model.

isAutoNotifyWatcher

public boolean isAutoNotifyWatcher()

setAutoNotifyWatcher

public void setAutoNotifyWatcher(boolean autoNotifyWatcher)