Represents an access policy for polyglot builtins in the guest languages.

If the two predefined access policies NONE and ALL are not sufficient then a custom access configuration may be created using newBuilder(). This allows to grant individual access rights between the language.

The following access rights may be granted:

The ability to evaluate code between two or just for one language. If a language has access to at least one other language then the polyglot eval builtin will be available, otherwise access to that builtin might be restricted. The concrete name of the polyglot eval builtin is language specific. In JavaScript it is called Polyglot.eval.
The ability to access members in the polyglot bindings. The names of the guest language builtins to access polyglot bindings are language specific. In JavaScript they are called Polyglot.import and Polyglot.export.

Access to polyglot evaluation and bindings builtins are always enabled when access policy ALL is used. In this mode polyglot evaluation builtins are available even if there is just one installed language available.

Modifier and Type	Class and Description
public class	PolyglotAccess.Builder A builder for a polyglot access configuration.

Modifier and Type	Field and Description
public static final PolyglotAccess	ALL Provides guest languages full access to other languages using polyglot evaluation and binding builtins.
private final boolean	allAccess
private final EconomicSet<String>	bindingsAccess
private final EconomicMap<String, UnmodifiableEconomicSet<String>>	evalAccess
public static final PolyglotAccess	NONE Provides guest languages no access to other languages using polyglot builtins evaluation and binding builtins.

Access	Constructor and Description
pack-priv	PolyglotAccess(boolean allAccess, EconomicMap<String, EconomicSet<String>> access, EconomicSet<String> bindingsAccess)

Modifier and Type	Method and Description
private static EconomicMap<String, UnmodifiableEconomicSet<String>>	copyMap(EconomicMap<String, EconomicSet<String>> values)
pack-priv Set<String>	getBindingsAccess()
pack-priv Set<String>	getEvalAccess(String language)
pack-priv Map<String, Set<String>>	getEvalAccess()
public static PolyglotAccess.Builder	newBuilder() Creates a new custom polyglot access configuration builder.
pack-priv static String	toStringSet(UnmodifiableEconomicSet<String> set)
pack-priv String	validate(Set<String> availableLanguages)

ALL	back to summary
public static final PolyglotAccess ALL Provides guest languages full access to other languages using polyglot evaluation and binding builtins. Since 19.0

allAccess	back to summary
private final boolean allAccess

bindingsAccess	back to summary
private final EconomicSet<String> bindingsAccess

evalAccess	back to summary
private final EconomicMap<String, UnmodifiableEconomicSet<String>> evalAccess

NONE	back to summary
public static final PolyglotAccess NONE Provides guest languages no access to other languages using polyglot builtins evaluation and binding builtins. Since 19.0

PolyglotAccess	back to summary
pack-priv PolyglotAccess(boolean allAccess, EconomicMap<String, EconomicSet<String>> access, EconomicSet<String> bindingsAccess)

copyMap	back to summary
private static EconomicMap<String, UnmodifiableEconomicSet<String>> copyMap(EconomicMap<String, EconomicSet<String>> values)

getBindingsAccess	back to summary
pack-priv Set<String> getBindingsAccess()

getEvalAccess	back to summary
pack-priv Set<String> getEvalAccess(String language)

getEvalAccess	back to summary
pack-priv Map<String, Set<String>> getEvalAccess()

newBuilder	back to summary
public static PolyglotAccess.Builder newBuilder() Creates a new custom polyglot access configuration builder. A polyglot access builder starts with no access rights. Since 19.2

toStringSet	back to summary
pack-priv static String toStringSet(UnmodifiableEconomicSet<String> set)

validate	back to summary
pack-priv String validate(Set<String> availableLanguages)

org.graalvm.polyglot back to summary

public final Class PolyglotAccess.Builder

Class Inheritance

extends Object

java.lang.Object
org.graalvm.polyglot.PolyglotAccess.Builder

A builder for a polyglot access configuration. Builder instances are not thread-safe.

Since: 19.2

Field Summary

Modifier and Type	Field and Description
private EconomicSet<String>	bindingsAccess
private EconomicMap<String, EconomicSet<String>>	evalAccess

Constructor Summary

Access	Constructor and Description
pack-priv	Builder()

Method Summary

Modifier and Type	Method and Description
public PolyglotAccess.Builder	allowBindingsAccess(String language) Allows access to polyglot bindings for a language.
public PolyglotAccess.Builder	allowEval(String from, String to) Allows evaluation of code by one language of another.
public PolyglotAccess.Builder	allowEvalBetween(String... languages) Allows bidirectional evaluation of code between the given languages.
public PolyglotAccess	build() Creates an instance of the custom polyglot access configuration.
public PolyglotAccess.Builder	denyBindingsAccess(String language) Denies access to polyglot bindings for a language.
public PolyglotAccess.Builder	denyEval(String from, String to) Denies evaluation of code by one language of another.
public PolyglotAccess.Builder	denyEvalBetween(String... languages) Denies bidirectional evaluation of code between the given languages.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

bindingsAccess	back to summary
private EconomicSet<String> bindingsAccess

evalAccess	back to summary
private EconomicMap<String, EconomicSet<String>> evalAccess

