Tech-invite3GPPspaceIETFspace
21222324252627282931323334353637384‑5x

Content for  TS 32.158  Word version:  17.3.0

Top   Top   Up   Prev   Next
1…   4…   5…   6…   7…

 

4  General rulesp. 7

4.1  Information models and resourcesp. 7

4.1.1  Information modelsp. 7

An information model is a representation of a system. Typical models do not reflect all facets of the system, but only certain aspects required to solve the management problem the model is designed for. 3GPP follows an object-oriented modelling approach. Models are built from managed object classes. Each object class contains information elements called attributes. Relationships between classes represent the logical connections. Models are specified formally with class diagrams produced using the Unified Modelling Language (UML).
The instantiation of a managed object class is called managed object instance, or concisely just managed object or object. All managed object instances together with the relationships between them constitute an object tree. An object tree is also called containment tree.
Up

4.1.2  Resourcesp. 7

HTTP uses a different terminology based on the notion of resources, as defined in Section 2 of RFC 7231. Each resource is represented by one or more resource representations as defined in Section 3 of RFC 7231. Valid resource representations are e.g. XML instance documents or JSON instance documents.
Besides this primary resource, Section 3.5 of RFC 3986 introduces the concept of secondary resources. Secondary resources are specific portions or subsets of primary resources, that are identifiable.
Up

4.1.3  Resource archetypesp. 8

Resources can be classified according to their structure and behaviour into resource archetypes. This helps specifying clear and understandable interfaces. The following three archetypes are defined:
  • Document resource: This is the standard resource containing data in form of name value pairs and links to related resources. This kind of resource typically represents a real-world object or a logical concept.
  • Collection resource: A collection resource is grouping resources of the same kind. The resources below the collection resource are called items of the collection. An item of a collection is normally a document resource. Collection resources typically contain links to the items of the collection and information about the collection like the total number of items in the collection. Collection resources can be further distinguished into server-managed and client-managed resources. Collection resources are also known as container resources.
  • Operation resource: Operation resources represent executable functions. They may have input and output parameters. Operation resources allow some sort of fall back to an RPC style design in case application specific actions cannot be mapped easily to CRUD style operations.
Up

4.1.4  Mapping of information models to resourcesp. 8

RESTful SS shall be specified in a way that managed object instances are described by (primary) document resources. Collection resources have no equivalent in an information model unless some dedicated collection class is introduced.
Attributes are mapped to secondary resources.

4.1.5  Usage of information models |R16|p. 8

Information models are used for two purposes when specifying interfaces to observe and act upon information models:
  • They provide a means to identify information in message requests.
  • They provide a format to transfer information in message request and message response bodies.
Identification of information is necessary when retrieving information from a MnS Producer; the MnS Consumer needs to be able to specify in his retrieveal request the information the MnS Producer shall return. But also when information needs to be updated or deleted the MnS Consumer needs to identify the information to be updated or deleted in his request. When information is added, the location of the new information is specified relative to the location of existing information.
Request and response message bodies carrying (some parts of) the information model are also constructed based on the information model supported by the MnS Producer. The message format is either identical to the information model format or some transformation of the information model format.
Up

4.2  Managed object naming and resource identificationp. 8

4.2.1  Managed object namingp. 8

4.2.1.0  Distinguished Name (DN)p. 8

The Distinguished Name (DN) is used in 3GPP to uniquely identify a managed object instance within a specific name space. The DN is a comma (",") separated list of Relative Distinguished Names (RDNs). Each managed object instance has an associated RDN. The sequence of RDNs is governed by name containment relationships in the UML class diagram describing the modelled network. The RDN consists of a naming attribute name separated by an equal sign ("=") from the naming attribute value. The naming attribute name is equal to the class name of the MOI.
In addition to the RDNs associated to a managed object instance the DN may have as leftmost RDN whose naming attribute name is "DC" (Domain Component) and whose value is a domain name. A DN with DC is globally unique.
The DN concept is described in detail in TS 32.300.The following example DN has a DC.
DN = "DC=operatorA.com,­SubNetwork=south,­ManagedElement=a,­ENBFunction=1,­Cell=1"
Up

4.2.1.1  Global and local namespacesp. 9

A DN in the global name space is globally unique and starts with the RDN of the global root. A DN in a local name space starts with the RDN of the local root and is unique only within this name space. A DN in a local namespace is also referred to as Local Distinguished Name (LDN). The DN of the local root relative to the global root is called DN prefix. The concatenation of DN prefix and LDN is equal to the globally unique DN of a managed object.
The local root is typically the root of the network resource model representing the managed network.
Up

4.2.2  Resource identificationp. 9

