org.elastos.hive.service

Interface SubscriptionService<T>

All Known Implementing Classes:

BackupSubscription, VaultSubscription

public interface SubscriptionService<T>

Hive node provides the subscription service to let a new user subscribe to their vault or backup service on the given back-end node.

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<T>	checkSubscription() Let the user to get the basic information of the subscription.
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<T>	subscribe(java.lang.String credential) 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.

Method Detail

getPricingPlanList

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.

Returns:

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

getPricingPlan

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

Let users to get the specific pricing plan information.

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

java.util.concurrent.CompletableFuture<T> subscribe(java.lang.String credential)

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.

Parameters:

credential - The credential used to subscribe to a vault or backup service, currently this parameter would be reserved for future usage.

Returns:

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

unsubscribe

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

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

Returns:

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

checkSubscription

java.util.concurrent.CompletableFuture<T> checkSubscription()

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

Returns:

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