org.casbin.jcasbin.main

Class ManagementEnforcer

java.lang.Object

org.casbin.jcasbin.main.CoreEnforcer

org.casbin.jcasbin.main.ManagementEnforcer

Direct Known Subclasses:

Enforcer

public class ManagementEnforcer
extends CoreEnforcer

ManagementEnforcer = InternalEnforcer + Management API.

Constructor Summary

Constructors

Constructor and Description
ManagementEnforcer()

Method Summary

Modifier and Type	Method and Description
void	addFunction(java.lang.String name, com.googlecode.aviator.runtime.type.AviatorFunction function) addFunction adds a customized function.
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	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.
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>	getAllNamedSubjects(java.lang.String ptype) GetAllNamedSubjects gets the list of subjects that show up in the currentnamed 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>>	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>>	getPolicy() getPolicy gets all the authorization rules in the policy.
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	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	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.

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

buildRoleLinks, clearPolicy, enableAutoBuildRoleLinks, enableAutoSave, enableEnforce, enableLog, enforce, getAdapter, getModel, isFiltered, loadFilteredPolicy, loadModel, loadPolicy, newModel, newModel, newModel, savePolicy, setAdapter, setEffector, setModel, setRoleManager, setWatcher

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagementEnforcer

public ManagementEnforcer()

Method Detail

getAllSubjects

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

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

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.

getAllNamedSubjects

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

GetAllNamedSubjects gets the list of subjects that show up in the currentnamed policy.

Parameters:

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

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.

getAllObjects

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

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Returns:

all the "g" policy rules.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

addFunction

public void addFunction(java.lang.String name,
                        com.googlecode.aviator.runtime.type.AviatorFunction function)

addFunction adds a customized function.

Parameters:

name - the name of the new function.

function - the function.