Package org.opensearch.painless.spi

Class Whitelist

java.lang.Object

org.opensearch.painless.spi.Whitelist

public final class Whitelist
extends Object

Allowlist contains data structures designed to be used to generate an allowlist of Java classes, constructors, methods, and fields that can be used within a Painless script at both compile-time and run-time.

A Allowlist 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 allowlist object for more detail.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
Whitelist(ClassLoader classLoader, List<WhitelistClass> allowlistClasses, List<WhitelistMethod> allowlistImportedMethods, List<WhitelistClassBinding> allowlistClassBindings, List<WhitelistInstanceBinding> allowlistInstanceBindings)	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 List<Whitelist> BASE_WHITELISTS

classLoader

public final ClassLoader classLoader

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

whitelistClasses

public final List<WhitelistClass> whitelistClasses

The List of all the allowlisted Painless classes.

whitelistImportedMethods

public final List<WhitelistMethod> whitelistImportedMethods

The List of all the allowlisted static Painless methods.

whitelistClassBindings

public final List<WhitelistClassBinding> whitelistClassBindings

The List of all the allowlisted Painless class bindings.

whitelistInstanceBindings

public final List<WhitelistInstanceBinding> whitelistInstanceBindings

The List of all the allowlisted Painless instance bindings.

Constructor Details

Whitelist

public Whitelist(ClassLoader classLoader,
 List<WhitelistClass> allowlistClasses,
 List<WhitelistMethod> allowlistImportedMethods,
 List<WhitelistClassBinding> allowlistClassBindings,
 List<WhitelistInstanceBinding> allowlistInstanceBindings)

Standard constructor. All values must be not null.