Design and Public API documentation completed.

The draw.io diagrams are in Gerrit. If the page is ever deleted, they
will be lost. They ae now saved in XML format in gerrit.

The design documentation links to the examples in github rather than
quoting them in the document. General tidy up and cleaning of links,
rewording, and reformatting of desgin document.

Added missing diagram to the Design document.

Updated and tidied up the internal PAP/PDP document.

General improvement of documentation.

Issue-ID: POLICY-1676
Change-Id: Ie5c9f32693f047beafe14a3e412a32cdf9ed6fde
Signed-off-by: liamfallon <liam.fallon@est.tech>

1 files changed, 34 insertions, 0 deletions

diff --git a/docs/architecture/images/PolicyExecutionFlow.svg b/docs/architecture/images/PolicyExecutionFlow.svg
new file mode 100644
index 00000000..c9b2f7f6
--- /dev/null
+++ b/docs/architecture/images/PolicyExecutionFlow.svg
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="324px" preserveAspectRatio="none" style="width:424px;height:324px;" version="1.1" viewBox="0 0 424 324" width="424px" zoomAndPan="magnify"><defs><filter height="300%" id="fso0gk0egkro" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><text fill="#000000" font-family="sans-serif" font-size="14" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="128" x="148.5" y="22.9951">Policy Execution</text><rect fill="#FFFFFF" filter="url(#fso0gk0egkro)" height="62.2656" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="373.5" y="123.8594"/><rect fill="#FFFFFF" filter="url(#fso0gk0egkro)" height="29.1328" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="373.5" y="230.0625"/><rect fill="#FFFFFF" filter="url(#fso0gk0egkro)" height="181.6016" style="stroke: #000000; stroke-width: 2.0;" width="399" x="13" y="85.5938"/><rect fill="#FFFFFF" height="73.0703" style="stroke: none; stroke-width: 1.0;" width="399" x="13" y="194.125"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="76" x2="76" y1="68.5938" y2="284.1953"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="191" x2="191" y1="68.5938" y2="284.1953"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="378" x2="378" y1="68.5938" y2="284.1953"/><rect fill="#FEFECE" filter="url(#fso0gk0egkro)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="102" x="23" y="33.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="88" x="30" y="53.292">REQUESTOR</text><rect fill="#FEFECE" filter="url(#fso0gk0egkro)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="102" x="23" y="283.1953"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="88" x="30" y="303.1904">REQUESTOR</text><rect fill="#FEFECE" filter="url(#fso0gk0egkro)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="101" x="139" y="33.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="87" x="146" y="53.292">RESPONDEE</text><rect fill="#FEFECE" filter="url(#fso0gk0egkro)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="101" x="139" y="283.1953"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="87" x="146" y="303.1904">RESPONDEE</text><rect fill="#FEFECE" filter="url(#fso0gk0egkro)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="43" x="355" y="33.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="29" x="362" y="53.292">PDP</text><rect fill="#FEFECE" filter="url(#fso0gk0egkro)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="43" x="355" y="283.1953"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="29" x="362" y="303.1904">PDP</text><rect fill="#FFFFFF" filter="url(#fso0gk0egkro)" height="62.2656" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="373.5" y="123.8594"/><rect fill="#FFFFFF" filter="url(#fso0gk0egkro)" height="29.1328" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="373.5" y="230.0625"/><path d="M13,85.5938 L77,85.5938 L77,92.5938 L67,102.5938 L13,102.5938 L13,85.5938 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="181.6016" style="stroke: #000000; stroke-width: 2.0;" width="399" x="13" y="85.5938"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="19" x="28" y="98.6606">alt</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="163" x="92" y="97.8042">[Synchronous Invocation]</text><polygon fill="#A80036" points="361.5,119.8594,371.5,123.8594,361.5,127.8594,365.5,123.8594" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="76" x2="367.5" y1="123.8594" y2="123.8594"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="83" y="118.7935">1</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="91" x="96" y="118.7935">Execute Policy</text><polygon fill="#FBFB77" filter="url(#fso0gk0egkro)" points="61,136.8594,90,136.8594,100,147.8594,90,159.8594,61,159.8594,51,147.8594,61,136.8594" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="25" x="63" y="152.9263">wait</text><polygon fill="#A80036" points="87,182.125,77,186.125,87,190.125,83,186.125" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="81" x2="377.5" y1="186.125" y2="186.125"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="93" y="181.0591">2</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="145" x="106" y="181.0591">Policy Execution Result</text><line style="stroke: #000000; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="13" x2="412" y1="195.125" y2="195.125"/><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="170" x="18" y="205.3354">[Asynchronous Invocation]</text><polygon fill="#A80036" points="361.5,226.0625,371.5,230.0625,361.5,234.0625,365.5,230.0625" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="76" x2="367.5" y1="230.0625" y2="230.0625"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="83" y="224.9966">3</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="91" x="96" y="224.9966">Execute Policy</text><polygon fill="#A80036" points="202.5,255.1953,192.5,259.1953,202.5,263.1953,198.5,259.1953" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="196.5" x2="377.5" y1="259.1953" y2="259.1953"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="208.5" y="254.1294">4</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="145" x="221.5" y="254.1294">Policy Execution Result</text><!--
+@startuml

+title Policy Execution

+

+participant REQUESTOR

+participant RESPONDEE

+participant PDP

+

+autonumber

+

+alt Synchronous Invocation

+  REQUESTOR - -> PDP: Execute Policy

+  activate PDP

+  hnote over REQUESTOR : wait

+  PDP - -> REQUESTOR: Policy Execution Result

+  deactivate PDP

+else Asynchronous Invocation

+  REQUESTOR - -> PDP: Execute Policy

+  activate PDP

+  PDP - -> RESPONDEE: Policy Execution Result

+  deactivate PDP

+end

+@enduml

+
+PlantUML version 1.2019.07beta1(Unknown compile time)
+(GPL source distribution)
+Java Runtime: Java(TM) SE Runtime Environment
+JVM: Java HotSpot(TM) 64-Bit Server VM
+Java Version: 1.7.0_25-b15
+Operating System: Linux
+Default Encoding: UTF-8
+Language: en
+Country: US
+--></g></svg>
\ No newline at end of file