Complete Architecture Document

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

1 files changed, 62 insertions, 0 deletions

diff --git a/docs/architecture/images/PolicyDatabase.svg b/docs/architecture/images/PolicyDatabase.svg
new file mode 100644
index 00000000..ba4ad107
--- /dev/null
+++ b/docs/architecture/images/PolicyDatabase.svg
@@ -0,0 +1,62 @@
+<?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="526px" preserveAspectRatio="none" style="width:559px;height:526px;" version="1.1" viewBox="0 0 559 526" width="559px" zoomAndPan="magnify"><defs><filter height="300%" id="f1gtwiqou403ds" 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="18" lengthAdjust="spacingAndGlyphs" textLength="239" x="164" y="16.708">Indicative Database Layout</text><!--class PDP_SUBGROUP--><rect fill="#FEFECE" filter="url(#f1gtwiqou403ds)" height="129.6328" id="PDP_SUBGROUP" style="stroke: #A80036; stroke-width: 1.5;" width="159" x="14" y="228.9531"/><ellipse cx="41.6" cy="244.9531" fill="#FFAAAA" rx="11" ry="11" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M42.0375,242.4844 L42.0375,249 L43.1625,249 C43.6156,249 43.7563,249.0313 43.9125,249.1563 C44.1469,249.3281 44.2719,249.5781 44.2719,249.8594 C44.2719,250.1406 44.1313,250.4375 43.8656,250.5781 C43.7563,250.6563 43.4906,250.7031 43.1625,250.7031 L39.225,250.7031 C38.8344,250.7031 38.6156,250.6563 38.4594,250.5313 C38.2406,250.375 38.1,250.1094 38.1,249.8594 C38.1,249.5625 38.2563,249.2813 38.5063,249.125 C38.6625,249.0156 38.7875,249 39.225,249 L40.3344,249 L40.3344,242.4844 L38.5063,242.4844 L38.5063,244.0781 C38.5063,244.5313 38.475,244.6719 38.3656,244.8438 C38.1938,245.0625 37.9438,245.1875 37.6625,245.1875 C37.3813,245.1875 37.0844,245.0469 36.9281,244.7813 C36.85,244.6406 36.8188,244.4688 36.8188,244.0781 L36.8188,240.7969 L45.5844,240.7969 L45.5844,244.0781 C45.5844,244.5469 45.5688,244.6719 45.4281,244.8438 C45.2563,245.0625 45.0063,245.1875 44.7406,245.1875 C44.4438,245.1875 44.1625,245.0313 44.0063,244.7813 C43.9125,244.6406 43.8813,244.4688 43.8813,244.0781 L43.8813,242.4844 Z "/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="99" x="58.4" y="249.1074">PDP_SUBGROUP</text><line style="stroke: #A80036; stroke-width: 1.5;" x1="15" x2="172" y1="260.9531" y2="260.9531"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" text-decoration="underline" textLength="109" x="20" y="275.1636">PDP_SUBGROUP_ID</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="129" x="20" y="287.9683">PDP_SUBGROUP_NAME</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="147" x="20" y="300.7729">PDP_SUBGROUP_VERSION</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="56" x="20" y="313.5776">PDP_TYPE</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="138" x="20" y="326.3823">PDP_SERVICE_ENDPOINT</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="85" x="20" y="339.187">POLICY_SET_ID</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="134" x="20" y="351.9917">PDP_SUBGROUP_STATE</text><!--class PDP--><rect fill="#FEFECE" filter="url(#f1gtwiqou403ds)" height="129.6328" id="PDP" style="stroke: #A80036; stroke-width: 1.5;" width="165" x="81" y="32.9531"/><ellipse cx="146.75" cy="48.9531" fill="#FFAAAA" rx="11" ry="11" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M147.1875,46.4844 L147.1875,53 L148.3125,53 C148.7656,53 148.9063,53.0313 149.0625,53.1563 C149.2969,53.3281 149.4219,53.5781 149.4219,53.8594 C149.4219,54.1406 149.2813,54.4375 149.0156,54.5781 C148.9063,54.6563 148.6406,54.7031 148.3125,54.7031 L144.375,54.7031 C143.9844,54.7031 143.7656,54.6563 143.6094,54.5313 C143.3906,54.375 143.25,54.1094 143.25,53.8594 C143.25,53.5625 143.4063,53.2813 143.6563,53.125 C143.8125,53.0156 143.9375,53 144.375,53 L145.4844,53 L145.4844,46.4844 L143.6563,46.4844 L143.6563,48.0781 C143.6563,48.5313 143.625,48.6719 143.5156,48.8438 C143.3438,49.0625 143.0938,49.1875 142.8125,49.1875 C142.5313,49.1875 142.2344,49.0469 142.0781,48.7813 C142,48.6406 141.9688,48.4688 141.9688,48.0781 L141.9688,44.7969 L150.7344,44.7969 L150.7344,48.0781 C150.7344,48.5469 150.7188,48.6719 150.5781,48.8438 C150.4063,49.0625 150.1563,49.1875 149.8906,49.1875 C149.5938,49.1875 149.3125,49.0313 149.1563,48.7813 C149.0625,48.6406 149.0313,48.4688 149.0313,48.0781 L149.0313,46.4844 Z "/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="25" x="167.25" y="53.1074">PDP</text><line style="stroke: #A80036; stroke-width: 1.5;" x1="82" x2="245" y1="64.9531" y2="64.9531"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" text-decoration="underline" textLength="39" x="87" y="79.1636">PDP_ID</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="59" x="87" y="91.9683">PDP_NAME</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="77" x="87" y="104.7729">PDP_VERSION</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="56" x="87" y="117.5776">PDP_TYPE</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="85" x="87" y="130.3823">PDP_ENDPOINT</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="109" x="87" y="143.187">PDP_SUBGROUP_ID</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="153" x="87" y="155.9917">POLICY_SET_ID PDP_STATE</text><!--class POLICY_SET--><rect fill="#FEFECE" filter="url(#f1gtwiqou403ds)" height="78.4141" id="POLICY_SET" style="stroke: #A80036; stroke-width: 1.5;" width="135" x="160" y="430.4531"/><ellipse cx="189.85" cy="446.4531" fill="#FFAAAA" rx="11" ry="11" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M190.2875,443.9844 L190.2875,450.5 L191.4125,450.5 C191.8656,450.5 192.0063,450.5313 192.1625,450.6563 C192.3969,450.8281 192.5219,451.0781 192.5219,451.3594 C192.5219,451.6406 192.3813,451.9375 192.1156,452.0781 C192.0063,452.1563 191.7406,452.2031 191.4125,452.2031 L187.475,452.2031 C187.0844,452.2031 186.8656,452.1563 186.7094,452.0313 C186.4906,451.875 186.35,451.6094 186.35,451.3594 C186.35,451.0625 186.5063,450.7813 186.7563,450.625 C186.9125,450.5156 187.0375,450.5 187.475,450.5 L188.5844,450.5 L188.5844,443.9844 L186.7563,443.9844 L186.7563,445.5781 C186.7563,446.0313 186.725,446.1719 186.6156,446.3438 C186.4438,446.5625 186.1938,446.6875 185.9125,446.6875 C185.6313,446.6875 185.3344,446.5469 185.1781,446.2813 C185.1,446.1406 185.0688,445.9688 185.0688,445.5781 L185.0688,442.2969 L193.8344,442.2969 L193.8344,445.5781 C193.8344,446.0469 193.8188,446.1719 193.6781,446.3438 C193.5063,446.5625 193.2563,446.6875 192.9906,446.6875 C192.6938,446.6875 192.4125,446.5313 192.2563,446.2813 C192.1625,446.1406 192.1313,445.9688 192.1313,445.5781 L192.1313,443.9844 Z "/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="70" x="207.15" y="450.6074">POLICY_SET</text><line style="stroke: #A80036; stroke-width: 1.5;" x1="161" x2="294" y1="462.4531" y2="462.4531"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" text-decoration="underline" textLength="85" x="166" y="476.6636">POLICY_SET_ID</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="105" x="166" y="489.4683">POLICY_SET_NAME</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="123" x="166" y="502.2729">POLICY_SET_VERSION</text><!--class POLICY_TYPE_IMPL--><rect fill="#FEFECE" filter="url(#f1gtwiqou403ds)" height="91.2188" id="POLICY_TYPE_IMPL" style="stroke: #A80036; stroke-width: 1.5;" width="170" x="346.5" y="423.9531"/><ellipse cx="374.1" cy="439.9531" fill="#FFAAAA" rx="11" ry="11" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M374.5375,437.4844 L374.5375,444 L375.6625,444 C376.1156,444 376.2563,444.0313 376.4125,444.1563 C376.6469,444.3281 376.7719,444.5781 376.7719,444.8594 C376.7719,445.1406 376.6313,445.4375 376.3656,445.5781 C376.2563,445.6563 375.9906,445.7031 375.6625,445.7031 L371.725,445.7031 C371.3344,445.7031 371.1156,445.6563 370.9594,445.5313 C370.7406,445.375 370.6,445.1094 370.6,444.8594 C370.6,444.5625 370.7563,444.2813 371.0063,444.125 C371.1625,444.0156 371.2875,444 371.725,444 L372.8344,444 L372.8344,437.4844 L371.0063,437.4844 L371.0063,439.0781 C371.0063,439.5313 370.975,439.6719 370.8656,439.8438 C370.6938,440.0625 370.4438,440.1875 370.1625,440.1875 C369.8813,440.1875 369.5844,440.0469 369.4281,439.7813 C369.35,439.6406 369.3188,439.4688 369.3188,439.0781 L369.3188,435.7969 L378.0844,435.7969 L378.0844,439.0781 C378.0844,439.5469 378.0688,439.6719 377.9281,439.8438 C377.7563,440.0625 377.5063,440.1875 377.2406,440.1875 C376.9438,440.1875 376.6625,440.0313 376.5063,439.7813 C376.4125,439.6406 376.3813,439.4688 376.3813,439.0781 L376.3813,437.4844 Z "/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="110" x="390.9" y="444.1074">POLICY_TYPE_IMPL</text><line style="stroke: #A80036; stroke-width: 1.5;" x1="347.5" x2="515.5" y1="455.9531" y2="455.9531"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" text-decoration="underline" textLength="122" x="352.5" y="470.1636">POLICY_TYPE_IMPL_ID</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="77" x="352.5" y="482.9683">POLICY_NAME</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="95" x="352.5" y="495.7729">POLICY_VERSION</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="158" x="352.5" y="508.5776">PDP_TYPE POLICY_ARTIFACT</text><!--class POLICY_SET_TO_POLICY_TYPE_IMPL--><rect fill="#FEFECE" filter="url(#f1gtwiqou403ds)" height="65.6094" id="POLICY_SET_TO_POLICY_TYPE_IMPL" style="stroke: #A80036; stroke-width: 1.5;" width="240" x="300.5" y="260.4531"/><ellipse cx="315.5" cy="276.4531" fill="#FFAAAA" rx="11" ry="11" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M315.9375,273.9844 L315.9375,280.5 L317.0625,280.5 C317.5156,280.5 317.6563,280.5313 317.8125,280.6563 C318.0469,280.8281 318.1719,281.0781 318.1719,281.3594 C318.1719,281.6406 318.0313,281.9375 317.7656,282.0781 C317.6563,282.1563 317.3906,282.2031 317.0625,282.2031 L313.125,282.2031 C312.7344,282.2031 312.5156,282.1563 312.3594,282.0313 C312.1406,281.875 312,281.6094 312,281.3594 C312,281.0625 312.1563,280.7813 312.4063,280.625 C312.5625,280.5156 312.6875,280.5 313.125,280.5 L314.2344,280.5 L314.2344,273.9844 L312.4063,273.9844 L312.4063,275.5781 C312.4063,276.0313 312.375,276.1719 312.2656,276.3438 C312.0938,276.5625 311.8438,276.6875 311.5625,276.6875 C311.2813,276.6875 310.9844,276.5469 310.8281,276.2813 C310.75,276.1406 310.7188,275.9688 310.7188,275.5781 L310.7188,272.2969 L319.4844,272.2969 L319.4844,275.5781 C319.4844,276.0469 319.4688,276.1719 319.3281,276.3438 C319.1563,276.5625 318.9063,276.6875 318.6406,276.6875 C318.3438,276.6875 318.0625,276.5313 317.9063,276.2813 C317.8125,276.1406 317.7813,275.9688 317.7813,275.5781 L317.7813,273.9844 Z "/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="208" x="329.5" y="280.6074">POLICY_SET_TO_POLICY_TYPE_IMPL</text><line style="stroke: #A80036; stroke-width: 1.5;" x1="301.5" x2="539.5" y1="292.4531" y2="292.4531"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="85" x="306.5" y="306.6636">POLICY_SET_ID</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="122" x="306.5" y="319.4683">POLICY_TYPE_IMPL_ID</text><!--link PDP_SUBGROUP to POLICY_SET--><path d="M174.5,334.4531 C234.481,334.4531 106.065,464.4321 154.271,472.5558 " fill="none" id="PDP_SUBGROUP-POLICY_SET" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="159.5,472.9531,150.8287,468.2832,154.5144,472.5745,150.223,476.2602,159.5,472.9531" style="stroke: #A80036; stroke-width: 1.0;"/><!--link PDP to PDP_SUBGROUP--><path d="M80.5,138.9531 C68.9359,138.9531 75.7976,154.8931 81.5,164.9531 C105.572,207.4211 149.789,182.2821 173.5,224.9531 C182.599,241.3281 193.005,266.2131 179.49,270.7351 " fill="none" id="PDP-PDP_SUBGROUP" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="174.5,271.4531,183.9776,274.1317,179.4491,270.7416,182.8392,266.2131,174.5,271.4531" style="stroke: #A80036; stroke-width: 1.0;"/><!--link PDP to POLICY_SET--><path d="M247.5,150.9531 C270.915,150.9531 269.455,337.0881 274.5,359.9531 C285.116,408.0621 343.124,468.2926 301.736,472.6966 " fill="none" id="PDP-POLICY_SET" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="296.5,472.9531,305.6857,476.506,301.494,472.7074,305.2926,468.5157,296.5,472.9531" style="stroke: #A80036; stroke-width: 1.0;"/><!--link POLICY_SET_TO_POLICY_TYPE_IMPL to POLICY_SET--><path d="M299.5,302.4531 C225.635,302.4531 364.889,464.4048 301.846,472.6289 " fill="none" id="POLICY_SET_TO_POLICY_TYPE_IMPL-POLICY_SET" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="296.5,472.9531,305.7258,476.4006,301.4908,472.6503,305.2412,468.4153,296.5,472.9531" style="stroke: #A80036; stroke-width: 1.0;"/><!--link POLICY_SET_TO_POLICY_TYPE_IMPL to POLICY_TYPE_IMPL--><path d="M541.5,314.4531 C547.738,314.4531 544.026,323.3071 540.5,328.4531 C486.617,407.0961 398.417,339.9991 346.5,419.9531 C336.407,435.496 326.992,460.6467 340.535,465.2258 " fill="none" id="POLICY_SET_TO_POLICY_TYPE_IMPL-POLICY_TYPE_IMPL" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="345.5,465.9531,337.1744,460.6916,340.5527,465.2288,336.0155,468.6072,345.5,465.9531" style="stroke: #A80036; stroke-width: 1.0;"/><!--
+@startuml

