org.casbin.jcasbin.model

Class Model

java.lang.Object

org.casbin.jcasbin.model.Policy

org.casbin.jcasbin.model.Model

public class Model
extends Policy

Model represents the whole access control model.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Model.PolicyOperations

Field Summary

Fields

Modifier and Type	Field and Description
protected int	modCount
static java.lang.String[]	requiredSections
static java.util.Map<java.lang.String,java.lang.String>	sectionNameMap

Fields inherited from class org.casbin.jcasbin.model.Policy

model

Constructor Summary

Constructors

Constructor and Description
Model()

Method Summary

Modifier and Type	Method and Description
boolean	addDef(java.lang.String sec, java.lang.String key, java.lang.String value) addDef adds an assertion to the model.
int	getModCount()
java.lang.String	getNameWithDomain(java.lang.String domain, java.lang.String name)
java.util.Map<java.lang.String,java.lang.Integer>	getSubjectHierarchyMap(java.util.List<java.util.List<java.lang.String>> policies)
boolean	hasSection(java.lang.String sec) hasSection checks if the section exists in the model.
void	loadModel(java.lang.String path) loadModel loads the model from model CONF file.
void	loadModelFromConfig(Config cfg) loadModelFromConfig loads the model from the configuration.
void	loadModelFromText(java.lang.String text) loadModelFromText loads the model from the text.
static Model	newModel() NewModel creates an empty model.
static Model	newModelFromFile(java.lang.String path) NewModelFromString creates a model from a string which contains model text.
static Model	newModelFromString(java.lang.String text) NewModelFromString creates a model from a string which contains model text.
void	printModel() printModel prints the model to the log.
java.lang.String	saveModelToText() saveModelToText saves the model to the text.
void	setLogger(Logger logger) SetLogger sets the model's logger.
void	sortPoliciesByPriority() sort policies by priority value
void	sortPoliciesBySubjectHieraichy() sort policies by hieraichy map
java.lang.String	toText()

Methods inherited from class org.casbin.jcasbin.model.Policy

addPolicies, addPolicy, buildIncrementalRoleLinks, buildRoleLinks, clearPolicy, getFilteredPolicy, getPolicy, getValuesForFieldInPolicy, hasPolicies, hasPolicy, printPolicy, removeFilteredPolicy, removeFilteredPolicyReturnsEffects, removePolicies, removePolicy, savePolicyToText, updatePolicy

Methods inherited from class java.lang.Object

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

Field Detail

sectionNameMap

public static final java.util.Map<java.lang.String,java.lang.String> sectionNameMap

requiredSections

public static final java.lang.String[] requiredSections

modCount

protected int modCount

Constructor Detail

Model

public Model()

Method Detail

getModCount

public int getModCount()

addDef

public boolean addDef(java.lang.String sec,
                      java.lang.String key,
                      java.lang.String value)

addDef adds an assertion to the model.

Parameters:

sec - the section, "p" or "g".

key - the policy type, "p", "p2", .. or "g", "g2", ..

value - the policy rule, separated by ", ".

Returns:

succeeds or not.

setLogger

public void setLogger(Logger logger)

SetLogger sets the model's logger.

newModel

public static Model newModel()

NewModel creates an empty model.

newModelFromFile

public static Model newModelFromFile(java.lang.String path)

NewModelFromString creates a model from a string which contains model text.

Parameters:

path - the path of the model file.

newModelFromString

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

NewModelFromString creates a model from a string which contains model text.

Parameters:

text - the path of the file.

loadModel

public void loadModel(java.lang.String path)

loadModel loads the model from model CONF file.

Parameters:

path - the path of the model file.

loadModelFromText

public void loadModelFromText(java.lang.String text)

loadModelFromText loads the model from the text.

Parameters:

text - the model text.

loadModelFromConfig

public void loadModelFromConfig(Config cfg)

loadModelFromConfig loads the model from the configuration.

Parameters:

cfg - the model text.

hasSection

public boolean hasSection(java.lang.String sec)

hasSection checks if the section exists in the model.

saveModelToText

public java.lang.String saveModelToText()

saveModelToText saves the model to the text.

Returns:

the model text.

printModel

public void printModel()

printModel prints the model to the log.

sortPoliciesByPriority

public void sortPoliciesByPriority()

sort policies by priority value

sortPoliciesBySubjectHieraichy

public void sortPoliciesBySubjectHieraichy()

sort policies by hieraichy map

getSubjectHierarchyMap

public java.util.Map<java.lang.String,java.lang.Integer> getSubjectHierarchyMap(java.util.List<java.util.List<java.lang.String>> policies)

getNameWithDomain

public java.lang.String getNameWithDomain(java.lang.String domain,
                                          java.lang.String name)

toText

public java.lang.String toText()