org.casbin.jcasbin.main

Class SyncedEnforcer

java.lang.Object

org.casbin.jcasbin.main.CoreEnforcer

org.casbin.jcasbin.main.ManagementEnforcer

org.casbin.jcasbin.main.Enforcer

org.casbin.jcasbin.main.SyncedEnforcer

public class SyncedEnforcer
extends Enforcer

SyncedEnforcer = ManagementEnforcer + RBAC API.

Constructor Summary

Constructors

Constructor and Description
SyncedEnforcer() ; SyncedEnforcer is the default constructor.
SyncedEnforcer(Model m) SyncedEnforcer initializes an enforcer with a model.
SyncedEnforcer(Model m, Adapter adapter) SyncedEnforcer initializes an enforcer with a model and a database adapter.
SyncedEnforcer(java.lang.String modelPath) SyncedEnforcer initializes an enforcer with a model file.
SyncedEnforcer(java.lang.String modelPath, Adapter adapter) SyncedEnforcer initializes an enforcer with a database adapter.
SyncedEnforcer(java.lang.String modelPath, java.lang.String policyFile) SyncedEnforcer initializes an enforcer with a model file and a policy file.
SyncedEnforcer(java.lang.String modelPath, java.lang.String policyFile, boolean enableLog) SyncedEnforcer initializes an enforcer with a model file, a policy file and an enable log flag.

Method Summary

