ModuleRootResolver

abstract class ModuleRootResolver(val name: String, val uri: URI, val fileManager: FileManager)

ModuleRootResolver declares an interface for accessing Avail ModuleRoots given a URI. It is responsible for asynchronously retrieving, creating, deleting, and saving files and packages where the ModuleRoot is stored.

It is responsible for producing ResolverReferences, the object linking a resource in a module root to its actual file at the URI location of the module root.

All file actions are conducted via the ModuleRootResolver.fileManager. Given the files may originate anywhere from the local file system to a remote database accessed via network API, a REST-ful webserver, etc., all file requests must be handled asynchronously.

A ModuleRootResolver establishes access to a ModuleRoot based upon the URI.scheme given the appropriate ModuleRootResolver that supports the scheme. A ModuleRootResolver is created by a corresponding ModuleRootResolverFactory. For each ModuleRootResolver type implemented a ModuleRootResolverFactory must be implemented to enable resolver creation. The ModuleRootResolverFactory must be registered in the ModuleRootResolverRegistry. A ModuleRootResolver cannot be created if the factory has not been registered. Only one registered ModuleRootResolverFactory is allowed per URI scheme.

Author

Richard Arriaga

Inheritors

FileSystemModuleRootResolver

JarModuleRootResolver

Constructors

ModuleRootResolver

constructor(name: String, uri: URI, fileManager: FileManager)

Construct a new ModuleRootResolver for some root.

Types

WatchEventType

enum WatchEventType : Enum<ModuleRootResolver.WatchEventType>

A WatchEventType indicates the types of events that can occur to resources at the represented ModuleRoot source location.

Properties

allModules

val allModules: List<String>

The qualified names of all the modules known by this resolver.

canSave

abstract val canSave: Boolean

Answer whether data can be written to modules under this resolver. Note that this may be further restricted by choosing to use the root as a read-only source. See AvailWorkbench.getProjectRoot.

fileManager

val fileManager: FileManager

The FileManager used for pooling I/O requests for this root.

moduleRoot

val moduleRoot: ModuleRoot

The ModuleRoot this ModuleRootResolver resolves to.

name

val name: String

The name of this root.

uri

val uri: URI

The URI that identifies the location of the ModuleRoot.

watchEventSubscriptions

val watchEventSubscriptions: MutableMap<UUID, (ModuleRootResolver.WatchEventType, ResolverReference) -> Unit>

The Map from a UUID that represents an interested party to a lambda that accepts a WatchEventType that describes the event that occurred at the source location and a ResolverReference that identifies to what the event occurred to.

Functions

open fun close()

Close this ModuleRootResolver. Should be called at shutdown to ensure proper clean up of any open resources.

createDirectory

abstract fun createDirectory(qualifiedName: String, completion: () -> Unit, failureHandler: (ErrorCode, Throwable?) -> Unit)

Create a directory.

createFile

abstract fun createFile(qualifiedName: String, mimeType: String, completion: () -> Unit, failureHandler: (ErrorCode, Throwable?) -> Unit)

Create a file.

createPackage

abstract fun createPackage(qualifiedName: String, completion: () -> Unit, failureHandler: (ErrorCode, Throwable?) -> Unit)

Create a package and its representative Avail module.

deleteResource

abstract fun deleteResource(qualifiedName: String, completion: () -> Unit, failureHandler: (ErrorCode, Throwable?) -> Unit)

Delete the ResourceType linked to the qualified name. If the ResourceType is a ResourceType.PACKAGE or a ResourceType.DIRECTORY, all of its children should be deleted as well. All deleted references should be removed from the reference tree.

executeTask

open fun executeTask(task: () -> Unit)

Asynchronously execute the provided task.

fileWrapper

fun fileWrapper(id: UUID, reference: ResolverReference): AbstractFileWrapper

Answer a AbstractFileWrapper for the targeted file.

find

open fun find(qualifiedName: ModuleName, initialCanonicalName: ModuleName, moduleNameResolver: ModuleNameResolver): ModuleNameResolver.ModuleNameResolutionResult?

Answer a ModuleNameResolver.ModuleNameResolutionResult when attempting to locate a module in this ModuleRootResolver.

fullResourceURI

fun fullResourceURI(qualifiedName: String): URI

Answer the URI for a resource in the source moduleRoot given a qualified name. There is no guarantee the target exists.

getQualifiedName

fun getQualifiedName(targetURI: String): String

Answer a qualified name for the given URI that points to a file in the moduleRoot.

getResolverReference

open fun getResolverReference(qualifiedName: String): ResolverReference?

Answer the ResolverReference for the given qualified file name for a a file in moduleRoot.

provideModuleRootTree

open fun provideModuleRootTree(successHandler: (ResolverReference) -> Unit, failureHandler: (ErrorCode, Throwable?) -> Unit)

Provide the non-null ResolverReference that represents the moduleRoot. There is no guarantee made by this interface as to how this should be run. It can be all executed on the calling thread or it can be executed on a separate thread.

provideResolverReference

open fun provideResolverReference(qualifiedName: String, withReference: (ResolverReference) -> Unit, failureHandler: (ErrorCode, Throwable?) -> Unit)

Provide the ResolverReference for the given qualified file name for a file in moduleRoot.

readFile

abstract fun readFile(bypassFileManager: Boolean, reference: ResolverReference, withContents: (ByteArray, UUID?) -> Unit, failureHandler: (ErrorCode, Throwable?) -> Unit)

Retrieve the resource and provide it with a request to obtain the raw file bytes.

referencesMatchingAbbreviation

fun referencesMatchingAbbreviation(abbreviation: String, ignoreCase: Boolean = false): List<ResolverReference>

Answer all the ResolverReferences known by this ModuleRootResolver that have a qualified name that matches the supplied abbreviation.

refreshResolverMetaData

abstract fun refreshResolverMetaData(reference: ResolverReference, successHandler: (Long) -> Unit, failureHandler: (ErrorCode, Throwable?) -> Unit)

Specifically refresh the ResolverReference mutable state:

refreshResolverReferenceDigest

abstract fun refreshResolverReferenceDigest(reference: ResolverReference, successHandler: (ByteArray, Long) -> Unit, failureHandler: (ErrorCode, Throwable?) -> Unit)

Specifically refresh the ResolverReference.digest in the Repository.ModuleArchive for the most recent ResolverReference.lastModified timestamp. This also refreshes the metrics (mutable state) of the provided ResolverReference. It should refresh:

resolve

abstract fun resolve(successHandler: (ResolverReference) -> Unit, failureHandler: (ErrorCode, Throwable?) -> Unit)

Connect to the source of the moduleRoot and populate this resolver with all the ResolverReferences from the module root. This is not required nor expected to be executed in the calling thread.

resolvesToValidModuleRoot

abstract fun resolvesToValidModuleRoot(): Boolean

rootManifest

abstract fun rootManifest(forceRefresh: Boolean, withList: (List<ResolverReference>) -> Unit, failureHandler: (ErrorCode, Throwable?) -> Unit)

Provide the full list of all ResolverReferences in this ModuleRootResolver.

saveFile

abstract fun saveFile(reference: ResolverReference, fileContents: ByteArray, successHandler: () -> Unit, failureHandler: (ErrorCode, Throwable?) -> Unit)

Save the file to where it is stored.

subscribeRootWatcher

fun subscribeRootWatcher(watchAction: (ModuleRootResolver.WatchEventType, ResolverReference) -> Unit): UUID

Subscribe to receive notifications of WatchEventTypes occurring to this ModuleRoot.

unsubscribeRootWatcher

fun unsubscribeRootWatcher(id: UUID)

Remove a watch subscription.