Modifier and Type	Class and Description
public static class	IOAccess.Builder Builder to create a custom `IO access configuration`.

Modifier and Type	Field and Description
public static final IOAccess	ALL Provides guest language full access to host IO.
private final boolean	allowHostFileAccess
private final boolean	allowHostSocketAccess
private final FileSystem	fileSystem
private final String	name
public static final IOAccess	NONE Provides guest language no access to IO.

Access	Constructor and Description
pack-priv	IOAccess(String name, boolean allowHostFileAccess, boolean allowHostSocketAccess, FileSystem fileSystem)

Modifier and Type	Method and Description
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.
pack-priv FileSystem	getFileSystem()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
pack-priv boolean	hasHostFileAccess()
pack-priv boolean	hasHostSocketAccess()
public static IOAccess.Builder	newBuilder() Creates a new builder that allows to create a custom IO access configuration.
public static IOAccess.Builder	newBuilder(IOAccess prototype) Creates a new builder that allows to create a custom IO access configuration based of a preset configuration.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Field Detail

ALL back to summary

ALL	back to summary
public static final IOAccess ALL Provides guest language full access to host IO. Guest language have full access to host file system and host sockets. The `ALL` is a default value for `Context`s created with `all access` set to `true`. If you are using this preset, the newly added privileges will default to `true` for this preset. Equivalent of using the following builder configuration: `IOAccess.newBuilder() .allowHostFileAccess(true) .allowHostSocketAccess(true) .build();` Since 23.0

public static final IOAccess ALL

Provides guest language full access to host IO. Guest language have full access to host file system and host sockets. The ALL is a default value for Contexts created with all access set to true. If you are using this preset, the newly added privileges will default to true for this preset.

Equivalent of using the following builder configuration:


IOAccess.newBuilder()
          .allowHostFileAccess(true)
          .allowHostSocketAccess(true)
          .build();

Since: 23.0

allowHostFileAccess	back to summary
private final boolean allowHostFileAccess

allowHostSocketAccess	back to summary
private final boolean allowHostSocketAccess

fileSystem	back to summary
private final FileSystem fileSystem

name	back to summary
private final String name

NONE back to summary

NONE	back to summary
public static final IOAccess NONE Provides guest language no access to IO. Guest language only has read-only access to the language's home files. The `NONE` is a default value for `Context`s created without `all access`. If you are using this preset, the newly added privileges will default to `false` for this preset. Equivalent of using the following builder configuration: `IOAccess.newBuilder().build();` Since 23.0

public static final IOAccess NONE

Provides guest language no access to IO. Guest language only has read-only access to the language's home files. The NONE is a default value for Contexts created without all access. If you are using this preset, the newly added privileges will default to false for this preset.

Equivalent of using the following builder configuration:


IOAccess.newBuilder().build();

Since: 23.0

Constructor Detail

IOAccess	back to summary
pack-priv IOAccess(String name, boolean allowHostFileAccess, boolean allowHostSocketAccess, FileSystem fileSystem)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override Since 23.0

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

Since

23.0

getFileSystem	back to summary
pack-priv FileSystem getFileSystem()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override Since 23.0

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

Since

23.0

hasHostFileAccess	back to summary
pack-priv boolean hasHostFileAccess()

hasHostSocketAccess	back to summary
pack-priv boolean hasHostSocketAccess()

newBuilder back to summary

newBuilder	back to summary
public static IOAccess.Builder newBuilder() Creates a new builder that allows to create a custom IO access configuration. The builder configuration needs to be completed using the `method`. Since 23.0

public static IOAccess.Builder newBuilder()

Creates a new builder that allows to create a custom IO access configuration. The builder configuration needs to be completed using the method.

Since: 23.0

newBuilder back to summary

newBuilder	back to summary
public static IOAccess.Builder newBuilder(IOAccess prototype) Creates a new builder that allows to create a custom IO access configuration based of a preset configuration. The preset configuration is copied and used as a template for the returned builder. The builder configuration needs to be completed using the `method`. Since 23.0