+title Indicative Database Layout

+

+hide methods

+hide stereotypes

+

+class PDP_SUBGROUP << (T,#FFAAAA) >> {

+  <u>PDP_SUBGROUP_ID</u>

+  PDP_SUBGROUP_NAME

+  PDP_SUBGROUP_VERSION

+  PDP_TYPE

+  PDP_SERVICE_ENDPOINT

+  POLICY_SET_ID

+  PDP_SUBGROUP_STATE

+}

+

+class PDP << (T,#FFAAAA) >> {

+  <u>PDP_ID</u>

+  PDP_NAME

+  PDP_VERSION

+  PDP_TYPE

+  PDP_ENDPOINT

+  PDP_SUBGROUP_ID

+  POLICY_SET_ID PDP_STATE

+}

+

+class POLICY_SET << (T,#FFAAAA) >> {

+  <u>POLICY_SET_ID</u>

+  POLICY_SET_NAME

+  POLICY_SET_VERSION

+}

+

+class POLICY_TYPE_IMPL << (T,#FFAAAA) >> {

+  <u>POLICY_TYPE_IMPL_ID</u>

+  POLICY_NAME

+  POLICY_VERSION

+  PDP_TYPE POLICY_ARTIFACT

+}

+

+class POLICY_SET_TO_POLICY_TYPE_IMPL << (T,#FFAAAA) >> {

+  POLICY_SET_ID

+  POLICY_TYPE_IMPL_ID

+}

+

+PDP_SUBGROUP::POLICY_SET_ID - -> POLICY_SET::POLICY_SET_ID

+PDP::PDP_SUBGROUP_ID - -> PDP_SUBGROUP::PDP_SUBGROUP_ID

+PDP::POLICY_SET_ID - -> POLICY_SET::POLICY_SET_ID

+POLICY_SET_TO_POLICY_TYPE_IMPL::POLICY_SET_ID - -> POLICY_SET::POLICY_SET_ID

+POLICY_SET_TO_POLICY_TYPE_IMPL::POLICY_TYPE_IMPL_ID - -> POLICY_TYPE_IMPL::POLICY_TYPE_IMPL_ID

+@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