import Discovery from 'service-framework/src/discovery/Discovery.js'

public class | source

Discovery

Core Discovery interface Class to allow applications to search for hyperties and DataObjects using the message bus

Constructor Summary

Public Constructor
public	constructor(msgbus: MessageBus, runtimeURL: RuntimeURL) To initialise the HypertyDiscover, which will provide the support for hyperties to query users registered in outside the internal core.

Method Summary

Public Methods
public	discoverDataObject(name: String, schema: Array<string>, resources: Array<string>, domain: String): * this method was deprecated. Deprecated. Use discoverDataObjectsPerName instead Advanced Search for dataObjects registered in domain registry
public	discoverDataObjectPerURL(url: String, domain: String): * function to request about dataObject registered in domain registry, and return the dataObject information, if found.
public	discoverDataObjects(user: String, schema: Array<string>, resources: Array<string>, domain: String): * Advanced Search for DataObjects registered in domain registry
public	discoverDataObjectsPerGUID(guidURL: String, schema: Array<string>, resources: Array<string>, domain: String): * Advanced Search for DataObjects registered in domain registry associated with some GUID
public	discoverDataObjectsPerName(name: String, schema: Array<string>, resources: Array<string>, domain: String): * function to request about an dataObjects registered in domain registry with a given name, and return the dataObjects information, if found.
public	discoverDataObjectsPerReporter(reporter: String, schema: Array<string>, resources: Array<string>, domain: String): * function to request about specific reporter dataObject registered in domain registry, and return the dataObjects from that reporter.
public	discoverDataObjectsPerUserProfileData(userIdentifier: String, schema: Array<string>, resources: Array<string>): * Advanced Search for DataObjects registered in domain registry associated with some user identifier (eg email, name ...)
public	discoverHyperties(user: String, schema: Array<string>, resources: Array<string>, domain: String): * Advanced Search for Hyperties registered in domain registry
public	discoverHypertiesPerGUID(guidURL: String, schema: Array<string>, resources: Array<string>): * Advanced Search for Hyperties registered in domain registry associated with some GUID
public	discoverHypertiesPerUser(email: email, domain: domain): * this method was deprecated. Deprecated. Use discoverHyperty instead function to request about users registered in domain registry, and return the all the hyperties registered by the user
public	discoverHypertiesPerUserProfileData(userIdentifier: String, schema: Array<string>, resources: Array<string>): * Advanced Search for Hyperties registered in domain registry associated with some user identifier (eg email, name ...)
public	discoverHyperty(user: String, schema: Array<string>, resources: Array<string>, domain: String): * this method was deprecated. Deprecated. Use discoverHyperties instead Advanced Search for Hyperties registered in domain registry
public	discoverHypertyPerURL(url: String, domain: String): * function to request about hyperties registered in domain registry, and return the hyperty information, if found.
public	discoverHypertyPerUser(email: email, domain: domain): * this method was deprecated. Deprecated. Use discoverHyperty instead function to request about users registered in domain registry, and return the last hyperty instance registered by the user.

Public Constructors

public constructor(msgbus: MessageBus, runtimeURL: RuntimeURL) source

To initialise the HypertyDiscover, which will provide the support for hyperties to query users registered in outside the internal core.

Params:

Name	Type	Attribute	Description
msgbus	MessageBus		msgbus
runtimeURL	RuntimeURL		runtimeURL

Public Methods

public discoverDataObject(name: String, schema: Array<string>, resources: Array<string>, domain: String): * source

this method was deprecated. Deprecated. Use discoverDataObjectsPerName instead

Advanced Search for dataObjects registered in domain registry

Params:

Name	Type	Attribute	Description
name	String		name of the dataObject
schema	Array<string>		(Optional) types of dataObject schemas
resources	Array<string>		(Optional) types of dataObject resources
domain	String		(Optional) domain of the registry to search

Return:

public discoverDataObjectPerURL(url: String, domain: String): * source

function to request about dataObject registered in domain registry, and return the dataObject information, if found.

Params:

Name	Type	Attribute	Description
url	String		dataObject URL
domain	String		(Optional)

Return:

public discoverDataObjects(user: String, schema: Array<string>, resources: Array<string>, domain: String): * source

Advanced Search for DataObjects registered in domain registry

Params:

Name	Type	Attribute	Description
user	String		user identifier, either in url or email format
schema	Array<string>		(Optional) types of dataObjects schemas
resources	Array<string>		(Optional) types of dataObjects resources
domain	String		(Optional) domain of the registry to search

Return:

public discoverDataObjectsPerGUID(guidURL: String, schema: Array<string>, resources: Array<string>, domain: String): * source

Advanced Search for DataObjects registered in domain registry associated with some GUID

Params:

Name	Type	Attribute	Description
guidURL	String		guid URL e.g user-guid://<unique-user-identifier>
schema	Array<string>		(Optional) types of hyperties schemas
resources	Array<string>		(Optional) types of hyperties resources
domain	String		(Optional) domain of the registry to search

Return:

public discoverDataObjectsPerName(name: String, schema: Array<string>, resources: Array<string>, domain: String): * source

function to request about an dataObjects registered in domain registry with a given name, and return the dataObjects information, if found.

Params:

Name	Type	Attribute	Description
name	String		dataObject URL
schema	Array<string>		(Optional) types of dataObjects schemas
resources	Array<string>		(Optional) types of dataObjects resources
domain	String		(Optional)

Return:

public discoverDataObjectsPerReporter(reporter: String, schema: Array<string>, resources: Array<string>, domain: String): * source

function to request about specific reporter dataObject registered in domain registry, and return the dataObjects from that reporter.

Params:

Name	Type	Attribute	Description
reporter	String		dataObject reporter
schema	Array<string>		(Optional) types of dataObjects schemas
resources	Array<string>		(Optional) types of dataObjects resources
domain	String		(Optional)

Return:

public discoverDataObjectsPerUserProfileData(userIdentifier: String, schema: Array<string>, resources: Array<string>): * source

Advanced Search for DataObjects registered in domain registry associated with some user identifier (eg email, name ...)

Params:

Name	Type	Attribute	Description
userIdentifier	String
schema	Array<string>		(Optional) types of hyperties schemas
resources	Array<string>		(Optional) types of hyperties resources

Return:

public discoverHyperties(user: String, schema: Array<string>, resources: Array<string>, domain: String): * source

Advanced Search for Hyperties registered in domain registry

Params:

Name	Type	Attribute	Description
user	String		user identifier, either in url or email format
schema	Array<string>		(Optional) types of hyperties schemas
resources	Array<string>		(Optional) types of hyperties resources
domain	String		(Optional) domain of the registry to search

Return:

public discoverHypertiesPerGUID(guidURL: String, schema: Array<string>, resources: Array<string>): * source

Advanced Search for Hyperties registered in domain registry associated with some GUID

Params:

Name	Type	Attribute	Description
guidURL	String		guid URL e.g user-guid://<unique-user-identifier>
schema	Array<string>		(Optional) types of hyperties schemas
resources	Array<string>		(Optional) types of hyperties resources

Return:

public discoverHypertiesPerUser(email: email, domain: domain): * source

this method was deprecated. Deprecated. Use discoverHyperty instead

function to request about users registered in domain registry, and return the all the hyperties registered by the user

Params:

Name	Type	Attribute	Description
email	email
domain	domain		(Optional)

Return:

public discoverHypertiesPerUserProfileData(userIdentifier: String, schema: Array<string>, resources: Array<string>): * source

Advanced Search for Hyperties registered in domain registry associated with some user identifier (eg email, name ...)

Params:

Name	Type	Attribute	Description
userIdentifier	String
schema	Array<string>		(Optional) types of hyperties schemas
resources	Array<string>		(Optional) types of hyperties resources

Return:

public discoverHyperty(user: String, schema: Array<string>, resources: Array<string>, domain: String): * source

this method was deprecated. Deprecated. Use discoverHyperties instead

Advanced Search for Hyperties registered in domain registry

Params:

Name	Type	Attribute	Description
user	String		user identifier, either in url or email format
schema	Array<string>		(Optional) types of hyperties schemas
resources	Array<string>		(Optional) types of hyperties resources
domain	String		(Optional) domain of the registry to search

Return:

public discoverHypertyPerURL(url: String, domain: String): * source

function to request about hyperties registered in domain registry, and return the hyperty information, if found.

Params:

Name	Type	Attribute	Description
url	String		hyperty URL
domain	String		(Optional)

Return:

public discoverHypertyPerUser(email: email, domain: domain): * source

this method was deprecated. Deprecated. Use discoverHyperty instead

function to request about users registered in domain registry, and return the last hyperty instance registered by the user.

Params:

Name	Type	Attribute	Description
email	email
domain	domain		(Optional)