Graal Sdk 24.1.2 · org.graalvm.polyglot.HostAccess · APIdia, the JavaDoc alternative

Represents the host access policy of a polyglot context. The host access policy specifies which methods and fields are accessible to the guest application, whenever Java host objects are accessed.

There are three predefined instances of host access policies:

EXPLICIT - Java host methods or fields, must be public and be annotated with @Export to make them accessible to the guest language.
SCOPED - Java host methods or fields, must be public and be annotated with @Export to make them accessible to the guest language. Guest-to-host callback parameter validity is scoped to the duration of the callback by default.
NONE - Does not allow any access to methods or fields of host objects. Java host objects may still be passed into a context, but they cannot be accessed.
ALL - Does allow full unrestricted access to public methods or fields of host objects. Note that this policy allows unrestricted access to reflection. It is highly discouraged from using this policy in environments where the guest application is not fully trusted.
CONSTRAINED host access policy suitable for a context with CONSTRAINED sandbox policy.
ISOLATED host access policy suitable for a context with ISOLATED sandbox policy.
UNTRUSTED host access policy suitable for a context with UNTRUSTED sandbox policy.

Custom host access policies can be created using newBuilder(). The builder allows to specify a custom export annotation and allowed and denied methods or fields.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public class	HostAccess.Builder Builder to create a custom `host access policy`.
public static @interface	HostAccess.DisableMethodScoping If `HostAccess#SCOPED` is used, placing this annotation on an exported host function excludes it from parameter scoping, i.e. parameters will not be released after invocation of a callback.
public static @interface	HostAccess.Export Annotation used by the predefined `EXPLICIT` access policy to mark public constructors, methods and fields in public classes that should be accessible by the guest application.
public static @interface	HostAccess.Implementable Allows guest language to implement a Java type.
public static enum	HostAccess.MutableTargetMapping List of default host object mappings of mutable target types available in `Value#as(Class)`.
public static enum	HostAccess.TargetMappingPrecedence Represents the precedence of a target type mapping.

Field Summary

Modifier and Type	Field and Description
private final EconomicSet<Class<? extends Annotation>>	accessAnnotations
public static final HostAccess	ALL Predefined host access policy that allows full unrestricted access to public methods or fields of public host classes.
pack-priv final boolean	allowAccessInheritance
pack-priv final boolean	allowAllClassImplementations
pack-priv final boolean	allowAllInterfaceImplementations
pack-priv final boolean	allowArrayAccess
pack-priv final boolean	allowBigIntegerNumberAccess
pack-priv final boolean	allowBufferAccess
pack-priv final boolean	allowIterableAccess
pack-priv final boolean	allowIteratorAccess
pack-priv final boolean	allowListAccess
pack-priv final boolean	allowMapAccess
private final HostAccess.MutableTargetMapping[]	allowMutableTargetMappings
pack-priv final boolean	allowPublic
public static final HostAccess	CONSTRAINED Predefined host access policy used by Context with a `SandboxPolicy#CONSTRAINED` sandbox policy when the host access policy is not explicitly specified by the embedder.
private final EconomicSet<Executable>	disableMethodScoping
private final EconomicSet<Class<? extends Annotation>>	disableMethodScopingAnnotations
private static final HostAccess	EMPTY
private final EconomicMap<Class<?>, Boolean>	excludeTypes
public static final HostAccess	EXPLICIT Predefined host access policy that allows access to public host methods or fields that were annotated with @Export and were declared in public class.
pack-priv volatile Object	impl
pack-priv final EconomicSet<Class<? extends Annotation>>	implementableAnnotations
private final EconomicSet<Class<?>>	implementableTypes
public static final HostAccess	ISOLATED Predefined host access policy used by Context with an `SandboxPolicy#ISOLATED` sandbox policy when the host access policy is not explicitly specified by the embedder.
private final EconomicSet<AnnotatedElement>	members
pack-priv final MethodHandles.Lookup	methodLookup
private final boolean	methodScopingDefault
private final String	name
public static final HostAccess	NONE Predefined host access policy that disallows any access to public host methods or fields.
public static final HostAccess	SCOPED Predefined host access policy that is the same as EXPLICIT and enables method scoping of callback parameter values on top.
private final List<Object>	targetMappings
public static final HostAccess	UNTRUSTED Predefined host access policy used by Context with an `SandboxPolicy#UNTRUSTED` sandbox policy when the host access policy is not explicitly specified by the embedder.

