Class JexlSandbox
A allowlist explicitly allows methods/properties for a class;
- If a allowlist is empty and thus does not contain any names, all properties/methods are allowed for its class.
- If it is not empty, the only allowed properties/methods are the ones contained.
A blocklist explicitly forbids methods/properties for a class;
- If a blocklist is empty and thus does not contain any names, all properties/methods are forbidden for its class.
- If it is not empty, the only forbidden properties/methods are the ones contained.
Permissions are composed of three lists, read, write, execute, each being "allow" or "block":
- read controls readable properties
- write controls writable properties
- execute controls executable methods and constructor
When specified, permissions - allow or block lists - can be created inheritable on interfaces or classes and thus applicable to their implementations or derived classes; the sandbox must be created with the 'inheritable' flag for this behavior to be triggered. Note that even in this configuration, it is still possible to add non-inheritable permissions. Adding inheritable lists to a non inheritable sandbox has no added effect; permissions only apply to their specified class.
Note that a JexlUberspect always uses a copy of the JexlSandbox used to built it preventing permission changes after its instantiation.
- Since:
- 3.0
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static classAn allow set of names.static final classDeprecated.(package private) static classA block set of names.static classA base set of names.static final classContains the allow or block lists for properties and methods for a given class.static final classDeprecated.since 3.2, useJexlSandbox.AllowSet -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final booleanDefault behavior, block or allow.private static final JexlSandbox.PermissionsThe pass-thru permissions.(package private) static final JexlSandbox.NamesThe pass-thru name set.private static final JexlSandbox.PermissionsThe block-all permissions.private static final JexlSandbox.NamesThe block-all name set.private final booleanWhether permissions can be inherited (through implementation or extension).static final StringThe marker string for explicitly disallowed null properties.private final Map<String,JexlSandbox.Permissions> The map from class names to permissions. -
Constructor Summary
ConstructorsModifierConstructorDescriptionCreates a new default sandbox.JexlSandbox(boolean ab) Creates a new default sandbox.JexlSandbox(boolean ab, boolean inh) Creates a sandbox.privateJexlSandbox(boolean ab, boolean inh, Map<String, JexlSandbox.Permissions> map) Creates a sandbox based on an existing permissions map. -
Method Summary
Modifier and TypeMethodDescriptionCreates a new set of permissions based on allow lists for methods and properties for a given class.Deprecated.3.3Creates a new set of permissions based on block lists for methods and properties for a given class.private JexlSandbox.PermissionsComputes and optionally stores the permissions associated to a class.copy()Gets a copy of this sandboxGets the execute permission value for a given method of a class.Deprecated.3.3(package private) static Class<?>Gets a class by name, crude mechanism for backwards (<3.2 ) compatibility.Gets the permissions associated to a class.Gets the set of permissions associated to a class.private static JexlSandbox.Permissionspermissions(String clazz, boolean readFlag, boolean writeFlag, boolean executeFlag) Creates the set of permissions for a given class.permissions(String clazz, boolean inhf, boolean readf, boolean writef, boolean execf) Creates the set of permissions for a given class.Gets the read permission value for a given property of a class.Deprecated.3.3Deprecated.3.3Gets the write permission value for a given property of a class.Deprecated.3.3
-
Field Details
-
NULL
The marker string for explicitly disallowed null properties.- See Also:
-
ALLOW_NAMES
The pass-thru name set. -
BLOCK_NAMES
The block-all name set. -
BLOCK_ALL
The block-all permissions. -
ALLOW_ALL
The pass-thru permissions. -
sandbox
The map from class names to permissions. -
inherit
private final boolean inheritWhether permissions can be inherited (through implementation or extension). -
allow
private final boolean allowDefault behavior, block or allow.
-
-
Constructor Details
-
JexlSandbox
public JexlSandbox()Creates a new default sandbox.In the absence of explicit permissions on a class, the sandbox is an allow-box, allow-listing that class for all permissions (read, write and execute).
-
JexlSandbox
public JexlSandbox(boolean ab) Creates a new default sandbox.A allow-box considers no permissions as "everything is allowed" when a block-box considers no permissions as "nothing is allowed".
- Parameters:
ab- whether this sandbox is allow (true) or block (false) if no permission is explicitly defined for a class.- Since:
- 3.1
-
JexlSandbox
public JexlSandbox(boolean ab, boolean inh) Creates a sandbox.- Parameters:
ab- whether this sandbox is allow (true) or block (false)inh- whether permissions on interfaces and classes are inherited (true) or not (false)- Since:
- 3.2
-
JexlSandbox
Creates a sandbox based on an existing permissions map.- Parameters:
ab- whether this sandbox is allow (true) or block (false)inh- whether permissions are inherited, default falsemap- The permissions map- Since:
- 3.2
-
-
Method Details
-
forName
Gets a class by name, crude mechanism for backwards (<3.2 ) compatibility.- Parameters:
cname- The class name- Returns:
- The class
-
allow
Creates a new set of permissions based on allow lists for methods and properties for a given class.The sandbox inheritance property will apply to the permissions created by this method
- Parameters:
clazz- The allowed class name- Returns:
- The permissions instance
-
block
Creates a new set of permissions based on block lists for methods and properties for a given class.The sandbox inheritance property will apply to the permissions created by this method
- Parameters:
clazz- The blocked class name- Returns:
- The permissions instance
-
copy
Gets a copy of this sandbox- Returns:
- A copy of this sandbox
-
execute
Gets the execute permission value for a given method of a class.- Parameters:
clazz- The classname- The method name- Returns:
- null if not allowed, the name of the method to use otherwise
-
execute
Deprecated.3.3Gets the execute permission value for a given method of a class.- Parameters:
clazz- The class namename- The method name- Returns:
- null if not allowed, the name of the method to use otherwise
-
get
Gets the set of permissions associated to a class.- Parameters:
clazz- The class name- Returns:
- The defined permissions or an all-allow permission instance if none were defined
-
get
Gets the permissions associated to a class.- Parameters:
clazz- The class- Returns:
- The permissions
-
inheritable
-
compute
Computes and optionally stores the permissions associated to a class.- Parameters:
clazz- The classstore- whether the computed permissions should be stored in the sandbox- Returns:
- The permissions
-
permissions
public JexlSandbox.Permissions permissions(String clazz, boolean readFlag, boolean writeFlag, boolean executeFlag) Creates the set of permissions for a given class.The sandbox inheritance property will apply to the permissions created by this method
- Parameters:
clazz- The class for which these permissions applyreadFlag- whether the readable property list is allow - true - or block - false -writeFlag- whether the writable property list is allow - true - or block - false -executeFlag- whether the executable method list is allow - true - or block - false -- Returns:
- The set of permissions
-
permissions
public JexlSandbox.Permissions permissions(String clazz, boolean inhf, boolean readf, boolean writef, boolean execf) Creates the set of permissions for a given class.- Parameters:
clazz- The class for which these permissions applyinhf- whether these permissions are inheritablereadf- whether the readable property list is allow - true - or block - false -writef- whether the writable property list is allow - true - or block - false -execf- whether the executable method list is allow - true - or block - false -- Returns:
- The set of permissions
-
read
Gets the read permission value for a given property of a class.- Parameters:
clazz- The classname- The property name- Returns:
- null (or NULL if name is null) if not allowed, the name of the property to use otherwise
-
write
Gets the write permission value for a given property of a class.- Parameters:
clazz- The classname- The property name- Returns:
- null (or NULL if name is null) if not allowed, the name of the property to use otherwise
-
write
Deprecated.3.3Gets the write permission value for a given property of a class.- Parameters:
clazz- The class namename- The property name- Returns:
- null if not allowed, the name of the property to use otherwise
-
black
Deprecated.3.3Use block() instead.- Parameters:
clazz- The blocked class name- Returns:
- The permissions instance
-
read
Deprecated.3.3Gets the read permission value for a given property of a class.- Parameters:
clazz- The class namename- The property name- Returns:
- null if not allowed, the name of the property to use otherwise
-
white
Deprecated.3.3Use allow() instead.- Parameters:
clazz- The allowed class name- Returns:
- The permissions instance
-
JexlSandbox.BlockSet