org.elastos.hive

Class Client

java.lang.Object

org.elastos.hive.Client

public class Client
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
<T> java.util.concurrent.CompletableFuture<T>	callScriptUrl(java.lang.String scriptUrl, java.lang.Class<T> resultType) run script by hive url
static Client	createInstance(ApplicationContext context)
java.util.concurrent.CompletableFuture<Vault>	createVault(java.lang.String ownerDid, java.lang.String preferredProviderAddress) Create Vault for user with specified DID.
<T> java.util.concurrent.CompletableFuture<T>	downloadFileByScriptUrl(java.lang.String scriptUrl, java.lang.Class<T> resultType) Convenient method that first calls a script by url using callScriptURL(), and expects the JSON output to contain a file download information.
java.util.concurrent.CompletableFuture<Vault>	getVault(java.lang.String ownerDid, java.lang.String preferredProviderAddress) get Vault instance with specified DID.
java.util.concurrent.CompletableFuture<java.lang.String>	getVaultProvider(java.lang.String ownerDid, java.lang.String preferredProviderAddress) Try to acquire provider address for the specific user DID with rules with sequence orders: - Use 'preferredProviderAddress' first when it's being with real value; Otherwise - Resolve DID document according to the ownerDid from DID sidechain, and find if there are more than one "HiveVault" services, then would choose the first one service point as target provider address.
java.util.concurrent.CompletableFuture<HiveURLInfo>	parseHiveURL(java.lang.String scriptUrl) Parses a Hive standard url into a url info that can later be executed to get the result or the target url.
static void	setupResolver() Constructor without parameters resolver url and cache path use default value, resolver url default value: http://api.elastos.io:20606 cache path default value: new java.io.File("didCache")
static void	setupResolver(java.lang.String resolver) Recommendation for cache dir: - Laptop/standard Java System.getProperty("user.home") + "/.cache.did.elastos" - Android Java Context.getFilesDir() + "/.cache.did.elastos"

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setupResolver

public static void setupResolver()
                          throws HiveException

Constructor without parameters resolver url and cache path use default value, resolver url default value: http://api.elastos.io:20606 cache path default value: new java.io.File("didCache")

Throws:

HiveException

setupResolver

public static void setupResolver(java.lang.String resolver)
                          throws HiveException

Recommendation for cache dir: - Laptop/standard Java System.getProperty("user.home") + "/.cache.did.elastos" - Android Java Context.getFilesDir() + "/.cache.did.elastos"

Parameters:

resolver - the DIDResolver object

Throws:

HiveException

createInstance

public static Client createInstance(ApplicationContext context)
                             throws HiveException

Throws:

HiveException

getVault

public java.util.concurrent.CompletableFuture<Vault> getVault(java.lang.String ownerDid,
                                                              java.lang.String preferredProviderAddress)

get Vault instance with specified DID. Try to get a vault on target provider address with following steps: - Get the target provider address; - Create a new vaule of local instance..

Parameters:

ownerDid - the owner did related to target vault

preferredProviderAddress - the preferred target provider address

Returns:

a new vault instance.

createVault

public java.util.concurrent.CompletableFuture<Vault> createVault(java.lang.String ownerDid,
                                                                 java.lang.String preferredProviderAddress)

Create Vault for user with specified DID. Try to create a vault on target provider address with following steps: - Get the target provider address; - Check whether the vault is already existed on target provider, otherwise - Create a new vault on target provider with free pricing plan.

Parameters:

ownerDid - the owner did that want to create a vault

preferredProviderAddress - the preferred provider address to use

Returns:

a new created vault for owner did

getVaultProvider

public java.util.concurrent.CompletableFuture<java.lang.String> getVaultProvider(java.lang.String ownerDid,
                                                                                 java.lang.String preferredProviderAddress)

Try to acquire provider address for the specific user DID with rules with sequence orders: - Use 'preferredProviderAddress' first when it's being with real value; Otherwise - Resolve DID document according to the ownerDid from DID sidechain, and find if there are more than one "HiveVault" services, then would choose the first one service point as target provider address. Otherwise - It means no service endpoints declared on this DID Document, then would throw the corresponding exception.

Parameters:

ownerDid - the owner did that want be set provider address

preferredProviderAddress - the preferred provider address to use

Returns:

the provider address

callScriptUrl

public <T> java.util.concurrent.CompletableFuture<T> callScriptUrl(java.lang.String scriptUrl,
                                                                   java.lang.Class<T> resultType)

run script by hive url

Type Parameters:

T -

Parameters:

scriptUrl - hive://target_did@target_app_did/script_name?params={key=value}

resultType -

Returns:

downloadFileByScriptUrl

public <T> java.util.concurrent.CompletableFuture<T> downloadFileByScriptUrl(java.lang.String scriptUrl,
                                                                             java.lang.Class<T> resultType)

Convenient method that first calls a script by url using callScriptURL(), and expects the JSON output to contain a file download information. If this is the case, the file download is starting and a file reader is returned.

parseHiveURL

public java.util.concurrent.CompletableFuture<HiveURLInfo> parseHiveURL(java.lang.String scriptUrl)

Parses a Hive standard url into a url info that can later be executed to get the result or the target url. For example, later calling a url such as ... hive://userdid:appdid/getAvatar ... results in a call to the "getAvatar" script, previously registered by "userdid" on his vault, in the "appdid" scope. This is similar to calling: hiveClient.getVault(userdid).getScripting().call("getAvatar"); Usage example (assuming the url is a call to a getAvatar script that contains a FileDownload executable named "download"): - let hiveURLInfo = hiveclient.parseHiveURL(urlstring) - let scriptOutput = await hiveURLInfo.callScript(); - hiveURLInfo.getVault().getScripting().downloadFile(scriptOutput.items["download"].getTransferID())