import RuntimeUA from 'runtime-core/src/runtime/RuntimeUA.js'

public class | version 0.4.0 | source

RuntimeUA

Runtime User Agent Interface will process all the dependecies of the core runtime;

Constructor Summary

Public Constructor
public	constructor(runtimeDescriptor: descriptor, runtimeFactory: runtimeFactory, domainURL: domain) Create a new instance of Runtime User Agent

Member Summary

Public Members
public	addressAllocation: *
public	capabilities: *
public	coreDiscovery: *
public	descriptorInstance: *
public	domain: *
public	graphConnector: *
public	identityModule: *
public	loader: *
public	messageBus: *
public	p2p: boolean
public	persistenceManager: *
public	policyEngine: *
public	registry: *
public	runtimeCapabilities: *
public	runtimeCatalogue: *
public	runtimeConfiguration: *
public	runtimeFactory: *
public	runtimeURL: *
public	runtimeUtils: *
public	storageManager: *
public	syncherManager: *

Method Summary

Public Methods
public	close(): Promise<Boolean> Used to close all the runtime; Unregister all hyperties;
public	init(): Promise<Boolean, Error> Intialize the installation of runtime
public	loadHyperty(hypertyCatalogueURL: URL.HypertyCatalogueURL, reuseURL: boolean \| URL.HypertyURL, appURL: URL): Promise<Boolean, Error> Deploy Hyperty from Catalogue URL
public	loadIdpProxy(domain: URL.URL): * Deploy idpProxy from Catalogue URL or domain url
public	loadStub(domain: URL.URL): * Deploy Stub from Catalogue URL or domain url

Public Constructors

public constructor(runtimeDescriptor: descriptor, runtimeFactory: runtimeFactory, domainURL: domain) source

Create a new instance of Runtime User Agent

Params:

Name	Type	Attribute	Description
runtimeDescriptor	descriptor		pass all the hyperty runtime descriptor
runtimeFactory	runtimeFactory		Specific implementation for the environment where the core runtime will run;
domainURL	domain		specify the domain base for the runtime;

Public Members

public addressAllocation: * source

public capabilities: * source

public coreDiscovery: * source

public descriptorInstance: * source

public domain: * source

public graphConnector: * source

public identityModule: * source

public loader: * source

public messageBus: * source

public p2p: boolean source

public persistenceManager: * source

public policyEngine: * source

public registry: * source

public runtimeCapabilities: * source

public runtimeCatalogue: * source

public runtimeConfiguration: * source

public runtimeFactory: * source

public runtimeURL: * source

public runtimeUtils: * source

public storageManager: * source

public syncherManager: * source

Public Methods

public close(): Promise<Boolean> source

Used to close all the runtime; Unregister all hyperties;

Return:

Promise<Boolean>

result of the close method, with true or false to the operation success;

public init(): Promise<Boolean, Error> source

Intialize the installation of runtime

Return:

Promise<Boolean, Error>

this is Promise and if the installation process happened without any problems returns true otherwise the error.

public loadHyperty(hypertyCatalogueURL: URL.HypertyCatalogueURL, reuseURL: boolean | URL.HypertyURL, appURL: URL): Promise<Boolean, Error> source

Deploy Hyperty from Catalogue URL

Params:

Name	Type	Attribute	Description
hypertyCatalogueURL	URL.HypertyCatalogueURL		The Catalogue URL used to identify descriptors in the Catalogue.
reuseURL	boolean \| URL.HypertyURL	optional default: false	reuseURL - reuseURL is used to reuse the hypertyURL previously registred, by default the reuse is disabled;
appURL	URL		the app url address; // TODO: improve this description;

Return:

Promise<Boolean, Error>

this is Promise and returns true if all components are loaded with success or an error if someone fails.

See:

https://github.com/reTHINK-project/specs/tree/master/datamodel/core/address

public loadIdpProxy(domain: URL.URL): * source

Deploy idpProxy from Catalogue URL or domain url

Params:

Name	Type	Attribute	Description
domain	URL.URL		domain

Return:

public loadStub(domain: URL.URL): * source

Deploy Stub from Catalogue URL or domain url

Params:

Name	Type	Attribute	Description
domain	URL.URL		domain