Package io.deephaven.plugin.options

Class PluginOptions

java.lang.Object

io.deephaven.plugin.options.PluginOptions

@Immutable
public abstract class PluginOptions
extends Object

A set of options for a plugin derived from dagger injection.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PluginOptions.AuthorizationTransformer

Constructor Summary

Constructors

Constructor	Description
PluginOptions()

Method Summary

Modifier and Type	Method	Description
abstract PluginOptions.AuthorizationTransformer	authorizationTransformer()	Returns a function to be applied to objects returned to a user.
static io.deephaven.plugin.options.ImmutablePluginOptions.Builder	builder()
abstract ColumnExpressionValidator	columnExpressionValidator()
abstract Predicate<Object>	isAccessPermitted()	Returns true if the user should be permitted access to the given object.

Methods inherited from class java.lang.Object

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

Constructor Details

PluginOptions

public PluginOptions()

Method Details

columnExpressionValidator

public abstract ColumnExpressionValidator columnExpressionValidator()

Returns:

the ColumnExpressionValidator to use for user-provided formulas.

isAccessPermitted

public abstract Predicate<Object> isAccessPermitted()

Returns true if the user should be permitted access to the given object.

Callers should still apply authorizationTransformer() before exporting an object to a user.

authorizationTransformer

public abstract PluginOptions.AuthorizationTransformer authorizationTransformer()

Returns a function to be applied to objects returned to a user.

Plugins may provide objects to the user by invoking ObjectType.MessageStream.onData(java.nio.ByteBuffer, java.lang.Object...) with a number of arguments. These arguments are exported via an export ticket. A plugin may specify a ObjectType.AuthorizationExportBehavior. If ObjectType.AuthorizationExportBehavior.TRANSFORM is set then the server automatically transforms objects before sending them to a client. If the behavior is ObjectType.AuthorizationExportBehavior.MANUAL, then the plugin must apply the authorization transform first - before passing it to the onData callback. If the AuthorizationTransformer returns null, then the user is not permitted to access the object. If the behavior is ObjectType.AuthorizationExportBehavior.UNSET, the behavior is dependent on the server's default.

Returns:

a PluginOptions.AuthorizationTransformer that should be used to transform objects before providing them to a user.

builder

public static io.deephaven.plugin.options.ImmutablePluginOptions.Builder builder()