New listPolicy API to check pushed policies in PDP

[policy/engine.git] / docs / platform / offeredapis.rst

diff --git a/docs/platform/offeredapis.rst b/docs/platform/offeredapis.rst
index 4a76fb7..1977351 100644 (file)
--- a/docs/platform/offeredapis.rst
+++ b/docs/platform/offeredapis.rst
@@ -418,6 +418,35 @@ Examples
                 }
             }
         }
+        
+        
+    .. code-block:: java
+       :caption: ListPolicy Example
+       :linenos:
+       
+       package org.onap.policyengine;
+
+       import java.util.Collection;
+       import org.onap.policy.api.ConfigNameRequest;
+       import org.onap.policy.api.PolicyEngine;
+
+       /**
+        * List Policy Client Code
+        * policyName : ".*" returns list of policy names from PAP.
+        * policyName : "scope + "_" + "policyType" + "_" + policyName" + ".*" returns the matching policy from pap (active version)
+        *
+        */
+        public class ListPolicyClient {
+          public static void main(String[] args) throws Exception {
+             PolicyEngine pe = new PolicyEngine("config.properties");
+             ConfigNameRequest listPolicyParams = new ConfigNameRequest();
+             listPolicyParams.setPolicyName(".*");
+             Collection<String> policies = pe.listPolicy(listPolicyParams);
+             for (String policy : policies) {
+                 System.out.println(policy);
+             }
+          }
+        }
 
 
     .. code-block:: java