Modifier and Type	Method and Description
boolean	addGroupingPolicy(java.util.List<java.lang.String> params) addGroupingPolicy adds a role inheritance rule to the current policy.
boolean	addGroupingPolicy(java.lang.String... params) addGroupingPolicy adds a role inheritance rule to the current policy.
boolean	addNamedGroupingPolicy(java.lang.String ptype, java.util.List<java.lang.String> params) addNamedGroupingPolicy adds a named role inheritance rule to the current policy.
boolean	addNamedGroupingPolicy(java.lang.String ptype, java.lang.String... params) addNamedGroupingPolicy adds a named role inheritance rule to the current policy.
boolean	addNamedPolicy(java.lang.String ptype, java.util.List<java.lang.String> params) AddNamedPolicy adds an authorization rule to the current named policy.
boolean	addNamedPolicy(java.lang.String ptype, java.lang.String... params) AddNamedPolicy adds an authorization rule to the current named policy.
boolean	addPermissionForUser(java.lang.String user, java.util.List<java.lang.String> permission) addPermissionForUser adds a permission for a user or role.
boolean	addPermissionForUser(java.lang.String user, java.lang.String... permission) addPermissionForUser adds a permission for a user or role.
boolean	addPolicy(java.util.List<java.lang.String> params) addPolicy adds an authorization rule to the current policy.
boolean	addPolicy(java.lang.String... params) addPolicy adds an authorization rule to the current policy.
boolean	addRoleForUser(java.lang.String user, java.lang.String role) addRoleForUser adds a role for a user.
boolean	addRoleForUserInDomain(java.lang.String user, java.lang.String role, java.lang.String domain) addRoleForUserInDomain adds a role for a user inside a domain.
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	buildRoleLinks() buildRoleLinks manually rebuild the role inheritance relations.
void	clearPolicy() clearPolicy clears all policy.
boolean	deletePermission(java.util.List<java.lang.String> permission) deletePermission deletes a permission.
boolean	deletePermission(java.lang.String... permission) deletePermission deletes a permission.
boolean	deletePermissionForUser(java.lang.String user, java.util.List<java.lang.String> permission) deletePermissionForUser deletes a permission for a user or role.
boolean	deletePermissionForUser(java.lang.String user, java.lang.String... permission) deletePermissionForUser deletes a permission for a user or role.
boolean	deletePermissionsForUser(java.lang.String user) deletePermissionsForUser deletes permissions for a user or role.
void	deleteRole(java.lang.String role) deleteRole deletes a role.
boolean	deleteRoleForUser(java.lang.String user, java.lang.String role) deleteRoleForUser deletes a role for a user.
boolean	deleteRoleForUserInDomain(java.lang.String user, java.lang.String role, java.lang.String domain) deleteRoleForUserInDomain deletes a role for a user inside a domain.
boolean	deleteRolesForUser(java.lang.String user) deleteRolesForUser deletes all roles for a user.
boolean	deleteUser(java.lang.String user) deleteUser deletes a user.
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).
java.util.List<java.lang.String>	getAllActions() getAllActions gets the list of actions that show up in the current policy.
java.util.List<java.lang.String>	getAllNamedActions(java.lang.String ptype) GetAllNamedActions gets the list of actions that show up in the current named policy.
java.util.List<java.lang.String>	getAllNamedObjects(java.lang.String ptype) getAllNamedObjects gets the list of objects that show up in the current named policy.
java.util.List<java.lang.String>	getAllNamedRoles(java.lang.String ptype) getAllNamedRoles gets the list of roles that show up in the current named policy.
java.util.List<java.lang.String>	getAllObjects() getAllObjects gets the list of objects that show up in the current policy.
java.util.List<java.lang.String>	getAllRoles() getAllRoles gets the list of roles that show up in the current policy.
java.util.List<java.lang.String>	getAllSubjects() getAllSubjects gets the list of subjects that show up in the current policy.
java.util.List<java.util.List<java.lang.String>>	getFilteredGroupingPolicy(int fieldIndex, java.lang.String... fieldValues) getFilteredGroupingPolicy gets all the role inheritance rules in the policy, field filters can be specified.
java.util.List<java.util.List<java.lang.String>>	getFilteredNamedGroupingPolicy(java.lang.String ptype, int fieldIndex, java.lang.String... fieldValues) getFilteredNamedGroupingPolicy gets all the role inheritance rules in the policy, field filters can be specified.
java.util.List<java.util.List<java.lang.String>>	getFilteredNamedPolicy(java.lang.String ptype, int fieldIndex, java.lang.String... fieldValues) getFilteredNamedPolicy gets all the authorization rules in the named policy, field filters can be specified.
java.util.List<java.util.List<java.lang.String>>	getFilteredPolicy(int fieldIndex, java.lang.String... fieldValues) getFilteredPolicy gets all the authorization rules in the policy, field filters can be specified.
java.util.List<java.util.List<java.lang.String>>	getGroupingPolicy() getGroupingPolicy gets all the role inheritance rules in the policy.
java.util.List<java.util.List<java.lang.String>>	getImplicitPermissionsForUser(java.lang.String user) getImplicitPermissionsForUser gets implicit permissions for a user or role.
java.util.List<java.lang.String>	getImplicitRolesForUser(java.lang.String name, java.lang.String... domain) getImplicitRolesForUser gets implicit roles that a user has.
java.util.List<java.util.List<java.lang.String>>	getNamedGroupingPolicy(java.lang.String ptype) getNamedGroupingPolicy gets all the role inheritance rules in the policy.
java.util.List<java.util.List<java.lang.String>>	getNamedPolicy(java.lang.String ptype) getNamedPolicy gets all the authorization rules in the named policy.
java.util.List<java.util.List<java.lang.String>>	getPermissionsForUser(java.lang.String user) getPermissionsForUser gets permissions for a user or role.
java.util.List<java.util.List<java.lang.String>>	getPermissionsForUserInDomain(java.lang.String user, java.lang.String domain) getPermissionsForUserInDomain gets permissions for a user or role inside a domain.
java.util.List<java.util.List<java.lang.String>>	getPolicy() getPolicy gets all the authorization rules in the policy.
java.util.List<java.lang.String>	getRolesForUser(java.lang.String name) getRolesForUser gets the roles that a user has.
java.util.List<java.lang.String>	getRolesForUserInDomain(java.lang.String name, java.lang.String domain) getRolesForUserInDomain gets the roles that a user has inside a domain.
java.util.List<java.lang.String>	getUsersForRole(java.lang.String name) getUsersForRole gets the users that has a role.
boolean	hasGroupingPolicy(java.util.List<java.lang.String> params) hasGroupingPolicy determines whether a role inheritance rule exists.
boolean	hasGroupingPolicy(java.lang.String... params) hasGroupingPolicy determines whether a role inheritance rule exists.
boolean	hasNamedGroupingPolicy(java.lang.String ptype, java.util.List<java.lang.String> params) hasNamedGroupingPolicy determines whether a named role inheritance rule exists.
boolean	hasNamedGroupingPolicy(java.lang.String ptype, java.lang.String... params) hasNamedGroupingPolicy determines whether a named role inheritance rule exists.
boolean	hasNamedPolicy(java.lang.String ptype, java.util.List<java.lang.String> params) hasNamedPolicy determines whether a named authorization rule exists.
boolean	hasNamedPolicy(java.lang.String ptype, java.lang.String... params) hasNamedPolicy determines whether a named authorization rule exists.
boolean	hasPermissionForUser(java.lang.String user, java.util.List<java.lang.String> permission) hasPermissionForUser determines whether a user has a permission.
boolean	hasPermissionForUser(java.lang.String user, java.lang.String... permission) hasPermissionForUser determines whether a user has a permission.
boolean	hasPolicy(java.util.List<java.lang.String> params) hasPolicy determines whether an authorization rule exists.
boolean	hasPolicy(java.lang.String... params) hasPolicy determines whether an authorization rule exists.
boolean	hasRoleForUser(java.lang.String name, java.lang.String role) hasRoleForUser determines whether a user has a role.
void	loadFilteredPolicy(java.lang.Object filter) loadFilteredPolicy reloads a filtered policy from file/database.
void	loadPolicy() loadPolicy reloads the policy from file/database.
boolean	removeFilteredGroupingPolicy(int fieldIndex, java.lang.String... fieldValues) removeFilteredGroupingPolicy removes a role inheritance rule from the current policy, field filters can be specified.
boolean	removeFilteredNamedGroupingPolicy(java.lang.String ptype, int fieldIndex, java.lang.String... fieldValues) removeFilteredNamedGroupingPolicy removes a role inheritance rule from the current named policy, field filters can be specified.
boolean	removeFilteredNamedPolicy(java.lang.String ptype, int fieldIndex, java.lang.String... fieldValues) removeFilteredNamedPolicy removes an authorization rule from the current named policy, field filters can be specified.
boolean	removeFilteredPolicy(int fieldIndex, java.lang.String... fieldValues) removeFilteredPolicy removes an authorization rule from the current policy, field filters can be specified.
boolean	removeGroupingPolicy(java.util.List<java.lang.String> params) removeGroupingPolicy removes a role inheritance rule from the current policy.
boolean	removeGroupingPolicy(java.lang.String... params) removeGroupingPolicy removes a role inheritance rule from the current policy.
boolean	removeNamedGroupingPolicy(java.lang.String ptype, java.util.List<java.lang.String> params) removeNamedGroupingPolicy removes a role inheritance rule from the current named policy.
boolean	removeNamedGroupingPolicy(java.lang.String ptype, java.lang.String... params) removeNamedGroupingPolicy removes a role inheritance rule from the current named policy.
boolean	removeNamedPolicy(java.lang.String ptype, java.util.List<java.lang.String> params) removeNamedPolicy removes an authorization rule from the current named policy.
boolean	removeNamedPolicy(java.lang.String ptype, java.lang.String... params) removeNamedPolicy removes an authorization rule from the current named policy.
boolean	removePolicy(java.util.List<java.lang.String> params) removePolicy removes an authorization rule from the current policy.
boolean	removePolicy(java.lang.String... params) removePolicy removes an authorization rule from the current policy.
void	savePolicy() savePolicy saves the current policy (usually after changed with Casbin API) back to file/database.
void	setWatcher(Watcher watcher) setWatcher sets the current watcher.

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

