PolicyEngineAPI/src/main/java/org/onap/policy/api/MetricsResponse.java

   1 package org.onap.policy.api;
   2
   3 public interface MetricsResponse {
   4
   5         /**
   6          * Gets the <code>String</code> of the metrics message from <code>MetricsResponse</code>.
   7          *
   8          * @return the <code>String</code> which consists of the metrics message from <code>MetricsResponse</code>
   9          */
  10         public String getResponseMessage();
  11
  12         /**
  13          * Gets the response code of type <code>Integer</code> which corresponds to the HTTP Response code explaining the response from Policy Engine.
  14          *
  15          * @return the responseCode in <code>Integer</code> format corresponding to the HTTP response code from Policy Engine.
  16          */
  17         public int getResponseCode();
  18
  19
  20         /**
  21          * Gets the <code>Integer</code> value of the count of policies that reside on the PAP.
  22          *
  23          * @return the <code>Integer</code> which consists of count of policies that reside on the PAP.
  24          */
  25         public int getPapMetrics();
  26
  27
  28         /**
  29          * Gets the <code>Integer</code> value of the count of policies that reside on the PDP.
  30          *
  31          * @return the <code>Integer</code> which consists of count of policies that reside on the PDP.
  32          */
  33         public int getPdpMetrics();
  34
  35
  36         /**
  37          * Gets the <code>Integer</code> value of the total count of policies.
  38          *
  39          * @return the <code>Integer</code> which consists of the total count of policies.
  40          */
  41         public int getMetricsTotal();
  42
  43
  44
  45 }