Constructor Detail

Builder	back to summary
pack-priv Builder()

Method Detail

allowBindingsAccess back to summary

allowBindingsAccess	back to summary
public PolyglotAccess.Builder allowBindingsAccess(String language) Allows access to polyglot bindings for a language. The names of the guest language builtins to access polyglot bindings are language specific. In JavaScript they are called `Polyglot.import` and `Polyglot.export`. Since 19.2 See Also `denyBindingsAccess(String)`

public PolyglotAccess.Builder allowBindingsAccess(String language)

Allows access to polyglot bindings for a language. The names of the guest language builtins to access polyglot bindings are language specific. In JavaScript they are called Polyglot.import and Polyglot.export.

Since: 19.2
See Also: denyBindingsAccess(String)

allowEval back to summary

allowEval	back to summary
public PolyglotAccess.Builder allowEval(String from, String to) Allows evaluation of code by one language of another. This method only allows one-way evaluation access. Every language always has implicitly access to itself. If a language has access to one ore more different languages then the guest application will have access to polyglot evaluation builtins. If a language has no access granted to another language then access to polyglot evaluation builtins is denied. Since 19.2 See Also `allowEvalBetween(String...)`

public PolyglotAccess.Builder allowEval(String from, String to)

Allows evaluation of code by one language of another. This method only allows one-way evaluation access. Every language always has implicitly access to itself. If a language has access to one ore more different languages then the guest application will have access to polyglot evaluation builtins. If a language has no access granted to another language then access to polyglot evaluation builtins is denied.

Since: 19.2
See Also: allowEvalBetween(String...)

allowEvalBetween back to summary

allowEvalBetween	back to summary
public PolyglotAccess.Builder allowEvalBetween(String... languages) Allows bidirectional evaluation of code between the given languages. When called with language `"A"` and language `"B"`, this is equivalent to calling `allowEval("A", "B")` and `allowEval("B", "A")`. If called with more than two then all language evaluation combinations will be allowed. This method potentially overrides already configured access rights with `allowEval(String, String)` or `denyEval(String, String)`. The given language array must be `null` and individual languages must not be `null`. Since 19.2 See Also `allowEval(String, String)`

public PolyglotAccess.Builder allowEvalBetween(String... languages)

Allows bidirectional evaluation of code between the given languages. When called with language "A" and language "B", this is equivalent to calling allowEval("A", "B") and allowEval("B", "A"). If called with more than two then all language evaluation combinations will be allowed. This method potentially overrides already configured access rights with allowEval(String, String) or denyEval(String, String). The given language array must be null and individual languages must not be null.

Since: 19.2
See Also: allowEval(String, String)

build	back to summary
public PolyglotAccess build() Creates an instance of the custom polyglot access configuration. This method may be called multiple times to create more than one independent instances. Since 19.2

build

back to summary

public PolyglotAccess build()

Creates an instance of the custom polyglot access configuration. This method may be called multiple times to create more than one independent instances.

Since: 19.2

denyBindingsAccess back to summary

denyBindingsAccess	back to summary
public PolyglotAccess.Builder denyBindingsAccess(String language) Denies access to polyglot bindings for a language. The provided language must not be `null`. Since 19.2 See Also `allowBindingsAccess(String)`

public PolyglotAccess.Builder denyBindingsAccess(String language)

Denies access to polyglot bindings for a language. The provided language must not be null.

Since: 19.2
See Also: allowBindingsAccess(String)

denyEval back to summary

denyEval	back to summary
public PolyglotAccess.Builder denyEval(String from, String to) Denies evaluation of code by one language of another. This method only denies one-way evaluation. Every language has always evaluation access to itself. This access cannot be denied. Since 19.2 See Also `denyEvalBetween(String...)`

public PolyglotAccess.Builder denyEval(String from, String to)

Denies evaluation of code by one language of another. This method only denies one-way evaluation. Every language has always evaluation access to itself. This access cannot be denied.

Since: 19.2
See Also: denyEvalBetween(String...)

denyEvalBetween back to summary

denyEvalBetween	back to summary
public PolyglotAccess.Builder denyEvalBetween(String... languages) Denies bidirectional evaluation of code between the given languages. When called with language `"A"` and language `"B"`, this is equivalent to calling `denyEval("A", "B")` and `denyEval("B", "A")`. If called with more than two then all language access combinations will be denied. This method potentially overrides already configured access rights with `allowEval(String, String)` or `denyEval(String, String)`. The given language array must be `null` and individual languages must not be `null`. Since 19.2 See Also `denyEval(String, String)`

public PolyglotAccess.Builder denyEvalBetween(String... languages)

Denies bidirectional evaluation of code between the given languages. When called with language "A" and language "B", this is equivalent to calling denyEval("A", "B") and denyEval("B", "A"). If called with more than two then all language access combinations will be denied. This method potentially overrides already configured access rights with allowEval(String, String) or denyEval(String, String). The given language array must be null and individual languages must not be null.

Since: 19.2
See Also: denyEval(String, String)

public final Class PolyglotAccess

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class PolyglotAccess.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail