aboutsummaryrefslogtreecommitdiffstats
path: root/docs/xacml/xacml.rst
diff options
context:
space:
mode:
authorPamela Dragosh <pdragosh@research.att.com>2019-06-11 10:55:04 -0400
committerPamela Dragosh <pdragosh@research.att.com>2019-06-12 13:16:58 +0000
commit24be8a53f15d3f305979364b9cff7f286d5489d7 (patch)
tree56bf2dabf0f1e97ce181124fbdf91c509ec38f2e /docs/xacml/xacml.rst
parentac2dfef8c8644103bb21316646ecda6a37d91d9b (diff)
Fix documentation add tutorial
Fixed some headings that made index's look strange. Added xacml tutorial. Issue-ID: POLICY-1842 Change-Id: Id6ab56e5d5d2a6b2fe37c8df5d3d70aa04776878 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com> (cherry picked from commit 0ac4c6a0a3c5eacf7db3b1766048a8d1405f3e96)
Diffstat (limited to 'docs/xacml/xacml.rst')
-rw-r--r--docs/xacml/xacml.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/xacml/xacml.rst b/docs/xacml/xacml.rst
index 58d887fa..71873515 100644
--- a/docs/xacml/xacml.rst
+++ b/docs/xacml/xacml.rst
@@ -92,11 +92,13 @@ This is an example Decision API payload made to retrieve a decision for an Optim
Supporting Custom Policy Types
******************************
-In order to support your own custom Policy Type that the XACML PDP Engine can support, one needs to build a Java service application that extends the **XacmlApplicationServiceProvider** interface and expose it in the classpath used to load the XACML PDP Engine. First, ensure you define and create the TOSCA Policy Type according to these :ref:`Policy Design and Development <design-label>`. You should be able to load your custom Policy Type using the :ref:`Policy Lifecycle API <api-label>`. Once successful, you should be able to start creating policies from your custom Policy Type.
+In order to support your own custom Policy Type that the XACML PDP Engine can support, one needs to build a Java service application that extends the **XacmlApplicationServiceProvider** interface and implement a **ToscaTranslator** application. Your application should register itself as a Java service application and expose it in the classpath used to be loaded into the ONAP XACML PDP Engine. Ensure you define and create the TOSCA Policy Type according to these :ref:`Policy Design and Development <design-label>`. You should be able to load your custom Policy Type using the :ref:`Policy Lifecycle API <api-label>`. Once successful, you should be able to start creating policies from your custom Policy Type.
-See each of the ONAP Policy Type application implementations for examples on how to implement the methods for the **XacmlApplicationServiceProvider**. Consider re-using the standard implementations.
+See each of the ONAP Policy Type application implementations for for ONAP re-use the **StdXacmlApplicationServiceProvider** class. They give simple examples on how to use various implementations of **ToscaTranslator** applications.
-Once your application is developed and the XACML PDP Engine can find your application via setting the classpath appropriately, then use the :ref:`PAP REST API <pap-label>` to ensure the XACML PDP is loaded and registering your custom Policy Type. Once successful, then you should be able to start deploying the created policies to the XACML PDP Engine.
+The following tutorial can be helpful to get started: :ref:`xacmltutorial-label`
+
+Once your application is developed and the ONAP XACML PDP Engine can find your application via setting the classpath appropriately, then use the :ref:`PAP REST API <pap-label>` to ensure the ONAP XACML PDP is registering your custom Policy Type with the PAP. Once successful, then you should be able to start deploying the created policies to the XACML PDP Engine.
Decision API
************