Policy 1707 commit to LF

[policy/engine.git] / PolicyEngineAPI / src / main / java / org / openecomp / policy / api / MetricsResponse.java

diff --git a/PolicyEngineAPI/src/main/java/org/openecomp/policy/api/MetricsResponse.java b/PolicyEngineAPI/src/main/java/org/openecomp/policy/api/MetricsResponse.java
new file mode 100644 (file)
index 0000000..d96a6dc
--- /dev/null
+++ b/PolicyEngineAPI/src/main/java/org/openecomp/policy/api/MetricsResponse.java
@@ -0,0 +1,45 @@
+package org.openecomp.policy.api;
+
+public interface MetricsResponse {
+
+       /**
+        * Gets the <code>String</code> of the metrics message from <code>MetricsResponse</code>.
+        * 
+        * @return the <code>String</code> which consists of the metrics message from <code>MetricsResponse</code>
+        */
+       public String getResponseMessage();
+       
+       /**
+        * Gets the response code of type <code>Integer</code> which corresponds to the HTTP Response code explaining the response from Policy Engine. 
+        * 
+        * @return the responseCode in <code>Integer</code> format corresponding to the HTTP response code from Policy Engine. 
+        */
+       public int getResponseCode();
+
+       
+       /**
+        * Gets the <code>Integer</code> value of the count of policies that reside on the PAP.
+        * 
+        * @return the <code>Integer</code> which consists of count of policies that reside on the PAP.  
+        */
+       public int getPapMetrics();
+       
+       
+       /**
+        * Gets the <code>Integer</code> value of the count of policies that reside on the PDP.
+        * 
+        * @return the <code>Integer</code> which consists of count of policies that reside on the PDP.  
+        */
+       public int getPdpMetrics();
+       
+       
+       /**
+        * Gets the <code>Integer</code> value of the total count of policies.
+        * 
+        * @return the <code>Integer</code> which consists of the total count of policies.  
+        */
+       public int getMetricsTotal();
+       
+
+
+}