6 User Data Convergence Messages

29.3353GPPRelease 17Stage 3TSUser Data Convergence (UDC)User data repository access protocol over the Ud interface

Tools: ARFCN - Frequency Conversion for 5G NR/LTE/UMTS/GSM

6.1 General

The Query, Create, Delete and Update messages for UDC shall comply with IETF RFC 4511[8].

6.2 Query

Query request messages shall be coded as LDAP SearchRequest messages.

Query result messages shall be coded as LDAP SearchResultEntry, SearchResultReference, and SearchResultDone messages.

6.3 Create

Create request messages shall be coded as LDAP AddRequest messages or as LDAP ModifyRequest messages with the "operation" field set to "add", depending on the data to be created.

Create result messages shall be coded as LDAP AddResponse messages or as LDAP ModifyResponse messages, depending on the used LDAP request message.

6.4 Delete

Delete request messages shall be coded as LDAP DelRequest messages or as LDAP ModifyRequest messages with the "operation" field set to "delete", depending on the data to be deleted.

Delete result messages shall be coded as LDAP DelResponse messages or as LDAP ModifyResponse messages, depending on the used LDAP request message.

The LDAP assertion control as specified in IETF RFC 4528 [9] may be used for conditional delete operation if the FE knows that the UDR supports the corresponding control.

6.5 Update

Update request messages shall be coded as LDAP ModifyRequest messages with "operation" field set to "replace".

Update result messages shall be coded as LDAP ModifyResponse messages.

The LDAP assertion control as specified in IETF RFC 4528 [9] may be used for conditional update operation if the FE knows that the UDR supports the corresponding control.

6.6 Subscribe

Subscribe request messages shall make use of the HTTP Post method and contain a SOAP message envelope.

Subscribe response messages shall be coded as HTTP response message and shall contain a SOAP envelope.

Subscribe request and response messages shall contain a SOAP message envelope header with a header block containing the following elements:

– msgId
This element uniquely identifies the Subscribe message request – response pair within a connection. The msgId is of type integer. The FE shall allocate the value and use it together with the connId (if any) to correlate a received subscribe response with a sent subscribe request.

– connId
This optional element identifies the connection between FE and UDR. The connId is of type integer. If used, the value is allocated by the FE and is used together with the msgId to correlate a subscribe response with a subscribe request.

Optionally, the Subscribe request SOAP message envelope may contain an authentication ws-security header block and a UsernameToken element containing the following elements:

– Username

– Password

An example of a SOAP envelope header for a Subscribe request message is given below:

<env:Header>

<wsse:Security xmlns:wsse="http://schemas.xmlsoap.org/ws/2003/06/secext">

<wsse:UsernameToken wsu:Id="sample"

xmlns:wsu="http://schemas.xmlsoap.org/ws/2003/06/utility">

<wsse:Username>http://udfe.example.org:8080/UDRNotificationService

</wsse:Username>

<wsse:Password Type="wsse:PasswordText">password</wsse:Password>

</wsse:UsernameToken>

</wsse:Security>
<hb:CorrelationHeader xmlns:hb="urn:headerblock" env:mustUnderstand="true">

      <hb:msgId>25409</hb:msgId>
      <hb:connId>2</hb:connId>
    </hb:CorrelationHeader>
</env:Header>

The UDR shall copy the SOAP Envelope CorrelationHeader received in the Subscribe request and send it unmodified in the Subscribe response.

Subscribe request messages shall contain a SOAP message envelope body formatted according to the XML schema defined in Annex A.

Subscribe response messages shall contain an empty SOAP message envelope body, unless SOAP Fault element is included to indicate detailed error information. The HTTP status code in the Subscribe response message is used to indicate success or failure.

A Subscribe request containing several subscriptions shall be managed in an atomic manner. In the event where at least one requestedData elements among several within a Subscribe request is rejected, the Subscribe response shall report a failure and none of the requestedData elements within this Subscribe request shall be accepted by the UDR. A SOAP Fault element may be included to indicate detailed error information relevant to the first error encountered.

6.7 Notify

Notify request messages shall make use of the HTTP Post method and contain a SOAP message envelope.

Notify response messages shall be coded as HTTP response message and shall contain a SOAP message envelope.

Notify request and response messages shall contain a SOAP message envelope header with a header block containing the following elements:

– serviceName
This optional element identifies a service in the Front End. The value is copied from the Subscribe message or pre-configured in the UDR. The serviceName is of type string with up to 20 characters.

– msgId
This element uniquely identifies the Notify message request – response pair within a connection. The msgId is of type integer. The UDR shall allocate the value and use it together with the connId (if any) to correlate a received notify response with a sent notify request.

– connId
This optional element identifies the connection between the UDR and the FE. The connId is of type integer. If used, the value is allocated by the UDR and is used together with the msgId to correlate a notify response with a notify request.

An example of a SOAP envelope header for a Notify request message is given below:

<env:Header>
    <hb:CorrelationHeader xmlns:hb="urn:headerblock" env:mustUnderstand="true">
      <hb:serviceName>HLR-FE</hb:serviceName>
      <hb:msgId>787627350</hb:msgId>
      <hb:connId>1</hb:connId>
    </hb:CorrelationHeader>
</env:Header>

Application Front Ends shall copy the SOAP Envelope Header received in the Notify request and send it unmodified in the Notify response.

Notify request messages shall contain a SOAP message envelope body formatted according to the XML schema defined in Annex A.

Notify response messages shall contain an empty SOAP message envelope body, unless SOAP Fault element is included to indicate detailed error information. The HTTP status code in the Notify response message is used to indicate success or failure.

6.8 Abandon operation

When a FE wishes to abandon an uncompleted operation towards the UDR, it shall send a LDAP AbandonRequest message.