org.elastos.hive

Class VaultSubscription

java.lang.Object

org.elastos.hive.connection.NodeRPCConnection

org.elastos.hive.ServiceEndpoint

org.elastos.hive.VaultSubscription

All Implemented Interfaces:

PaymentService, SubscriptionService<VaultInfo>

public class VaultSubscription
extends ServiceEndpoint
implements SubscriptionService<VaultInfo>, PaymentService

The vault subscription is used for the vault management.

Subscribe the vault is the first step to use the service in the vault.

Constructor Summary

Constructors

Constructor and Description
VaultSubscription(AppContext context, java.lang.String providerAddress) Create by the application context, and the address of the provider.

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<VaultInfo>	checkSubscription() Let the user to get the basic information of the subscription.
java.util.concurrent.CompletableFuture<Order>	getOrder(java.lang.String orderId) Obtain the order detail according to the given order id.
java.util.concurrent.CompletableFuture<java.util.List<Order>>	getOrderList() Obtain all the list of order detail.
java.util.concurrent.CompletableFuture<PricingPlan>	getPricingPlan(java.lang.String planName) Let users to get the specific pricing plan information.
java.util.concurrent.CompletableFuture<java.util.List<PricingPlan>>	getPricingPlanList() Let users to get the all the pricing plan list in order to subscribe to a new vault or backup service on the user's requirement.
java.util.concurrent.CompletableFuture<Receipt>	getReceipt(java.lang.String orderId) Obtain the receipt detail according to the order id.
java.util.concurrent.CompletableFuture<java.lang.String>	getVersion() Obtain the version of the payment module.
java.util.concurrent.CompletableFuture<Receipt>	payOrder(java.lang.String orderId, java.lang.String transactionId) Pay for the order with a given id.
java.util.concurrent.CompletableFuture<Order>	placeOrder(java.lang.String planName) Place an order for new subscription or extending the existing subscription service.
java.util.concurrent.CompletableFuture<VaultInfo>	subscribe() Let a new user subscribe to the entity service on the specified back-end node, where the entity service would be vault or backup service.
java.util.concurrent.CompletableFuture<java.lang.Void>	unsubscribe() Let user to unsubscribe to an existing but useless vault or backup service.

Methods inherited from class org.elastos.hive.ServiceEndpoint

getAccessToken, getAppContext, getAppDid, getAppInstanceDid, getLatestCommitId, getNodeVersion, getProviderAddress, getServiceDid, getServiceInstanceDid, getStorage, getUserDid, refreshAccessToken

Methods inherited from class org.elastos.hive.connection.NodeRPCConnection

createService, openConnection

Methods inherited from class java.lang.Object

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

Constructor Detail

VaultSubscription

public VaultSubscription(AppContext context,
                         java.lang.String providerAddress)
                  throws HiveException

Create by the application context, and the address of the provider.

Parameters:

context - The application context.

providerAddress - The address of the provider.

Throws:

HiveException - See HiveException

Method Detail

getPricingPlanList

public java.util.concurrent.CompletableFuture<java.util.List<PricingPlan>> getPricingPlanList()

Description copied from interface: SubscriptionService

Let users to get the all the pricing plan list in order to subscribe to a new vault or backup service on the user's requirement.

Specified by:

getPricingPlanList in interface SubscriptionService<VaultInfo>

Returns:

Return a list of all pricing plan with specific type on success. Otherwise, the specific exception would be returned.

getPricingPlan

public java.util.concurrent.CompletableFuture<PricingPlan> getPricingPlan(java.lang.String planName)

Description copied from interface: SubscriptionService

Let users to get the specific pricing plan information.

Specified by:

getPricingPlan in interface SubscriptionService<VaultInfo>

Parameters:

planName - the name of the pricing plan

Returns:

Return the specific pricing plan information on success. Otherwise, the specific exception would be returned.

subscribe

public java.util.concurrent.CompletableFuture<VaultInfo> subscribe()

Description copied from interface: SubscriptionService

Let a new user subscribe to the entity service on the specified back-end node, where the entity service would be vault or backup service. Currently this method would only support for subscription to a entity service with free pricing plan. When there is already a corresponding service existed, no new service would be subscribed or created.

Specified by:

subscribe in interface SubscriptionService<VaultInfo>

Returns:

The basic information of the newly created or existing vault on success, otherwise, the specific exception would returned in the wrapper.

unsubscribe

public java.util.concurrent.CompletableFuture<java.lang.Void> unsubscribe()

Description copied from interface: SubscriptionService

Let user to unsubscribe to an existing but useless vault or backup service.

Specified by:

unsubscribe in interface SubscriptionService<VaultInfo>

Returns:

None would be returned on success, otherwise, the specific exception would be returned.

checkSubscription

public java.util.concurrent.CompletableFuture<VaultInfo> checkSubscription()

Description copied from interface: SubscriptionService

Let the user to get the basic information of the subscription.

Specified by:

checkSubscription in interface SubscriptionService<VaultInfo>

Returns:

The basic information of the newly created or existing vault on success, otherwise, the specific exception would returned in the wrapper.

placeOrder

public java.util.concurrent.CompletableFuture<Order> placeOrder(java.lang.String planName)

Description copied from interface: PaymentService

Place an order for new subscription or extending the existing subscription service.

Specified by:

placeOrder in interface PaymentService

Parameters:

planName - the name of the pricing plan

Returns:

return the new order detail when the request successfully was received by back-end node, otherwise return the specific exception.

getOrder

public java.util.concurrent.CompletableFuture<Order> getOrder(java.lang.String orderId)

Description copied from interface: PaymentService

Obtain the order detail according to the given order id.

Specified by:

getOrder in interface PaymentService

Parameters:

orderId - order id

Returns:

return the order detail in case there is a order with order id existing. otherwise, return the specific exception.

payOrder

public java.util.concurrent.CompletableFuture<Receipt> payOrder(java.lang.String orderId,
                                                                java.lang.String transactionId)

Description copied from interface: PaymentService

Pay for the order with a given id.

Specified by:

payOrder in interface PaymentService

Parameters:

orderId - order id

transactionId - the transaction id on the block-chain.

Returns:

return the receipt detail in case the payment was accepted by hive node, otherwise return the specific exception.

getOrderList

public java.util.concurrent.CompletableFuture<java.util.List<Order>> getOrderList()

Description copied from interface: PaymentService

Obtain all the list of order detail.

Specified by:

getOrderList in interface PaymentService

Returns:

return the list of order detail on success, otherwise, return the specific exception.

getReceipt

public java.util.concurrent.CompletableFuture<Receipt> getReceipt(java.lang.String orderId)

Description copied from interface: PaymentService

Obtain the receipt detail according to the order id.

Specified by:

getReceipt in interface PaymentService

Parameters:

orderId - order id.

Returns:

return the receipt detail in case there is a receipt existing, otherwise, return the specific exception.

getVersion

public java.util.concurrent.CompletableFuture<java.lang.String> getVersion()

Description copied from interface: PaymentService

Obtain the version of the payment module.

Specified by:

getVersion in interface PaymentService

Returns:

return the version, otherwise, return the specific exception.