HTTP uses a subset of the generic Uniform Resource Identifier (URI) scheme (RFC 3986) defined in RFC 7230 for target resource identification.
http-URI = "http:" "//" authority path-abempty [ "?" query ] [ "#" fragment ]
The path component is an absolute path (one that starts with a single slash character) or empty.
The origin server is identified by the authority component, which includes a host identifier and an optional TCP port. The hierarchical path component and optional query component serve as an identifier for a potential target resource within that origin server's name space. The optional fragment component allows for indirect identification of a secondary resource.The host identifier is either an IP address or an indirect identifier such as a FQDN to be resolved with DNS.
URIs are used by HTTP for routing and addressing of target resources. They shall not be used for other purposes or as an alternative for DNs.
Up

4.2.3  Mapping of DNs to URIsp. 9

URIs are globally unique. For this reason only a globally unique DN with DC is mappable into a URI. The mapping rules are as follow:
  • The DN prefix is mapped semantically to the authority component of the URI. The syntax of the DN prefix is modified to match the syntax of the authority component.
  • The LDN is mapped semantically to the path component of the URI. The syntax of the LDN is modified to match the syntax of the path component.
When mapping a LDN the equal sign "="shall be used as delineator between the naming attribute name and naming attribute value when constructing a RDN.
URI-RDN = {namingAttributeName} "=" {namingAttributeValue}
The URI-LDN is the concatenation of URI-RDNs separated by a slash "/".
URI-LDN = *( "/" RDN )
For example, the LDN
LDN = "SubNetwork=south,ManagedElement=a,ENBFunction=1,Cell=1"
maps to
URI-LDN = "/SubNetwork=south/ManagedElement=a/ENBFunction=1/Cell=1"
and the LDN
LDN = "ManagedElement=a,ENBFunction=1,Cell=1"
to
URI-LDN = "/ManagedElement=a/ENBFunction=1/Cell=1"
When constructing the authority part from the DN prefix, it shall be reformatted according to the name conventions applying to FQDNs. For example, the DN prefix
DN-prefix = "DC=operatorA.com"
maps to
URI-DN-prefix = "operatorA.com"
and the DN prefix
DN-prefix = "DC=operatorA.com,SubNetwork=south"
to
URI-DN-prefix = "south.SubNetwork.operatorA.com"
The complete URIs for the examples are
The constructed URI-DN-prefix is a FQDN that can be registered into a name resolution service such as DNS. The sole presence of a constructed FQDN does not mean it can be resolved to an IP address and there is a server listening at that address.
Using the mapping rule, a DN is mapped predictably into the URI authority component and path component.
The leftmost part of the path component may include one or more path segments ("label")
http://operatorA.com/{label}/SubNetwork=south/.../Cell=1
allowing to structure the resource hierarchy, for example
The character set allowed in DNs is much bigger than the character set allowed in the path component and authority component of a URI. Care needs to be taken when selecting the naming attribute names und values that the mapping from a DN to a URI does not become impossible as a consequence of not mappable characters.
When no registered name can be used, the IP address shall be specified directly in the host component, for example
This might be required in multiple situations. For example, when a DN prefix is used but the corresponding URI-DN-prefix cannot be resolved, the MnS consumer needs to specify an IP address in the target URI of HTTP request messages. The same is true when no DN prefix is used at all. Another example is when no DN prefix is configured into MnS Producers and the MnS Producer wants to report events, that occurred related to resources, using notifications sent to MnS consumers. The MnS Producer has no other possibility than to put its own IP address into the host component of the URI identifying the resource where the event occurred.
Up

4.3  Message content formatsp. 10

4.3.1  Media types |R16|p. 10

The format of HTTP request and response message content is indicated with media types consisting of a type, a subtype and optional parameters, as defined in Section 3.1.1.1 of RFC 7231. The "Content-Type" header field of a message contains the media type of the message content (Section 3.1.1.5 of RFC 7231).
If not otherwise stated, the media type of request and response message bodies in the REST SS is
Exceptions are when JSON patch documents are contained in request bodies. They are identified with the media types
  • application/merge-patch+json (RFC 7396 [12], and clause 6.3.2 of the present document),
  • application/json-patch+json (RFC 6902 [13], and clause 6.3.3 of the present document).
Furthermore, this specification defines four new formats for JSON patch documents. Their media types are
  • application/3gpp-merge-patch+json (clause 6.4.2 of the present document),
  • application/3gpp-json-patch+json (clause 6.4.3 of the present document),
  • application/vnd.3gpp.object-tree-hierarchical+json (clause 6.1.4 of the present document),
  • application/vnd.3gpp.object-tree-flat+json (clause 6.1.4 of the present document).
JSON documents shall conform to JSON Schema ([7], [8], [9]).
Up

4.3.2  Response content format negotiation |R16|p. 11

The MnS Producer shall engage in proactive content negotiation as defined in Section 3.4.1 of RFC 7231 by including the "Accept" header field in HTTP requests that expect a message body in the response. The "Accept" header field indicates to the MnS Producer the media types acceptable to the MnS Consumer.

4.4  URI structurep. 11

4.4.1  Introductionp. 11

MnS producers can be divided into two categories. The first category exposes MnS(s) to manipulate resources representing managed object instances. In this case the URI structure is governed by the mapping rules defined in clause 4.2.3. The second category exposes MnS(s) to manipulate resources not representing managed object instances. In this case the DN concept is not relevant. The URI structure for both categories is different.
Up

4.4.2  URI structure for resources representing managed object instancesp. 11

URIs identifying resources representing managed object instances shall follow a structure given by
{scheme}://{URI-DN-prefix}/{root}/{MnSName}/{MnSVersion}/{URI-LDN}
with:
{scheme}
Scheme component "http" or "https"
{URI-DN-prefix}
Authority component (host identifier and optional TCP port), the host name is constructed from the DN prefix as defined in clause 4.2.3.
{root}
Part of the path component, allows specifying optional path segments for structuring the resource hierarchy on a HTTP server.
{MnSName}
Part of the path component, allows specifying an optional MnS name in a single path segment.
{MnSVersion}
Part of the path component, allows specifying an optional MnS version in a single path segment.
{URI-LDN}
Part of the path component, constructed from the LDN as defined in clause 4.2.3, containing zero, one or more path segments.
As seen above, to construct the URI from a DN, it is necessary to map the "DNPrefixPlusRDNSeparator" as defined in clause 7.3 of TS 32.300, the "LocalDN" as defined in clause 7.3 of TS 32.300, and to add the additional optional path segments "/{root}/{MnSName}/{MnSVersion}".
To allow for a predictive mapping from an URI to the original DN it is necessary to specify "/{MnSName}/{MnSVersion}" in such a way that the beginning of the "LocalDN" can be unambigously identified.
{URI-LDN-first-part}/{RDN}
or
{URI-LDN-first-part}/{className}={id}.
For the sake of brevity, "MnSRoot" is introduced that includes the "{scheme}" part, the two slash characters ("//"), the "{authority}" part, a single slash character ("/") and the "{root}" part. When using "{MnSRoot}" the abbreviated URI structure is given by
{MnSRoot}/{MnSName}/­{MnSVersion}/­{URI-LDN}
or
{MnSRoot}/{MnSName}/­{MnSVersion}/­{URI-LDN-first-part}/­{className}={id}
It is recommended to use this abbreviated version of the URI structure when defining Management Services.
The path segment "MnSVersion" allows access to resources with different MnS versions, for example:
Note that both URIs, though different as to the path segment indicating the version number of the ProvMnS, identify the same resource.
Up

4.4.3  URI structure for resources not representing managed object instancesp. 12

URIs identifying other resources shall follow a structure given by
{scheme}://{authority}/{root}/{MnSName}/{MnSVersion}/{MnSResourcePath}
with:
{scheme}
Scheme component "http" or "https"
{authority}
Authority component (host identifier and optional TCP port)
{root}
Part of the path component, allows specifying optional path segments for structuring the resource hierarchy on a HTTP server.
{MnSName}
Part of the path component, specifies the mandatory MnS name in a single path segment.
{MnSVersion}
Part of the path component, specifies the mandatory MnS version in a single path segment.
{MnSResourcePath}
Part of the path component, one or more path segments, specifies a resource of the MnS
For the sake of brevity, {MnSRoot} is introduced that includes the "{scheme}" part, the two slash characters ("//"), the "{authority}" part, a single slash character ("/") and the "{root}" part. When using "{MnSRoot}" the abbreviated URI structure is given by
{MnSRoot}/{MnSName}/{MnSVersion}/{MnSResourcePath}
It is recommended to use this abbreviated form of the URI structure when defining Management Services
Up

4.4.4  Resource "../{MnSName}/{MnSVersion}" |R16|p. 12

The resource identified by "../{MnSName}/{MnSVersion}" is called NRM root. It represents the conceptual parent of the top-level managed object instances. It is created by the MnS Producer. A MnS Consumer cannot create or delete this resource.
The resource is the target resource for many HTTP requests, such as requests to retrieve all top-level managed object instances in case there are multiple top-level managed object instances, or for requests to create objects in case there are no manged object instances yet and the creation request needs to be directed to the parent of the resource to be created.
Up

4.5  Response status codesp. 13

The response status codes as defined in Section 6 of RFC 7231 shall be supported.

Up   Top   ToC