org.elastos.hive.connection

Class NodeRPCConnection

java.lang.Object

org.elastos.hive.connection.NodeRPCConnection

Direct Known Subclasses:

ServiceEndpoint

public abstract class NodeRPCConnection
extends java.lang.Object

Network connection for accessing hive node with restful APIs.

The access token management is required for the sub-class implicitly.

For file uploading, direct connection need be created for uploading stream.

                HttpURLConnection urlConnection = connection.openConnection(FilesAPI.API_UPLOAD + path);
                OutputStream outputStream = new UploadOutputStream(urlConnection, urlConnection.getOutputStream());
 

For other APIs, please directly create the relating service.

                FilesAPI filesAPI = connection.createService(FilesAPI.class, true);
                String hashCode = filesAPI.getHash(path).execute().body().getHash();
 

Constructor Summary

Constructors

Constructor and Description
NodeRPCConnection()

Method Summary

Modifier and Type	Method and Description
<S> S	createService(java.lang.Class<S> serviceClass, boolean requiredAuthorization) Create a retrofit API service which can map Java call to Http request.
protected abstract AccessToken	getAccessToken()
protected abstract java.lang.String	getProviderAddress()
java.net.HttpURLConnection	openConnection(java.lang.String urlPath) Open a HTTP connection to communicate with hive node.

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeRPCConnection

public NodeRPCConnection()

Method Detail

getProviderAddress

protected abstract java.lang.String getProviderAddress()

getAccessToken

protected abstract AccessToken getAccessToken()

openConnection

public java.net.HttpURLConnection openConnection(java.lang.String urlPath)
                                          throws java.io.IOException

Open a HTTP connection to communicate with hive node.

Parameters:

urlPath - Relative URL path of the node API.

Returns:

The connection.

Throws:

java.io.IOException - exception such as timeout, network error, etc.

createService

public <S> S createService(java.lang.Class<S> serviceClass,
                           boolean requiredAuthorization)

Create a retrofit API service which can map Java call to Http request.

Type Parameters:

S - The service class.

Parameters:

serviceClass - The service class is the base class for the service.

requiredAuthorization - If this service need authorization. Normally if true, the service need token when send request.

Returns:

The service instance based on the service class.