summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDragosh, Pamela (pd1248) <pd1248@att.com>2021-07-21 15:26:40 -0400
committerDragosh, Pamela (pd1248) <pd1248@att.com>2021-07-21 16:05:53 -0400
commited12d64e49c7e847097c8b5aad19f8b21b5d62c9 (patch)
tree4a181de5e4fb4db1fc94d203c2720692798711c9
parentbd34577746b32420b6f0ed84a31d253f612bd420 (diff)
Update xacml docs returning attributes
Update the documentation to refer to examples and tutorials regarding the use of attributes along with obligations and advice. Issue-ID: POLICY-2865 Change-Id: I048b2e19f9ca4fdbf50e18d2b64299023b4af2bb Signed-off-by: Dragosh, Pamela (pd1248) <pd1248@att.com>
-rw-r--r--docs/xacml/xacml-tutorial.rst2
-rw-r--r--docs/xacml/xacml.rst8
2 files changed, 5 insertions, 5 deletions
diff --git a/docs/xacml/xacml-tutorial.rst b/docs/xacml/xacml-tutorial.rst
index e50728ab..b1b544cf 100644
--- a/docs/xacml/xacml-tutorial.rst
+++ b/docs/xacml/xacml-tutorial.rst
@@ -217,7 +217,7 @@ For the tutorial, we will build code that translates the TOSCA Policy into one X
on the user and action. It will then have one or more rules for each entity and permission combination. The
default combining algorithm for the XACML Rules are to "Deny Unless Permit".
-`See the tutorial example for details on how the translator is implemented <https://github.com/onap/policy-xacml-pdp/blob/master/tutorials/tutorial-xacml-application/src/main/java/org/onap/policy/tutorial/tutorial/TutorialTranslator.java>`_
+`See the tutorial example for details on how the translator is implemented <https://github.com/onap/policy-xacml-pdp/blob/master/tutorials/tutorial-xacml-application/src/main/java/org/onap/policy/tutorial/tutorial/TutorialTranslator.java>`_. Note that in the Tutorial Translator, it also shows how a developer could extend the translator to return or act upon obligations, advice and attributes.
.. Note::
There are many ways to build the policy based on the attributes. How to do so is a matter of experience and
diff --git a/docs/xacml/xacml.rst b/docs/xacml/xacml.rst
index 7ccd2934..5fd50a1b 100644
--- a/docs/xacml/xacml.rst
+++ b/docs/xacml/xacml.rst
@@ -315,18 +315,18 @@ See each of the ONAP Policy Type application implementations which re-use the **
ToscaPolicyTranslator
=====================
-Your custom **XacmlApplicationServiceProvider** must provide an implementation of a *ToscaPolicyTranslator*.
+Your custom **XacmlApplicationServiceProvider** must provide an implementation of a **ToscaPolicyTranslator**.
`Interface for ToscaPolicyTranslator <https://github.com/onap/policy-xacml-pdp/blob/master/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/ToscaPolicyTranslator.java>`_
-See each of the ONAP Policy type application implementations which each have their own *ToscaPolicyTranslator*. Most use or extend the **StdBaseTranslator**.
+See each of the ONAP Policy type application implementations which each have their own *ToscaPolicyTranslator*. Most use or extend the **StdBaseTranslator** which contain methods that applications can use to support XACML obligations, advice as well as return attributes to the calling client applications via the **DecisionResponse**.
-`Standard Tosca Policy Translator implementation <https://github.com/onap/policy-xacml-pdp/blob/master/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/std/StdBaseTranslator.java>`.
+`Standard Tosca Policy Translator implementation <https://github.com/onap/policy-xacml-pdp/blob/master/applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/std/StdBaseTranslator.java>`_.
XACML Application and Enforcement Tutorials
===========================================
-The following tutorials can be helpful to get started on building your own decision application as well as building enforcement into your application.
+The following tutorials can be helpful to get started on building your own decision application as well as building enforcement into your application. They also show how to build and extend both the **XacmlApplicationServiceProvider** and **ToscaPolicyTranslator** classes.
.. toctree::
:maxdepth: 1