Constructor Summary

Access	Constructor and Description
pack-priv	HostAccess(EconomicSet<Class<? extends Annotation>> annotations, EconomicMap<Class<?>, Boolean> excludeTypes, EconomicSet<AnnotatedElement> members, EconomicSet<Class<? extends Annotation>> implementableAnnotations, EconomicSet<Class<?>> implementableTypes, List<Object> targetMappings, String name, boolean allowPublic, boolean allowAllImplementations, boolean allowAllClassImplementations, boolean allowArrayAccess, boolean allowListAccess, boolean allowBufferAccess, boolean allowIterableAccess, boolean allowIteratorAccess, boolean allowMapAccess, boolean allowBigIntegerNumberAccess, boolean allowAccessInheritance, HostAccess.MutableTargetMapping[] allowMutableTargetMappings, boolean methodScopingDefault, EconomicSet<Class<? extends Annotation>> disableMethodScopingAnnotations, EconomicSet<Executable> disableMethodScoping, MethodHandles.Lookup methodLookup)

Access

Constructor and Description

pack-priv

HostAccess(EconomicSet<Class<? extends Annotation>> annotations, EconomicMap<Class<?>, Boolean> excludeTypes, EconomicSet<AnnotatedElement> members, EconomicSet<Class<? extends Annotation>> implementableAnnotations, EconomicSet<Class<?>> implementableTypes, List<Object> targetMappings, String name, boolean allowPublic, boolean allowAllImplementations, boolean allowAllClassImplementations, boolean allowArrayAccess, boolean allowListAccess, boolean allowBufferAccess, boolean allowIterableAccess, boolean allowIteratorAccess, boolean allowMapAccess, boolean allowBigIntegerNumberAccess, boolean allowAccessInheritance, HostAccess.MutableTargetMapping[] allowMutableTargetMappings, boolean methodScopingDefault, EconomicSet<Class<? extends Annotation>> disableMethodScopingAnnotations, EconomicSet<Executable> disableMethodScoping, MethodHandles.Lookup methodLookup)

Method Summary

Modifier and Type	Method and Description
pack-priv boolean	allowsAccess(AnnotatedElement member)
pack-priv boolean	allowsImplementation(Class<?> type)
private static <K, T> EconomicMap<K, T>	copyMap(EconomicMap<K, T> values, Equivalence equivalence)
private static <T> EconomicSet<T>	copySet(EconomicSet<T> values, Equivalence equivalence)
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
private static <T, V> boolean	equalsMap(EconomicMap<T, V> map0, EconomicMap<T, V> map1)
private static <T> boolean	equalsSet(EconomicSet<T> set0, EconomicSet<T> set1)
private static Class<?>	getDeclaringClass(AnnotatedElement member)
pack-priv HostAccess.MutableTargetMapping[]	getMutableTargetMappings()
pack-priv List<Object>	getTargetMappings()
private static boolean	hasAnnotation(AnnotatedElement member, Class<? extends Annotation> annotationType)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
private static <T, V> int	hashMap(EconomicMap<T, V> map)
private static <V> int	hashSet(EconomicSet<V> set)
pack-priv boolean	isMethodScoped(Executable e)
pack-priv boolean	isMethodScopingEnabled()
public static HostAccess.Builder	newBuilder() Creates a new builder that allows to create a custom host access policy.
public static HostAccess.Builder	newBuilder(HostAccess conf) Creates a new builder that allows to create a custom host access policy based of a preset configuration.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

public final Class HostAccess

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary