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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * PolicyEngineAPI
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.api;
  22
  23 public interface MetricsResponse {
  24
  25         /**
  26          * Gets the <code>String</code> of the metrics message from <code>MetricsResponse</code>.
  27          *
  28          * @return the <code>String</code> which consists of the metrics message from <code>MetricsResponse</code>
  29          */
  30         public String getResponseMessage();
  31
  32         /**
  33          * Gets the response code of type <code>Integer</code> which corresponds to the HTTP Response code explaining the response from Policy Engine.
  34          *
  35          * @return the responseCode in <code>Integer</code> format corresponding to the HTTP response code from Policy Engine.
  36          */
  37         public int getResponseCode();
  38
  39
  40         /**
  41          * Gets the <code>Integer</code> value of the count of policies that reside on the PAP.
  42          *
  43          * @return the <code>Integer</code> which consists of count of policies that reside on the PAP.
  44          */
  45         public int getPapMetrics();
  46
  47
  48         /**
  49          * Gets the <code>Integer</code> value of the count of policies that reside on the PDP.
  50          *
  51          * @return the <code>Integer</code> which consists of count of policies that reside on the PDP.
  52          */
  53         public int getPdpMetrics();
  54
  55
  56         /**
  57          * Gets the <code>Integer</code> value of the total count of policies.
  58          *
  59          * @return the <code>Integer</code> which consists of the total count of policies.
  60          */
  61         public int getMetricsTotal();
  62
  63
  64
  65 }