com.groupdocs.viewer

Class Metered

java.lang.Object

com.groupdocs.viewer.Metered

public class Metered
extends Object

Provides methods for applying metered license to the GroupDocs.Viewer component.

Metered licensing allows you to dynamically monitor and control the usage of GroupDocs.Viewer based on the number of document pages processed instead of a traditional per-server or per-developer license. This flexible licensing model is suitable for scenarios where the document processing requirements vary over time or when you want to pay only for what you use.

Example usage:

 Metered metered = new Metered();
 metered.setMeteredKey(publicKey, privateKey);
 // Perform document processing operations using GroupDocs.Viewer
 // ...
 

See Also:

Metered Licensing FAQ, GroupDocs Licensing FAQ, Evaluation Limitations and Licensing of GroupDocs.Viewer

Constructor Summary

Constructors

Constructor and Description
Metered()

Method Summary

Modifier and Type	Method and Description
static double	getConsumptionCredit() Retrieves the count of credits consumed.
static double	getConsumptionQuantity() Retrieves the amount of megabytes (MB) processed.
void	setMeteredKey(String publicKey, String privateKey) Activates the product with Metered keys.

Methods inherited from class java.lang.Object

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

Constructor Detail

Metered

public Metered()

Method Detail

getConsumptionCredit

public static double getConsumptionCredit()

Retrieves the count of credits consumed.

This method returns the total count of credits consumed by the component.

Example:

 String publicKey = "Public Key";
 String privateKey = "Private Key";
 Metered metered = new Metered();
 metered.setMeteredKey(publicKey, privateKey);
 double creditsConsumed = Metered.getConsumptionCredit();
 

Returns:

the count of credits consumed.

getConsumptionQuantity

public static double getConsumptionQuantity()
                                     throws Exception

Retrieves the amount of megabytes (MB) processed.

This method returns the total amount of MB processed by the component.

Example:

 String publicKey = "Public Key";
 String privateKey = "Private Key";
 Metered metered = new Metered();
 metered.setMeteredKey(publicKey, privateKey);
 double mbProcessed = Metered.getConsumptionQuantity();
 

Returns:

the amount of MB processed.

Throws:

Exception - If an error occurs while retrieving the consumption quantity.

setMeteredKey

public final void setMeteredKey(String publicKey,
                                String privateKey)

Activates the product with Metered keys.

Following example demonstrates how to activate product with Metered keys.

Example:

 String publicKey = "Public Key";
 String privateKey = "Private Key";
 Metered metered = new Metered();
 metered.setMeteredKey(publicKey, privateKey);
 

Parameters:

publicKey - The public key.

privateKey - The private key.