Package org.opensearch.painless.spi

Class Whitelist

java.lang.Object

org.opensearch.painless.spi.Whitelist

public final class Whitelist
extends java.lang.Object

Whitelist contains data structures designed to be used to generate a whitelist of Java classes, constructors, methods, and fields that can be used within a Painless script at both compile-time and run-time. A whitelist consists of several pieces with WhitelistClasss as the top level. Each WhitelistClass will contain zero-to-many WhitelistConstructors, WhitelistMethods, and WhitelistFields which are what will be available with a Painless script. See each individual whitelist object for more detail.

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.List<Whitelist>	BASE_WHITELISTS
java.lang.ClassLoader	classLoader	The ClassLoader used to look up the whitelisted Java classes, constructors, methods, and fields.
java.util.List<WhitelistClassBinding>	whitelistClassBindings	The List of all the whitelisted Painless class bindings.
java.util.List<WhitelistClass>	whitelistClasses	The List of all the whitelisted Painless classes.
java.util.List<WhitelistMethod>	whitelistImportedMethods	The List of all the whitelisted static Painless methods.
java.util.List<WhitelistInstanceBinding>	whitelistInstanceBindings	The List of all the whitelisted Painless instance bindings.

Constructor Summary

Constructors

Constructor	Description
Whitelist(java.lang.ClassLoader classLoader, java.util.List<WhitelistClass> whitelistClasses, java.util.List<WhitelistMethod> whitelistImportedMethods, java.util.List<WhitelistClassBinding> whitelistClassBindings, java.util.List<WhitelistInstanceBinding> whitelistInstanceBindings)	Standard constructor.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

BASE_WHITELISTS

public static final java.util.List<Whitelist> BASE_WHITELISTS

classLoader

public final java.lang.ClassLoader classLoader

The ClassLoader used to look up the whitelisted Java classes, constructors, methods, and fields.

whitelistClasses

public final java.util.List<WhitelistClass> whitelistClasses

The List of all the whitelisted Painless classes.

whitelistImportedMethods

public final java.util.List<WhitelistMethod> whitelistImportedMethods

The List of all the whitelisted static Painless methods.

whitelistClassBindings

public final java.util.List<WhitelistClassBinding> whitelistClassBindings

The List of all the whitelisted Painless class bindings.

whitelistInstanceBindings

public final java.util.List<WhitelistInstanceBinding> whitelistInstanceBindings

The List of all the whitelisted Painless instance bindings.

Constructor Details

Whitelist

public Whitelist(java.lang.ClassLoader classLoader, java.util.List<WhitelistClass> whitelistClasses, java.util.List<WhitelistMethod> whitelistImportedMethods, java.util.List<WhitelistClassBinding> whitelistClassBindings, java.util.List<WhitelistInstanceBinding> whitelistInstanceBindings)

Standard constructor. All values must be not null.