Package io.deephaven.server.object

Enum Class PluginReferenceAuthorizationPolicy

java.lang.Object

java.lang.Enum<PluginReferenceAuthorizationPolicy>

io.deephaven.server.object.PluginReferenceAuthorizationPolicy

All Implemented Interfaces:

Serializable, Comparable<PluginReferenceAuthorizationPolicy>, java.lang.constant.Constable

public enum PluginReferenceAuthorizationPolicy
extends Enum<PluginReferenceAuthorizationPolicy>

The server-wide policy that determines whether a plugin's exported references are run through the authorization transform when the plugin itself makes no declaration.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAIL_CLOSED	Plugins that do not declare an ObjectType.AuthorizationExportBehavior have their exported references transformed (and a warning is logged prompting the plugin to declare its behavior).
PERMISSIVE	Plugins that do not declare an ObjectType.AuthorizationExportBehavior are served without transforming their exported references.

Method Summary

Modifier and Type	Method	Description
static PluginReferenceAuthorizationPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PluginReferenceAuthorizationPolicy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PERMISSIVE

public static final PluginReferenceAuthorizationPolicy PERMISSIVE

Plugins that do not declare an ObjectType.AuthorizationExportBehavior are served without transforming their exported references. This preserves historical behavior.

FAIL_CLOSED

public static final PluginReferenceAuthorizationPolicy FAIL_CLOSED

Plugins that do not declare an ObjectType.AuthorizationExportBehavior have their exported references transformed (and a warning is logged prompting the plugin to declare its behavior). A plugin may still explicitly opt out by taking responsibility for authorization itself.

Method Details

values

public static PluginReferenceAuthorizationPolicy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PluginReferenceAuthorizationPolicy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null