SandboxRules (venice 0.9.2 API)

java.lang.Object
- com.github.jlangch.venice.javainterop.SandboxRules

```
public class SandboxRules
extends java.lang.Object
```
Keeps the sandbox rules.
The sandbox keeps whitelist rules for the Java Interop and blacklist rules for the Venice functions.
Java whitelist rules for class/instance accessor follow the schema: '{package}.{className}:{methodName | fieldName}'. The asterix may be used as a wildcard
E.g: white listing Java Interop
- java.lang.Boolean (allow calling Java methods with arguments or return values of type Boolean)
- java.lang.* (allow calling Java methods with arguments or return values of any type in the package 'java.lang')
- java.lang.Long:new (allow calling Long constructor)
- java.lang.Math:abs (allow calling Math::abs method)
- java.lang.Math:* (allow calling all Math constructors/methods/fields)
- java.lang.*:* (allow calling all constructors/methods/fields for classes in the package 'java.lang')
E.g: white listing Java system properties
- system.property:file.separator
- system.property:java.home
E.g: black listing Venice I/O functions
- blacklist:venice:io/slurp (reject calls to 'io/slurp')
- blacklist:venice:*io* (reject all Venice I/O calls like 'io/slurp', 'create-file', ...)
- blacklist:venice:. (reject java interop)

Field Summary

Fields
Modifier and Type Field and Description

static java.util.Set<java.lang.String> DEFAULT_SYSTEM_PROPERTIES

Fields
Modifier and Type	Field and Description
`static java.util.Set<java.lang.String>`	`DEFAULT_SYSTEM_PROPERTIES`

Constructor Summary

Constructors
Constructor and Description

SandboxRules()

Constructors
Constructor and Description
`SandboxRules()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SandboxRules`	`add(java.util.Collection<java.lang.String> rules)` Add rules to the sandbox
`SandboxRules`	`add(java.lang.String... rules)` Add rules to the sandbox
`SandboxRules`	`addClasses(java.lang.Class<?>... classes)` Add classes to the sandbox.
`SandboxRules`	`addClasses(java.util.Collection<java.lang.Class<?>> classes)` Add classes to the sandbox.
`SandboxRules`	`allowAccessToAllSystemProperties()` Allow access to all Java system properties
`SandboxRules`	`allowAccessToStandardSystemProperties()` Allow access to all standard Java system properties
`java.util.Set<java.lang.String>`	`getRules()`
`SandboxRules`	`merge(SandboxRules other)` Merges this `SandboxRules` with the passed other `SandboxRules`
`SandboxRules`	`rejectAllVeniceIoFunctions()` Reject access to all Venice I/O related functions
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_SYSTEM_PROPERTIES
```
public static final java.util.Set<java.lang.String> DEFAULT_SYSTEM_PROPERTIES
```
- Constructor Detail
  - SandboxRules
```
public SandboxRules()
```
- Method Detail
  - add
```
public SandboxRules add(java.util.Collection<java.lang.String> rules)
```
    Add rules to the sandbox
    
    Parameters:
    
    rules - a collection of rules
    
    Returns:
    
    this SandboxRules
  - add
```
public SandboxRules add(java.lang.String... rules)
```
    Add rules to the sandbox
    
    Parameters:
    
    rules - rules
    
    Returns:
    
    this SandboxRules
  - addClasses
```
public SandboxRules addClasses(java.lang.Class<?>... classes)
```
    Add classes to the sandbox.
    Adds a rule "x.y.classname:*" for each class
    
    Parameters:
    
    classes - classes
    
    Returns:
    
    this SandboxRules
  - addClasses
```
public SandboxRules addClasses(java.util.Collection<java.lang.Class<?>> classes)
```
    Add classes to the sandbox.
    Adds a rule "x.y.classname:*" for each class
    
    Parameters:
    
    classes - classes
    
    Returns:
    
    this SandboxRules
  - rejectAllVeniceIoFunctions
```
public SandboxRules rejectAllVeniceIoFunctions()
```
    Reject access to all Venice I/O related functions
    
    Returns:
    
    this SandboxRules
  - allowAccessToStandardSystemProperties
```
public SandboxRules allowAccessToStandardSystemProperties()
```
    Allow access to all standard Java system properties
    Standard system properties:
    - file.separator
    - java.home
    - java.vendor
    - java.vendor.url
    - java.version
    - line.separator
    - os.arch
    - os.name
    - os.version
    - path.separator
    - user.dir
    - user.home
    - user.name
    Returns:
    
    this SandboxRules
  - allowAccessToAllSystemProperties
```
public SandboxRules allowAccessToAllSystemProperties()
```
    Allow access to all Java system properties
    
    Returns:
    
    this SandboxRules
  - merge
```
public SandboxRules merge(SandboxRules other)
```
    Merges this SandboxRules with the passed other SandboxRules
    
    Parameters:
    
    other - the other SandboxRules to merge with
    
    Returns:
    
    the new merged SandboxRules
  - getRules
```
public java.util.Set<java.lang.String> getRules()
```
    Returns:
    
    the rules of this SandboxRules
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class SandboxRules

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SYSTEM_PROPERTIES

Constructor Detail

SandboxRules

Method Detail

add

add

addClasses

addClasses

rejectAllVeniceIoFunctions

allowAccessToStandardSystemProperties

allowAccessToAllSystemProperties

merge

getRules

toString