UsageData is defined as follows:

public class UsageData {    /* the usage type for this resource. Should match the type specified in the metadata      */    String getUsageType();    /* The tenant handle if any. Should match the handle for owning tenant associated        in the account lifecycle handler */    String getTenantHandle();    /* The user handle if any. Should match the handle for the owning user associated        in the user lifecycle handler */    String getUserHandle();    /* The resource handle, if any. Should match the handle for this tenant        associated in the subscription lifecycle handler */    String getResourceHandle();    /* Start date/time for this usage record */    Date getStartDate();    /* End Date/Time for this usage record */    Date getEndDate();    /* service specific reference id for this usage record. This should be the same        format used by the markers. */    String getReferenceId();    /* Discriminator values for *all* declared discriminators for this usage. This        includes resouce type ids, filter values and other discriminators declared for       this usage type in the metadata */    Map<String, String> getDisriminators ();    /* Raw usage. Actual usage consumed, in the unit of measure described in metadata */    Double getUsage();  }

The TenantBasedUsageCollector SPI defines the protocol which CPBM uses to collect usage from the underlying service on a periodic basis. To handle situations where usages needs to be reported differently for different days in a billing period, this class of collector requires implementingfollowing two methods:

• collect(...) - This method is called all the time for usage collection, except at the beginning of the billing period for the tenant given
• inventory(...) - This method is only called at the beginning of a billing period for the given tenant.

For discrete usage type, collect(...) should return only those usages which were created new since the last timecollect(...) was called. This is possible since the collector marker is stored and passed as an argument. It is defined as follows:

public interface TenantBasedUsageCollector {        public UsageResultSet collect(Tenant tenant, String startMarker, Date endDate);      public UsageResultSet inventory(Tenant tenant, String startMarker, Date billingPeriodStartDate);    }

The TenantBasedUsageCollector is called periodically to collect data from the underlying cloud service. CPBM will schedule a job to collect this data at an operator defined frequency. In any given run CPBM will repeatedly call the UsageCollector to collect usage, until it exhausts available data. The startMarker and endDate determines the range of usage data to collect. When collect is called, the returned usage data:

• should start from after the startMarker and it must be generated on or before the passed endDate. For better performance, we recommend all implementations of the UsageCollector return usage data in small batches. The batch size should typically be in hundreds. Any subsequent call to UsageCollector.collect() should return the next batch of usageData. In case there is no usageData left, return UsageResultSet with the input startMarker as the marker and null usageData list. CPBM will continuously call UsageCollector.collect() for a given endDate, until all data is exhausted for this time range.
• In case of conflicting usageData (i.e., duplicate referenceId) CPBM will resolve the conflict by using the first record received.
• The UsageResultSet object contains List of UsageData. This list should be sorted by UsageData.endDate from oldest to newest. Also, for any two calls to UsageCollector.collect, all of UsageData collected in the later call should be newer (have later UsageData.endDate, than the data collected in the earlier call).

This method is the same as UsageCollector.collect(String, Date) except that it takes an extra argument that of tenant. Connectors can now split collecting usage by tenant, to help improve performance and efficiency now and in the long run. CPBM will call this method all the time except at the beginning of the billing period for the tenant given, at which time the other method inventory(Tenant, String, billingPeriodStartDate) will be called.

com.citrix.cpbm.platform.model.UsageResultSet collect(com.vmops.model.Tenant tenant,                                                        java.lang.String startMarker,                                                        java.util.Date endDate)                                                        throws UsageCollectionException

• Parameters:
  • tenant - Tenant object for which usage needs to collected
  • startMarker - marker information specific to an implementor, which could be used to mark the boundary for usage collected so far and helps define starting point for usage to be collected. For example, time last collected.
  • endDate - time up to which billing needs to be collected. This will always be the previous evening 23:59:59

• Returns: UsageResultSet - Consist of lastMarker and UsageData list
• Throws: UsageCollectionException

This method is the same as collect(Tenant, String, Date) method, the only difference being this method is only called at the beginning of a billing period for the given tenant. On all other days, collect(Tenant, String, Date) is called for usage collection.

com.citrix.cpbm.platform.model.UsageResultSet inventory(com.vmops.model.Tenant tenant,                                                          java.lang.String startMarker,                                                          java.util.Date billingPeriodStartDate)                                                          throws UsageCollectionException  

• Parameters:
  • tenant - Tenant object for which usage needs to collected
  • startMarker - marker information specific to an implementor, which could be used to mark the boundary for usage collected so far and helps define starting point for usage to be collected. For example, time last collected.
  • billingPeriodStartDate - the start date of the current billing period for the tenant

• Returns: UsageResultSet - Consist of lastMarker and UsageData list
• Throws: UsageCollectionException