getImplicitPermissionsForUserInDomain

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

addFunction, getAllNamedSubjects, getPermittedActions

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

enableAutoBuildRoleLinks, enableAutoSave, enableEnforce, enableLog, getAdapter, getModel, isAutoNotifyWatcher, isFiltered, loadModel, newModel, newModel, newModel, resetExpressionEvaluator, setAdapter, setAutoNotifyWatcher, setEffector, setModel, setRoleManager, validateEnforce

Methods inherited from class java.lang.Object

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

Constructor Detail

SyncedEnforcer

public SyncedEnforcer()

; SyncedEnforcer is the default constructor.

SyncedEnforcer

public SyncedEnforcer(java.lang.String modelPath,
                      java.lang.String policyFile)

SyncedEnforcer 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.

SyncedEnforcer

public SyncedEnforcer(java.lang.String modelPath,
                      Adapter adapter)

SyncedEnforcer initializes an enforcer with a database adapter.

Parameters:

modelPath - the path of the model file.

adapter - the adapter.

SyncedEnforcer

public SyncedEnforcer(Model m,
                      Adapter adapter)

SyncedEnforcer initializes an enforcer with a model and a database adapter.

Parameters:

m - the model.

adapter - the adapter.

SyncedEnforcer

public SyncedEnforcer(Model m)

SyncedEnforcer initializes an enforcer with a model.

Parameters:

m - the model.

SyncedEnforcer

public SyncedEnforcer(java.lang.String modelPath)

SyncedEnforcer initializes an enforcer with a model file.

Parameters:

modelPath - the path of the model file.

SyncedEnforcer

public SyncedEnforcer(java.lang.String modelPath,
                      java.lang.String policyFile,
                      boolean enableLog)

SyncedEnforcer initializes an enforcer with a model file, a policy file and an enable log flag.

Parameters:

modelPath - the path of the model file.

policyFile - the path of the policy file.

enableLog - whether to enable Casbin's log.

Method Detail

setWatcher

public void setWatcher(Watcher watcher)

setWatcher sets the current watcher.

Overrides:

setWatcher in class CoreEnforcer

Parameters:

watcher - the watcher.

clearPolicy

public void clearPolicy()

clearPolicy clears all policy.

Overrides:

clearPolicy in class CoreEnforcer

loadPolicy

public void loadPolicy()

loadPolicy reloads the policy from file/database.

Overrides:

loadPolicy in class CoreEnforcer

loadFilteredPolicy

public void loadFilteredPolicy(java.lang.Object filter)

loadFilteredPolicy reloads a filtered policy from file/database.

Overrides:

loadFilteredPolicy in class CoreEnforcer

Parameters:

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

savePolicy

public void savePolicy()

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

Overrides:

savePolicy in class CoreEnforcer

buildRoleLinks

public void buildRoleLinks()

buildRoleLinks manually rebuild the role inheritance relations.

Overrides:

buildRoleLinks in class CoreEnforcer

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).

Overrides:

enforce in class CoreEnforcer

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.

getAllSubjects

public java.util.List<java.lang.String> getAllSubjects()

getAllSubjects gets the list of subjects that show up in the current policy.

Overrides:

getAllSubjects in class ManagementEnforcer

Returns:

all the subjects in "p" policy rules. It actually collects the 0-index elements of "p" policy rules. So make sure your subject is the 0-index element, like (sub, obj, act). Duplicates are removed.

getAllObjects

public java.util.List<java.lang.String> getAllObjects()

getAllObjects gets the list of objects that show up in the current policy.

Overrides:

getAllObjects in class ManagementEnforcer

Returns:

all the objects in "p" policy rules. It actually collects the 1-index elements of "p" policy rules. So make sure your object is the 1-index element, like (sub, obj, act). Duplicates are removed.

getAllNamedObjects

public java.util.List<java.lang.String> getAllNamedObjects(java.lang.String ptype)

getAllNamedObjects gets the list of objects that show up in the current named policy.

Overrides:

getAllNamedObjects in class ManagementEnforcer

Parameters:

ptype - the policy type, can be "p", "p2", "p3", ..

