Interface MeteringContext

  • All Superinterfaces:
    java.util.Map<java.lang.String,​java.lang.Object>

    public interface MeteringContext
    extends java.util.Map<java.lang.String,​java.lang.Object>
    Exposes context information used by the usage metering feature when performing product registration and usage reporting to the metering service, which may be useful to ProductExtension implementations.
    • Nested Class Summary

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String CONFIGURED_OPTIONAL_METRICS
      The usage metering optionalMetrics configuration value for the application server.
      static java.lang.String HOST_NAME
      The host name identified from java.net.InetAddress.
      static java.lang.String INSTANCE_IDENTIFIER
      The server instance identifier reported to the metering service.
      static java.lang.String REPORTED_HOST_NAME
      The host name reported to the metering service.
    • Method Summary

      • Methods inherited from interface java.util.Map

        clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
    • Field Detail

      • HOST_NAME

        static final java.lang.String HOST_NAME
        The host name identified from java.net.InetAddress.
        See Also:
        Constant Field Values
      • REPORTED_HOST_NAME

        static final java.lang.String REPORTED_HOST_NAME
        The host name reported to the metering service. The actual host name may have been overridden in the server configuration with CONTAINER_HOST, or by the usage metering feature when running in a container environment (such as Docker or Cloud Foundry). Overriding the host name is done to improve the usability of the metering service dashboard.
        See Also:
        Constant Field Values
      • INSTANCE_IDENTIFIER

        static final java.lang.String INSTANCE_IDENTIFIER
        The server instance identifier reported to the metering service. For WebSphere, the instance identifier generally is composed of two parts:
        1. The server name obtained from the server configuration or the container identifier when running in a container environment (such as Docker or Cloud Foundry).
        2. The user install directory.
        Note: Using the container identifier instead of server name is done to improve the usability of the metering service dashboard.
        See Also:
        Constant Field Values
      • CONFIGURED_OPTIONAL_METRICS

        static final java.lang.String CONFIGURED_OPTIONAL_METRICS
        The usage metering optionalMetrics configuration value for the application server. optionalMetrics is a String of metrics, comma separated, that have been configured to be collected and sent during usage reporting. There are two special values, ALL and NONE, where ALL means report all usage and NONE is to report only required metrics.
        See Also:
        Constant Field Values