public static IOAccess.Builder newBuilder(IOAccess prototype)

Creates a new builder that allows to create a custom IO access configuration based of a preset configuration. The preset configuration is copied and used as a template for the returned builder. The builder configuration needs to be completed using the method.

Since: 23.0

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override Since 23.0

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

Since

23.0

org.graalvm.polyglot.io back to summary

public final Class IOAccess.Builder

Class Inheritance

extends Object

java.lang.Object
org.graalvm.polyglot.io.IOAccess.Builder

Builder to create a custom IO access configuration.

Since: 23.0

Field Summary

Modifier and Type	Field and Description
private boolean	allowHostFileAccess
private boolean	allowHostSocketAccess
private FileSystem	customFileSystem
private String	name

Constructor Summary

Access	Constructor and Description
pack-priv	Builder()
pack-priv	Builder(IOAccess prototype)

Method Summary

Modifier and Type	Method and Description
public IOAccess.Builder	allowHostFileAccess(boolean allow) If `true`, it allows the guest language unrestricted access to files on the host system.
public IOAccess.Builder	allowHostSocketAccess(boolean allow) If `true`, it allows the guest language unrestricted access to host system sockets.
public IOAccess	build() Creates an instance of the custom IO access configuration.
public IOAccess.Builder	Returns: the `Builder` fileSystem(FileSystem the file system to use in the guest language fileSystem) Sets a new `FileSystem`.
pack-priv IOAccess.Builder	name(String givenName)

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

Field Detail

allowHostFileAccess	back to summary
private boolean allowHostFileAccess

allowHostSocketAccess	back to summary
private boolean allowHostSocketAccess

customFileSystem	back to summary
private FileSystem customFileSystem

name	back to summary
private String name

Constructor Detail

Builder	back to summary
pack-priv Builder()

Builder	back to summary
pack-priv Builder(IOAccess prototype)

Method Detail

allowHostFileAccess back to summary

allowHostFileAccess	back to summary
public IOAccess.Builder allowHostFileAccess(boolean allow) If `true`, it allows the guest language unrestricted access to files on the host system. Since 23.0

public IOAccess.Builder allowHostFileAccess(boolean allow)

If true, it allows the guest language unrestricted access to files on the host system.

Since: 23.0

allowHostSocketAccess back to summary

allowHostSocketAccess	back to summary
public IOAccess.Builder allowHostSocketAccess(boolean allow) If `true`, it allows the guest language unrestricted access to host system sockets. Since 23.0

public IOAccess.Builder allowHostSocketAccess(boolean allow)

If true, it allows the guest language unrestricted access to host system sockets.

Since: 23.0

build	back to summary
public IOAccess build() Creates an instance of the custom IO access configuration. Exceptions IllegalArgumentException: if host file access is enabled and a custom file system is set. Since 23.0

build

back to summary

public IOAccess build()

Creates an instance of the custom IO access configuration.

Exceptions

IllegalArgumentException:: if host file access is enabled and a custom file system is set.

Since

23.0

fileSystem back to summary

fileSystem	back to summary
public IOAccess.Builder fileSystem(FileSystem fileSystem) Sets a new `FileSystem`. Access to the file system in the guest language will be virtualized using the `fileSystem`. A file system can restrict access to files or fully virtualize file system operations. An example of virtualization is a memory-based file system. Parameters fileSystem:FileSystem the file system to use in the guest language Returns:IOAccess.Builder the `Builder` Since 23.0

public IOAccess.Builder fileSystem(FileSystem fileSystem)

Sets a new FileSystem. Access to the file system in the guest language will be virtualized using the fileSystem. A file system can restrict access to files or fully virtualize file system operations. An example of virtualization is a memory-based file system.

Parameters

fileSystem:FileSystem: the file system to use in the guest language

Returns:IOAccess.Builder

the Builder

Since

23.0

name	back to summary
pack-priv IOAccess.Builder name(String givenName)

public final Class IOAccess

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class IOAccess.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail