Home Reference Source Test
public class | source

CoreDiscovery

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, graphConnector: graphConnector)

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

Member Summary

Public Members
public get

Returns the MessageBus.

public set

messageBus(messageBus: MessageBus): *

Sets the MessageBus.

Method Summary

Public Methods
public

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

public

discoverDataObjects(user: String, dataSchemes: Array<string>, resources: Array<string>, domain: String): *

Advanced Search for DataObjects registered in domain registry and associated with some user ID

public

discoverDataObjectsPerGUID(guid: String, dataSchemes: Array<string>, resources: Array<string>): *

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

public

discoverDataObjectsPerName(name: String, dataSchemes: Array<string>, resources: Array<string>, domain: String): *

Advanced Search for dataObjects registered in domain registry

public

discoverDataObjectsPerReporter(reporter: String, scdataSchemeshema: 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, dataSchemes: Array<string>, resources: Array<string>): *

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

public

function to request discovery service about the GUID associated with some user identifier (eg email, name ...)

public

discoverHyperties(user: String, dataSchemes: Array<string>, resources: Array<string>, domain: String): *

Advanced Search for Hyperties registered in domain registry and associated with some user ID

public

discoverHypertiesPerGUID(guid: String, dataSchemes: Array<string>, resources: Array<string>): *

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

public

discoverHypertiesPerUserProfileData(userIdentifier: String, dataSchemes: Array<string>, resources: Array<string>): *

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

public

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

public

function to request global registry about the user IDs associated with some GUID

public

discoveryManager(msg: *): *

Public Constructors

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

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

Params:

NameTypeAttributeDescription
msgbus MessageBus

msgbus

runtimeURL RuntimeURL

runtimeURL

graphConnector graphConnector

Public Members

public get messageBus: * source

Returns the MessageBus.

public set messageBus(messageBus: MessageBus): * source

Sets the MessageBus.

Public Methods

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

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

Params:

NameTypeAttributeDescription
url String

dataObject URL

domain String

(Optional)

Return:

Promise

Promise

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

Advanced Search for DataObjects registered in domain registry and associated with some user ID

Params:

NameTypeAttributeDescription
user String

user identifier, either in url or email format

dataSchemes 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(guid: String, dataSchemes: Array<string>, resources: Array<string>): * source

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

Params:

NameTypeAttributeDescription
guid String
dataSchemes Array<string>

(Optional) types of hyperties schemas

resources Array<string>

(Optional) types of hyperties resources

Return:

*

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

Advanced Search for dataObjects registered in domain registry

Params:

NameTypeAttributeDescription
name String

name of the dataObject

dataSchemes 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 discoverDataObjectsPerReporter(reporter: String, scdataSchemeshema: 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:

NameTypeAttributeDescription
reporter String

dataObject reporter

scdataSchemeshema Array<string>

(Optional) types of dataObjects schemas

resources Array<string>

(Optional) types of dataObjects resources

domain String

(Optional)

Return:

*

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

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

Params:

NameTypeAttributeDescription
userIdentifier String
dataSchemes Array<string>

(Optional) types of hyperties schemas

resources Array<string>

(Optional) types of hyperties resources

Return:

*

public discoverGUIDPerUserIdentifier(userIdentifier: String): Promise source

function to request discovery service about the GUID associated with some user identifier (eg email, name ...)

Params:

NameTypeAttributeDescription
userIdentifier String

Return:

Promise

Promise

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

Advanced Search for Hyperties registered in domain registry and associated with some user ID

Params:

NameTypeAttributeDescription
user String

user identifier, either in url or email format

dataSchemes 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(guid: String, dataSchemes: Array<string>, resources: Array<string>): * source

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

Params:

NameTypeAttributeDescription
guid String
dataSchemes Array<string>

(Optional) types of hyperties schemas

resources Array<string>

(Optional) types of hyperties resources

Return:

*

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

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

Params:

NameTypeAttributeDescription
userIdentifier String
dataSchemes Array<string>

(Optional) types of hyperties schemas

resources Array<string>

(Optional) types of hyperties resources

Return:

*

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

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

Params:

NameTypeAttributeDescription
url String

dataObject URL

domain String

(Optional)

Return:

Promise

Promise

public discoverUserIdsPerGUID(guid: String): Promise source

function to request global registry about the user IDs associated with some GUID

Params:

NameTypeAttributeDescription
guid String

Return:

Promise

Promise

public discoveryManager(msg: *): * source

Params:

NameTypeAttributeDescription
msg *

Return:

*