Elastos Hive Java SDK

Summary

Elastos Hive is an essential service infrastructure as a decentralized network of Hive nodes presenting data storage capabilities to dApps. And the Java SDK provides a group of APIs for Elastos dApps to easily access and store application data to remote Vault services on Hive nodes with the following features:

• Upload/download files;
• Structured data object access and store onto MongoDB;
• Key/Values (Not supported yet);
• Customized Scripting to select other users to read or contribute the data.

Elastos Hive will keep the promise that users remain in full control of their own data and committing the practice on it.

Build from source

Preparing with the developer tool git, and then run the following commands to clone the source:

$ git clone https://github.com/elastos/Elastos.NET.Hive.Java.SDK
$ cd Elastos.NET.Hive.Java.SDK
$ open -a Eclipse .

Then open the Eclipse to build the project and run the test cases. As an alternative to Eclipse, you can also use the following commands.

With the simple command below, build the whole project and run the test cases:

$ ./gradlew build 

With the option -x , try to build the project without running the test cases.

$ ./gradlew build -x test

Or just directly run the test cases:

$ ./gradlew test

Build API Docs

Run the command below to build the APIs document, the output of documents would be generated at doc subdirectory.

$ ./gradlew createjavadoc
$ ls -a doc
.	allclasses-noframe.html	help-doc.html org	overview-tree.html	serialized-form.html
..	constant-values.html	index-all.html overview-frame.html	package-list		stylesheet.css
allclasses-frame.html	deprecated-list.html index.html overview-summary.html	script.js

Then open index.html with the browser; you can see the whole APIs document there.

How To Use SDK

Here are examples to integrate this SDK into the projects with Gradle or Maven build system.

1. Gradle

Just add the following snippet scripts into the dependencies items build.gradle:

implementation 'org.elastos:hive:v2.0.0'

2. Maven

Add the following snippet of dependency declaration in their pom scripts:

<dependency>
	<groupId>org.elastos</groupId>
	<artifactId>hive</artifactId>
	<version>v2.0.0</version>
	<type>pom</type>
</dependency>

Here also is a brief guide document about How-to use the APIs. Please read it carefully and feedback as issues.

Thanks

Sincerely thanks to all teams and projects that we rely on directly or indirectly.

Contributing

We welcome contributions to the Elastos Hive Java Project.

License

MIT