Package com.ibm.wsspi.usage.metering
Interface Usage
-
public interface Usage
Provides the product specific metrics and related data for one collection interval.See
ProductExtension.getCurrentUsage()
for information about determining the boundaries of a collection interval.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getEnvironmentType()
Returns the product specific environment type to be provided with the associated metrics.java.util.Collection<Metric>
getMetrics()
Provides the product specific metrics for one collection interval.java.util.Map<java.lang.String,java.lang.Object>
getProductSpecificData()
Returns the product specific data to be provided with the associated metrics.
-
-
-
Method Detail
-
getMetrics
java.util.Collection<Metric> getMetrics()
Provides the product specific metrics for one collection interval.- Returns:
- the collection of product specific metrics for the collection interval.
-
getEnvironmentType
java.lang.String getEnvironmentType()
Returns the product specific environment type to be provided with the associated metrics. Only used by products in which there is a different licensing cost depending on the environment the offering is configured. For example, the values of Prod, Stage, or Dev might be returned.The returned value is only used for reporting purposes when the associated product has been identified as the primary product; see
ProductExtension.getProductWeight()
.- Returns:
- the product specific environment type.
-
getProductSpecificData
java.util.Map<java.lang.String,java.lang.Object> getProductSpecificData()
Returns the product specific data to be provided with the associated metrics.The values included in the returned map must be one of the following four types: String, Number, Collection, Map; where Collection and Map must also contain one of the same four types.
The returned value is only used for reporting purposes when the associated product has been identified as the primary product; see
ProductExtension.getProductWeight()
.- Returns:
- the product specific data.
-
-