2 * ============LICENSE_START=======================================================
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
21 package org.onap.policy.api;
23 public interface MetricsResponse {
26 * Gets the <code>String</code> of the metrics message from <code>MetricsResponse</code>.
28 * @return the <code>String</code> which consists of the metrics message from <code>MetricsResponse</code>
30 public String getResponseMessage();
33 * Gets the response code of type <code>Integer</code> which corresponds to the HTTP Response code explaining the response from Policy Engine.
35 * @return the responseCode in <code>Integer</code> format corresponding to the HTTP response code from Policy Engine.
37 public int getResponseCode();
41 * Gets the <code>Integer</code> value of the count of policies that reside on the PAP.
43 * @return the <code>Integer</code> which consists of count of policies that reside on the PAP.
45 public int getPapMetrics();
49 * Gets the <code>Integer</code> value of the count of policies that reside on the PDP.
51 * @return the <code>Integer</code> which consists of count of policies that reside on the PDP.
53 public int getPdpMetrics();
57 * Gets the <code>Integer</code> value of the total count of policies.
59 * @return the <code>Integer</code> which consists of the total count of policies.
61 public int getMetricsTotal();