1.0.0-beta1

graalvm/elide.runtime.gvm.internals.vfs/AbstractBaseVFS

AbstractBaseVFS

abstract class AbstractBaseVFS<VFS : AbstractBaseVFS<VFS>> : GuestVFS

VFS: Guest Base

This base class describes the expected API for guest VFS implementations, including their builders (VFSBuilder) and factories (VFSFactory). Defaults are provided for the root system path and current-working-directory, both of which default to /.

Guest VFS implementations have their own subclass API, with which the abstract FS implementation can query for policy status, file membership, and so on. See the methods enforce and checkPolicy for more information.

Parameters

VFS

Concrete virtual file system type under implementation.

config

Effective guest VFS configuration to apply.

See also

for the public API of guest VFS implementations.

AbstractDelegateVFS

for a concrete implementation of a guest VFS backed by a real file system.

Inheritors

AbstractDelegateVFS

Types

interface VFSBuilder<VFS : AbstractBaseVFS<VFS>>

Models the interface expected for VFS implementation builders, which should accept a uniform set of baseline settings (such as readOnly status, or the root path). Specialized FS implementations may extend this interface with additional settings.

VFSBuilderFactory

interface VFSBuilderFactory<VFS : AbstractBaseVFS<VFS>, Builder : AbstractBaseVFS.VFSBuilder<VFS>>

Specifies the expected API surface of a VFS builder's static interface. This interface is used to construct new builders, regardless of implementation (see newBuilder).

interface VFSFactory<VFS : AbstractBaseVFS<VFS>, Builder : AbstractBaseVFS.VFSBuilder<VFS>>

Specifies the expected API surface of a VFS implementation's companion object, which should be equipped to create and resolve VFS implementations using the VFSBuilder and VFSBuilderFactory.

Properties

abstract val compound: Boolean

abstract val deletable: Boolean

abstract val host: Boolean

abstract val logging: Logger

Subclass API: Logging.

supportsSymlinks

abstract val supportsSymlinks: Boolean

abstract val virtual: Boolean

abstract val writable: Boolean

Functions

allowsHostFileAccess

abstract fun allowsHostFileAccess(): Boolean

allowsHostSocketAccess

abstract fun allowsHostSocketAccess(): Boolean

abstract fun checkAccess(path: Path, modes: MutableSet<out AccessMode>, vararg linkOptions: LinkOption)

abstract fun checkPolicy(request: AccessRequest): AccessResponse

fun checkPolicy(type: AccessType, domain: AccessDomain, path: Path, scope: AccessScope = AccessScope.UNSPECIFIED): AccessResponse

Subclass API: Policy check.

abstract override fun close()

open fun copy(source: Path, target: Path, vararg options: CopyOption)

createDirectory

abstract fun createDirectory(dir: Path, vararg attrs: FileAttribute<*>)

open fun createLink(link: Path, existing: Path)

createSymbolicLink

open fun createSymbolicLink(link: Path, target: Path, vararg attrs: FileAttribute<*>)

abstract fun delete(path: Path)

open fun existsAny(path: Path): Boolean

open fun getEncoding(path: Path): Charset

open fun getMimeType(path: Path): String

abstract fun getPath(vararg segments: String): Path

Subclass API: Parse a path.

getPathSeparator

open fun getPathSeparator(): String

open fun getSeparator(): String

getTempDirectory

open fun getTempDirectory(): Path

open fun isSameFile(path1: Path, path2: Path, vararg options: LinkOption): Boolean

open fun move(source: Path, target: Path, vararg options: CopyOption)

abstract fun newByteChannel(path: Path, options: MutableSet<out OpenOption>, vararg attrs: FileAttribute<*>): SeekableByteChannel

newDirectoryStream

abstract fun newDirectoryStream(dir: Path, filter: DirectoryStream.Filter<in Path>): DirectoryStream<Path>

abstract fun parsePath(uri: URI): Path

abstract fun parsePath(path: String): Path

abstract fun readAttributes(path: Path, attributes: String, vararg options: LinkOption): MutableMap<String, Any>

abstract fun readStream(path: Path, vararg options: OpenOption): InputStream

Subclass API: Read a file.

readSymbolicLink

open fun readSymbolicLink(link: Path): Path

open fun setAttribute(path: Path, attribute: String, value: Any, vararg options: LinkOption)

setCurrentWorkingDirectory

open fun setCurrentWorkingDirectory(currentWorkingDirectory: Path)

abstract fun toAbsolutePath(path: Path): Path

abstract fun toRealPath(path: Path, vararg linkOptions: LinkOption): Path

abstract fun writeStream(path: Path, vararg options: OpenOption): OutputStream

Subclass API: Write a file.