Returns:

all the objects in policy rules of the ptype type. It actually collects the 1-index elements of the policy rules. So make sure your object is the 1-index element, like (sub, obj, act). Duplicates are removed.

getAllActions

public java.util.List<java.lang.String> getAllActions()

getAllActions gets the list of actions that show up in the current policy.

Overrides:

getAllActions in class ManagementEnforcer

Returns:

all the actions in "p" policy rules. It actually collects the 2-index elements of "p" policy rules. So make sure your action is the 2-index element, like (sub, obj, act). Duplicates are removed.

getAllNamedActions

public java.util.List<java.lang.String> getAllNamedActions(java.lang.String ptype)

GetAllNamedActions gets the list of actions that show up in the current named policy.

Overrides:

getAllNamedActions in class ManagementEnforcer

Parameters:

ptype - the policy type, can be "p", "p2", "p3", ..

Returns:

all the actions in policy rules of the ptype type. It actually collects the 2-index elements of the policy rules. So make sure your action is the 2-index element, like (sub, obj, act). Duplicates are removed.

getAllRoles

public java.util.List<java.lang.String> getAllRoles()

getAllRoles gets the list of roles that show up in the current policy.

Overrides:

getAllRoles in class ManagementEnforcer

Returns:

all the roles in "g" policy rules. It actually collects the 1-index elements of "g" policy rules. So make sure your role is the 1-index element, like (sub, role). Duplicates are removed.

getAllNamedRoles

public java.util.List<java.lang.String> getAllNamedRoles(java.lang.String ptype)

getAllNamedRoles gets the list of roles that show up in the current named policy.

Overrides:

getAllNamedRoles in class ManagementEnforcer

Parameters:

ptype - the policy type, can be "g", "g2", "g3", ..

Returns:

all the subjects in policy rules of the ptype type. It actually collects the 0-index elements of the policy rules. So make sure your subject is the 0-index element, like (sub, obj, act). Duplicates are removed.

getPolicy

public java.util.List<java.util.List<java.lang.String>> getPolicy()

getPolicy gets all the authorization rules in the policy.

Overrides:

getPolicy in class ManagementEnforcer

Returns:

all the "p" policy rules.

getFilteredPolicy

public java.util.List<java.util.List<java.lang.String>> getFilteredPolicy(int fieldIndex,
                                                                          java.lang.String... fieldValues)

getFilteredPolicy gets all the authorization rules in the policy, field filters can be specified.

Overrides:

getFilteredPolicy in class ManagementEnforcer

Parameters:

fieldIndex - the policy rule's start index to be matched.

fieldValues - the field values to be matched, value "" means not to match this field.

Returns:

the filtered "p" policy rules.

getNamedPolicy

public java.util.List<java.util.List<java.lang.String>> getNamedPolicy(java.lang.String ptype)

getNamedPolicy gets all the authorization rules in the named policy.

Overrides:

getNamedPolicy in class ManagementEnforcer

Parameters:

ptype - the policy type, can be "p", "p2", "p3", ..

Returns:

the "p" policy rules of the specified ptype.

getFilteredNamedPolicy

public java.util.List<java.util.List<java.lang.String>> getFilteredNamedPolicy(java.lang.String ptype,
                                                                               int fieldIndex,
                                                                               java.lang.String... fieldValues)

getFilteredNamedPolicy gets all the authorization rules in the named policy, field filters can be specified.

Overrides:

getFilteredNamedPolicy in class ManagementEnforcer

Parameters:

ptype - the policy type, can be "p", "p2", "p3", ..

fieldIndex - the policy rule's start index to be matched.

fieldValues - the field values to be matched, value "" means not to match this field.

Returns:

the filtered "p" policy rules of the specified ptype.

getGroupingPolicy

public java.util.List<java.util.List<java.lang.String>> getGroupingPolicy()

getGroupingPolicy gets all the role inheritance rules in the policy.

Overrides:

getGroupingPolicy in class ManagementEnforcer

Returns:

all the "g" policy rules.

getRolesForUser

public java.util.List<java.lang.String> getRolesForUser(java.lang.String name)

getRolesForUser gets the roles that a user has.

Overrides:

getRolesForUser in class Enforcer

Parameters:

name - the user.

Returns:

the roles that the user has.

getFilteredGroupingPolicy

public java.util.List<java.util.List<java.lang.String>> getFilteredGroupingPolicy(int fieldIndex,
                                                                                  java.lang.String... fieldValues)

getFilteredGroupingPolicy gets all the role inheritance rules in the policy, field filters can be specified.

Overrides:

getFilteredGroupingPolicy in class ManagementEnforcer

Parameters:

fieldIndex - the policy rule's start index to be matched.

fieldValues - the field values to be matched, value "" means not to match this field.

Returns:

the filtered "g" policy rules.

getNamedGroupingPolicy

public java.util.List<java.util.List<java.lang.String>> getNamedGroupingPolicy(java.lang.String ptype)

getNamedGroupingPolicy gets all the role inheritance rules in the policy.

Overrides:

getNamedGroupingPolicy in class ManagementEnforcer

Parameters:

ptype - the policy type, can be "g", "g2", "g3", ..

Returns:

the "g" policy rules of the specified ptype.

getFilteredNamedGroupingPolicy

public java.util.List<java.util.List<java.lang.String>> getFilteredNamedGroupingPolicy(java.lang.String ptype,
                                                                                       int fieldIndex,
                                                                                       java.lang.String... fieldValues)

getFilteredNamedGroupingPolicy gets all the role inheritance rules in the policy, field filters can be specified.

Overrides:

getFilteredNamedGroupingPolicy in class ManagementEnforcer

Parameters:

ptype - the policy type, can be "g", "g2", "g3", ..

fieldIndex - the policy rule's start index to be matched.

fieldValues - the field values to be matched, value "" means not to match this field.

Returns:

the filtered "g" policy rules of the specified ptype.

hasPolicy

public boolean hasPolicy(java.util.List<java.lang.String> params)

hasPolicy determines whether an authorization rule exists.

Overrides:

hasPolicy in class ManagementEnforcer

Parameters:

params - the "p" policy rule, ptype "p" is implicitly used.

Returns:

whether the rule exists.

hasPolicy

public boolean hasPolicy(java.lang.String... params)

hasPolicy determines whether an authorization rule exists.

Overrides:

hasPolicy in class ManagementEnforcer

Parameters:

params - the "p" policy rule, ptype "p" is implicitly used.

Returns:

whether the rule exists.

hasNamedPolicy

public boolean hasNamedPolicy(java.lang.String ptype,
                              java.util.List<java.lang.String> params)

hasNamedPolicy determines whether a named authorization rule exists.

Overrides:

hasNamedPolicy in class ManagementEnforcer

Parameters:

ptype - the policy type, can be "p", "p2", "p3", ..

params - the "p" policy rule.

Returns:

whether the rule exists.

hasNamedPolicy

public boolean hasNamedPolicy(java.lang.String ptype,
                              java.lang.String... params)

hasNamedPolicy determines whether a named authorization rule exists.

Overrides:

hasNamedPolicy in class ManagementEnforcer

Parameters:

ptype - the policy type, can be "p", "p2", "p3", ..

params - the "p" policy rule.

Returns:

whether the rule exists.

addPolicy

public boolean addPolicy(java.util.List<java.lang.String> params)

addPolicy adds an authorization rule to the current policy. If the rule already exists, the function returns false and the rule will not be added. Otherwise the function returns true by adding the new rule.

Overrides:

addPolicy in class ManagementEnforcer

Parameters:

params - the "p" policy rule, ptype "p" is implicitly used.

Returns:

succeeds or not.

addPolicy

public boolean addPolicy(java.lang.String... params)

addPolicy adds an authorization rule to the current policy. If the rule already exists, the function returns false and the rule will not be added. Otherwise the function returns true by adding the new rule.

Overrides:

addPolicy in class ManagementEnforcer

Parameters:

params - the "p" policy rule, ptype "p" is implicitly used.

Returns:

succeeds or not.

addNamedPolicy

public boolean addNamedPolicy(java.lang.String ptype,
                              java.util.List<java.lang.String> params)

AddNamedPolicy adds an authorization rule to the current named policy. If the rule already exists, the function returns false and the rule will not be added. Otherwise the function returns true by adding the new rule.

Overrides:

addNamedPolicy in class ManagementEnforcer

Parameters:

ptype - the policy type, can be "p", "p2", "p3", ..

params - the "p" policy rule.

Returns:

succeeds or not.

addNamedPolicy

public boolean addNamedPolicy(java.lang.String ptype,
                              java.lang.String... params)

AddNamedPolicy adds an authorization rule to the current named policy. If the rule already exists, the function returns false and the rule will not be added. Otherwise the function returns true by adding the new rule.

Overrides:

addNamedPolicy in class ManagementEnforcer

Parameters:

ptype - the policy type, can be "p", "p2", "p3", ..

params - the "p" policy rule.

Returns:

succeeds or not.

removePolicy

public boolean removePolicy(java.util.List<java.lang.String> params)

removePolicy removes an authorization rule from the current policy.

Overrides:

removePolicy in class ManagementEnforcer

Parameters:

params - the "p" policy rule, ptype "p" is implicitly used.

Returns:

succeeds or not.

removePolicy

public boolean removePolicy(java.lang.String... params)

removePolicy removes an authorization rule from the current policy.

Overrides:

removePolicy in class ManagementEnforcer

Parameters:

params - the "p" policy rule, ptype "p" is implicitly used.

Returns:

succeeds or not.

removeFilteredPolicy

public boolean removeFilteredPolicy(int fieldIndex,
                                    java.lang.String... fieldValues)

removeFilteredPolicy removes an authorization rule from the current policy, field filters can be specified.

Overrides:

removeFilteredPolicy in class ManagementEnforcer

Parameters:

fieldIndex - the policy rule's start index to be matched.

fieldValues - the field values to be matched, value "" means not to match this field.

Returns:

succeeds or not.

removeNamedPolicy

public boolean removeNamedPolicy(java.lang.String ptype,
                                 java.util.List<java.lang.String> params)

removeNamedPolicy removes an authorization rule from the current named policy.

Overrides:

removeNamedPolicy in class ManagementEnforcer

Parameters:

ptype - the policy type, can be "p", "p2", "p3", ..

params - the "p" policy rule.

Returns:

succeeds or not.

removeNamedPolicy

public boolean removeNamedPolicy(java.lang.String ptype,
                                 java.lang.String... params)

removeNamedPolicy removes an authorization rule from the current named policy.

Overrides:

removeNamedPolicy in class ManagementEnforcer

Parameters:

ptype - the policy type, can be "p", "p2", "p3", ..

params - the "p" policy rule.

Returns:

succeeds or not.

removeFilteredNamedPolicy

public boolean removeFilteredNamedPolicy(java.lang.String ptype,
                                         int fieldIndex,
                                         java.lang.String... fieldValues)

removeFilteredNamedPolicy removes an authorization rule from the current named policy, field filters can be specified.

Overrides:

removeFilteredNamedPolicy in class ManagementEnforcer

Parameters:

ptype - the policy type, can be "p", "p2", "p3", ..

fieldIndex - the policy rule's start index to be matched.

fieldValues - the field values to be matched, value "" means not to match this field.

Returns:

succeeds or not.

hasGroupingPolicy

public boolean hasGroupingPolicy(java.util.List<java.lang.String> params)

hasGroupingPolicy determines whether a role inheritance rule exists.

Overrides:

hasGroupingPolicy in class ManagementEnforcer

Parameters:

params - the "g" policy rule, ptype "g" is implicitly used.

Returns:

whether the rule exists.

hasGroupingPolicy

public boolean hasGroupingPolicy(java.lang.String... params)

hasGroupingPolicy determines whether a role inheritance rule exists.

Overrides:

hasGroupingPolicy in class ManagementEnforcer

Parameters:

params - the "g" policy rule, ptype "g" is implicitly used.

Returns:

whether the rule exists.

hasNamedGroupingPolicy

public boolean hasNamedGroupingPolicy(java.lang.String ptype,
                                      java.util.List<java.lang.String> params)

hasNamedGroupingPolicy determines whether a named role inheritance rule exists.

Overrides:

hasNamedGroupingPolicy in class ManagementEnforcer

Parameters:

ptype - the policy type, can be "g", "g2", "g3", ..

params - the "g" policy rule.

Returns:

whether the rule exists.

hasNamedGroupingPolicy

public boolean hasNamedGroupingPolicy(java.lang.String ptype,
                                      java.lang.String... params)

hasNamedGroupingPolicy determines whether a named role inheritance rule exists.

Overrides:

hasNamedGroupingPolicy in class ManagementEnforcer

Parameters:

ptype - the policy type, can be "g", "g2", "g3", ..

params - the "g" policy rule.

Returns:

whether the rule exists.

addGroupingPolicy

public boolean addGroupingPolicy(java.util.List<java.lang.String> params)

addGroupingPolicy adds a role inheritance rule to the current policy. If the rule already exists, the function returns false and the rule will not be added. Otherwise the function returns true by adding the new rule.

Overrides:

addGroupingPolicy in class ManagementEnforcer

Parameters:

params - the "g" policy rule, ptype "g" is implicitly used.

Returns:

succeeds or not.

addGroupingPolicy

public boolean addGroupingPolicy(java.lang.String... params)

addGroupingPolicy adds a role inheritance rule to the current policy. If the rule already exists, the function returns false and the rule will not be added. Otherwise the function returns true by adding the new rule.

Overrides:

addGroupingPolicy in class ManagementEnforcer

Parameters:

params - the "g" policy rule, ptype "g" is implicitly used.

Returns:

succeeds or not.

addNamedGroupingPolicy

public boolean addNamedGroupingPolicy(java.lang.String ptype,
                                      java.util.List<java.lang.String> params)

addNamedGroupingPolicy adds a named role inheritance rule to the current policy. If the rule already exists, the function returns false and the rule will not be added. Otherwise the function returns true by adding the new rule.

Overrides:

addNamedGroupingPolicy in class ManagementEnforcer

Parameters:

ptype - the policy type, can be "g", "g2", "g3", ..

params - the "g" policy rule.

Returns:

succeeds or not.

addNamedGroupingPolicy

public boolean addNamedGroupingPolicy(java.lang.String ptype,
                                      java.lang.String... params)

addNamedGroupingPolicy adds a named role inheritance rule to the current policy. If the rule already exists, the function returns false and the rule will not be added. Otherwise the function returns true by adding the new rule.

Overrides:

addNamedGroupingPolicy in class ManagementEnforcer

Parameters:

ptype - the policy type, can be "g", "g2", "g3", ..

params - the "g" policy rule.

Returns:

succeeds or not.

removeGroupingPolicy

public boolean removeGroupingPolicy(java.util.List<java.lang.String> params)

removeGroupingPolicy removes a role inheritance rule from the current policy.

Overrides:

removeGroupingPolicy in class ManagementEnforcer

Parameters:

params - the "g" policy rule, ptype "g" is implicitly used.

Returns:

succeeds or not.

removeGroupingPolicy

public boolean removeGroupingPolicy(java.lang.String... params)

removeGroupingPolicy removes a role inheritance rule from the current policy.

Overrides:

removeGroupingPolicy in class ManagementEnforcer

Parameters:

params - the "g" policy rule, ptype "g" is implicitly used.

Returns:

succeeds or not.

removeFilteredGroupingPolicy

public boolean removeFilteredGroupingPolicy(int fieldIndex,
                                            java.lang.String... fieldValues)

removeFilteredGroupingPolicy removes a role inheritance rule from the current policy, field filters can be specified.

Overrides:

removeFilteredGroupingPolicy in class ManagementEnforcer

Parameters:

fieldIndex - the policy rule's start index to be matched.

fieldValues - the field values to be matched, value "" means not to match this field.

Returns:

succeeds or not.

removeNamedGroupingPolicy

public boolean removeNamedGroupingPolicy(java.lang.String ptype,
                                         java.util.List<java.lang.String> params)

removeNamedGroupingPolicy removes a role inheritance rule from the current named policy.

Overrides:

removeNamedGroupingPolicy in class ManagementEnforcer

Parameters:

ptype - the policy type, can be "g", "g2", "g3", ..

params - the "g" policy rule.

Returns:

succeeds or not.

removeNamedGroupingPolicy

public boolean removeNamedGroupingPolicy(java.lang.String ptype,
                                         java.lang.String... params)

removeNamedGroupingPolicy removes a role inheritance rule from the current named policy.

Overrides:

removeNamedGroupingPolicy in class ManagementEnforcer

Parameters:

ptype - the policy type, can be "g", "g2", "g3", ..

params - the "g" policy rule.

Returns:

succeeds or not.

removeFilteredNamedGroupingPolicy

public boolean removeFilteredNamedGroupingPolicy(java.lang.String ptype,
                                                 int fieldIndex,
                                                 java.lang.String... fieldValues)

removeFilteredNamedGroupingPolicy removes a role inheritance rule from the current named policy, field filters can be specified.

Overrides:

removeFilteredNamedGroupingPolicy in class ManagementEnforcer

Parameters:

ptype - the policy type, can be "g", "g2", "g3", ..

fieldIndex - the policy rule's start index to be matched.

fieldValues - the field values to be matched, value "" means not to match this field.

Returns:

succeeds or not.

getUsersForRole

public java.util.List<java.lang.String> getUsersForRole(java.lang.String name)

getUsersForRole gets the users that has a role.

Overrides:

getUsersForRole in class Enforcer

Parameters:

name - the role.

Returns:

the users that has the role.

hasRoleForUser

public boolean hasRoleForUser(java.lang.String name,
                              java.lang.String role)

hasRoleForUser determines whether a user has a role.

Overrides:

hasRoleForUser in class Enforcer

Parameters:

name - the user.

role - the role.

Returns:

whether the user has the role.

addRoleForUser

public boolean addRoleForUser(java.lang.String user,
                              java.lang.String role)

addRoleForUser adds a role for a user. Returns false if the user already has the role (aka not affected).

Overrides:

addRoleForUser in class Enforcer

Parameters:

user - the user.

role - the role.

Returns:

succeeds or not.

deleteRoleForUser

public boolean deleteRoleForUser(java.lang.String user,
                                 java.lang.String role)

deleteRoleForUser deletes a role for a user. Returns false if the user does not have the role (aka not affected).

Overrides:

deleteRoleForUser in class Enforcer

Parameters:

user - the user.

role - the role.

Returns:

succeeds or not.

deleteRolesForUser

public boolean deleteRolesForUser(java.lang.String user)

deleteRolesForUser deletes all roles for a user. Returns false if the user does not have any roles (aka not affected).

Overrides:

deleteRolesForUser in class Enforcer

Parameters:

user - the user.

Returns:

succeeds or not.

deleteUser

public boolean deleteUser(java.lang.String user)

deleteUser deletes a user. Returns false if the user does not exist (aka not affected).

Overrides:

deleteUser in class Enforcer

Parameters:

user - the user.

Returns:

succeeds or not.

deleteRole

public void deleteRole(java.lang.String role)

deleteRole deletes a role.

Overrides:

deleteRole in class Enforcer

Parameters:

role - the role.

deletePermission

public boolean deletePermission(java.lang.String... permission)

deletePermission deletes a permission. Returns false if the permission does not exist (aka not affected).

Overrides:

deletePermission in class Enforcer

Parameters:

permission - the permission, usually be (obj, act). It is actually the rule without the subject.

Returns:

succeeds or not.

deletePermission

public boolean deletePermission(java.util.List<java.lang.String> permission)

deletePermission deletes a permission. Returns false if the permission does not exist (aka not affected).

Overrides:

deletePermission in class Enforcer

Parameters:

permission - the permission, usually be (obj, act). It is actually the rule without the subject.

Returns:

succeeds or not.

addPermissionForUser

public boolean addPermissionForUser(java.lang.String user,
                                    java.lang.String... permission)

addPermissionForUser adds a permission for a user or role. Returns false if the user or role already has the permission (aka not affected).

Overrides:

addPermissionForUser in class Enforcer

Parameters:

user - the user.

permission - the permission, usually be (obj, act). It is actually the rule without the subject.

Returns:

succeeds or not.

addPermissionForUser

public boolean addPermissionForUser(java.lang.String user,
                                    java.util.List<java.lang.String> permission)

addPermissionForUser adds a permission for a user or role. Returns false if the user or role already has the permission (aka not affected).

Overrides:

addPermissionForUser in class Enforcer

Parameters:

user - the user.

permission - the permission, usually be (obj, act). It is actually the rule without the subject.

Returns:

succeeds or not.

deletePermissionForUser

public boolean deletePermissionForUser(java.lang.String user,
                                       java.lang.String... permission)

deletePermissionForUser deletes a permission for a user or role. Returns false if the user or role does not have the permission (aka not affected).

Overrides:

deletePermissionForUser in class Enforcer

Parameters:

user - the user.

permission - the permission, usually be (obj, act). It is actually the rule without the subject.

Returns:

succeeds or not.

deletePermissionForUser

public boolean deletePermissionForUser(java.lang.String user,
                                       java.util.List<java.lang.String> permission)

deletePermissionForUser deletes a permission for a user or role. Returns false if the user or role does not have the permission (aka not affected).

Overrides:

deletePermissionForUser in class Enforcer

Parameters:

user - the user.

permission - the permission, usually be (obj, act). It is actually the rule without the subject.

Returns:

succeeds or not.

deletePermissionsForUser

public boolean deletePermissionsForUser(java.lang.String user)

deletePermissionsForUser deletes permissions for a user or role. Returns false if the user or role does not have any permissions (aka not affected).

Overrides:

deletePermissionsForUser in class Enforcer

Parameters:

user - the user.

Returns:

succeeds or not.

getPermissionsForUser

public java.util.List<java.util.List<java.lang.String>> getPermissionsForUser(java.lang.String user)

getPermissionsForUser gets permissions for a user or role.

Overrides:

getPermissionsForUser in class Enforcer

Parameters:

user - the user.

Returns:

the permissions, a permission is usually like (obj, act). It is actually the rule without the subject.

hasPermissionForUser

public boolean hasPermissionForUser(java.lang.String user,
                                    java.lang.String... permission)

hasPermissionForUser determines whether a user has a permission.

Overrides:

hasPermissionForUser in class Enforcer

Parameters:

user - the user.

permission - the permission, usually be (obj, act). It is actually the rule without the subject.

Returns:

whether the user has the permission.

hasPermissionForUser

public boolean hasPermissionForUser(java.lang.String user,
                                    java.util.List<java.lang.String> permission)

hasPermissionForUser determines whether a user has a permission.

Overrides:

hasPermissionForUser in class Enforcer

Parameters:

user - the user.

permission - the permission, usually be (obj, act). It is actually the rule without the subject.

Returns:

whether the user has the permission.

getRolesForUserInDomain

public java.util.List<java.lang.String> getRolesForUserInDomain(java.lang.String name,
                                                                java.lang.String domain)

getRolesForUserInDomain gets the roles that a user has inside a domain.

Overrides:

getRolesForUserInDomain in class Enforcer

Parameters:

name - the user.

domain - the domain.

Returns:

the roles that the user has in the domain.

getPermissionsForUserInDomain

public java.util.List<java.util.List<java.lang.String>> getPermissionsForUserInDomain(java.lang.String user,
                                                                                      java.lang.String domain)

getPermissionsForUserInDomain gets permissions for a user or role inside a domain.

Overrides:

getPermissionsForUserInDomain in class Enforcer

Parameters:

user - the user.

domain - the domain.

Returns:

the permissions, a permission is usually like (obj, act). It is actually the rule without the subject.

addRoleForUserInDomain

public boolean addRoleForUserInDomain(java.lang.String user,
                                      java.lang.String role,
                                      java.lang.String domain)

addRoleForUserInDomain adds a role for a user inside a domain. Returns false if the user already has the role (aka not affected).

Overrides:

addRoleForUserInDomain in class Enforcer

Parameters:

user - the user.

role - the role.

domain - the domain.

Returns:

succeeds or not.

deleteRoleForUserInDomain

public boolean deleteRoleForUserInDomain(java.lang.String user,
                                         java.lang.String role,
                                         java.lang.String domain)

deleteRoleForUserInDomain deletes a role for a user inside a domain. Returns false if the user does not have the role (aka not affected).

Overrides:

deleteRoleForUserInDomain in class Enforcer

Parameters:

user - the user.

role - the role.

domain - the domain.

Returns:

succeeds or not.

getImplicitRolesForUser

public java.util.List<java.lang.String> getImplicitRolesForUser(java.lang.String name,
                                                                java.lang.String... domain)

getImplicitRolesForUser gets implicit roles that a user has. Compared to getRolesForUser(), this function retrieves indirect roles besides direct roles. For example: g, alice, role:admin g, role:admin, role:user

getRolesForUser("alice") can only get: ["role:admin"]. But getImplicitRolesForUser("alice") will get: ["role:admin", "role:user"].

Overrides:

getImplicitRolesForUser in class Enforcer

Parameters:

name - the user

domain - the domain

Returns:

implicit roles that a user has.

getImplicitPermissionsForUser

public java.util.List<java.util.List<java.lang.String>> getImplicitPermissionsForUser(java.lang.String user)

getImplicitPermissionsForUser gets implicit permissions for a user or role. Compared to getPermissionsForUser(), this function retrieves permissions for inherited roles. For example: p, admin, data1, read p, alice, data2, read g, alice, admin

getPermissionsForUser("alice") can only get: [["alice", "data2", "read"]]. But getImplicitPermissionsForUser("alice") will get: [["admin", "data1", "read"], ["alice", "data2", "read"]].

Overrides:

getImplicitPermissionsForUser in class Enforcer

Parameters:

user - the user.

Returns:

implicit permissions for a user or role.

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.