Use Cases for AAI Schema Service Proposal

Contributors

Description	OXM terminology	XSD terminology	Java terminology
"schema element" "java-type" "class"	"java-type" XML tag	"xs:element" XML tag as outer container	Java class
"attribute"	"xml-element" XML tag inside "java-attributes" XML tag having a "type" relating to basic Java values, such as String, Integer, Boolean, etc.	"xs:element" XML tag as inner container having "type" relating to basic values such as "xs:string", "xs:unsignedInt", "xs:boolean", etc.	Java field/member variable
"relationship"	"xml-element" XML tag inside "java-attributes" XML tag having a "type" relating to another "java-type"	"xs:element" XML tag as inner container having "ref" relating to another "xs:element" as outer container having the value prefixed by "tns:"	Java field/member variable
"metadata"	"xml-property" XML tag inside "xml-properties" XML tag	"xs:annotation" XML tag containing "annox:annotate" metadata	N/A. There are various hard-coded behaviours for each individual item of metadata.
"namespace"	special "java-type" that is at the root of the object graph and root of the REST URL path	"xs:element" XML tag as outer container that never appears anywhere else as a "relationship" of another "xs:element"	N/A. There is special hard-coded behaviour for a specific set of "namespaces".
"top-level"	a "relationship" of a "namespace"		N/A.
"sub-component"	a "relationship" of a "java-type" that is not a "namespace"

See also:

	Schema Change Description	CCVPN Example
1	Add new top-level java-type in existing namespace Add relationship into namespace element Define new schema element	AAI-1353-1 ("Network" and "Business" namespaces) AAI-1353-3 ("connectivity" element) AAI-1353-5 ("sp-partner" element) AAI-1353-7 ("lan-port-config" element) AAI-1353-8 ("site-resource" element) AAI-1353-10 ("network-resource" element) AAI-1353-12 ("ext-aai-networks" element) AAI-1353-13 ("sdwan-vpn" element) AAI-1353-14 ("device" element) AAI-1353-15 ("wan-port-config" element)
2	Add new properties to existing schema element	AAI-1353-2 ("service-instance" element) AAI-1353-4 ("vpn-binding" element) AAI-1353-6 ("allotted-resource" element) AAI-1353-9 ("complex" element) AAI-1353-11 ("p-interface" element) AAI-1353-16 ("pnf" element)
3	Add new sub-component schema element in existing namespace	AAI-1353-7b ("dhcp-service" element)
4	Add new relationships to between existing schema elements	tbc
5	Add new relationships between new schema element and existing schema element	tbc
6	Add new EdgeRules between existing schema elements	tbc
7	Add new EdgeRules between new schema element and existing schema element	tbc
8	Add new namespace	AAI-1353-12 ("ext-aai" element), see workaround "ext-aai-networks"
9	Add new sub-component relationship using existing top-level schema element	tbc
10	Add new top-level relationship using existing sub-component schema element	tbc