org.neo4j.server.rest.web

Enum ScriptExecutionMode

java.lang.Object

java.lang.Enum<ScriptExecutionMode>

org.neo4j.server.rest.web.ScriptExecutionMode

All Implemented Interfaces:

Serializable, Comparable<ScriptExecutionMode>

public enum ScriptExecutionMode
extends Enum<ScriptExecutionMode>

The mode of execution allowed for scripting inside the server.

Currently only traversal endpoints expose scripting, but this scripting feature for those endpoints can be disabled by specifying the DISABLED mode when constructing the DatabaseActions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED Scripting is not allowed, and any attempt at invoking a script will raise an exception.
SANDBOXED Allow scripts to run in a sandboxed environment.
UNRESTRICTED Allow scripts to run without any restrictions at all.

Method Summary

Modifier and Type	Method and Description
static ScriptExecutionMode	getConfiguredMode(org.neo4j.kernel.configuration.Config config) Get the execution mode that matches the given configuration.
static ScriptExecutionMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ScriptExecutionMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DISABLED

public static final ScriptExecutionMode DISABLED

Scripting is not allowed, and any attempt at invoking a script will raise an exception.

SANDBOXED

public static final ScriptExecutionMode SANDBOXED

Allow scripts to run in a sandboxed environment.

UNRESTRICTED

public static final ScriptExecutionMode UNRESTRICTED

Allow scripts to run without any restrictions at all. This should only be used in fully controlled environments, where it can be guaranteed that no malicious scripts will make their way into the server.

Method Detail

values

public static ScriptExecutionMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ScriptExecutionMode c : ScriptExecutionMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ScriptExecutionMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getConfiguredMode

public static ScriptExecutionMode getConfiguredMode(org.neo4j.kernel.configuration.Config config)

Get the execution mode that matches the given configuration.