Accounting Library

This component is responsible of collecting, harmonizing and storing Accounting data.

Overview

The following image evidences the accounting-lib component as part of Accounting Architecture:

Library

The library has been implemented to provide a common way to elaborate Usage Record (UR) (see Accounting Model to check which Usage Records are supported by default). In particular is responsible for:

• Collecting Accounting Data

It uses facilities provided by Document Store Lib for:

• Aggregating
• Buffering
• Storing
• Providing Fallback and Retry capability

Collecting Usage Record

The library allows to collect Usage Records providing the following functionality:

• Attribute Validation and Harmonization
• Usage Record Validation

To set the various properties of an usage records two different methods are available

• Developer Friendly methods (getter and setter)
• Generic Key-Value method (key:String, value:Comparable<? extends Serializable> )

The methods are idempotent. This means that any of the way you are using to set a properties the value is always validated and harmonized in the same way (i.e. from the the same code). You can mix different methods for different properties.

Moreover you can provide a Map<String,Comparable<? extends Serializable>> to set all properties at once.

Usage Record Validation and Harmonization

This library provides support to validate and harmonize the values to a common type (e.g. the string representation on an integer to a integer type, the string representation of an enum to the enum type). This functionality is very useful especially when the developer use a the key-value method.

For further details see Accounting Model.

Code Example

The following snippet of code provide an example of ServiceUsageRecord account which is automatically made from wHN and gHN. See Service Usage Record Model

// This code auto-discover the available persistence and retrieve the configuration from IS to correctly initialize it.
AccountingPersistence accountingPersistence = AccountingPersistenceFactory.getPersistence();
 
// Create a new Service Usage Record
ServiceUsageRecord usageRecord = new ServiceUsageRecord();
 
/* 
 * Commented to show the use of key-value setResourceProperty function 
 * instead of the convenient setter
 * usageRecord.setConsumerId("luca.frosini");
 * Please note that as KEY is used the provided static variable. Always behave like this.
 */
usageRecord.setResourceProperty(ServiceUsageRecord.CONSUMER_ID, "luca.frosini");
 
usageRecord.setOperationResult(OperationResult.SUCCESS);
usageRecord.setCallerHost("node13.d4science.org");
usageRecord.setHost("node22.d4science.org");
usageRecord.setServiceClass("VREManagement");
usageRecord.setServiceName("SmartExecutor");
usageRecord.setCalledMethod("launch");
 
 
// usageRecord.setDuration(300)
// Duration should be an integer. Anyway the string is converted from the validator.
usageRecord.setResourceProperty(ServiceUsageRecord.DURATION, "300");
 
accountingPersistence.account(usageRecord);

Please note that ServiceUsage record is accounted automatically from smartgears. In the case of REST services having the id of the managed resources in the path of the URL calledMethod is not aggregabile from Accounting Aggregator. Please refer to the section How to manage Not Aggregabile calledMethod to produce aggregabile calledMethod.

Development

The library is identified by the following maven coordinates:

<groupId>org.gcube.accounting</groupId>

<artifactId>accounting-lib</artifactId>

Every components has to account UsageRecords must depend from this library.

In some cases (e.g. Exception management) you may also depended from Document Store Lib. The maven coordinates of Document Store Lib are:

<groupId>org.gcube.data-publishing</groupId>

<artifactId>document-store-lib</artifactId>

Please set the scope of both library to PROVIDED if your component runs on a container gHN or vHN.