Skip Headers
Oracle® Communications Services Gatekeeper Communication Service Guide
Release 5.1

E37526-01
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

2 Quality of Service

This chapter describes the Services Gatekeeper Quality of Service (QoS) interface in detail. Information on the QoS RESTful interface can be found in the Oracle Communications Services Gatekeeper RESTful Developer's Guide, another document in this set.

Overview of the Services Gatekeeper QoS

The Services Gatekeeper QoS feature provides applications with a RESTful interface that allows them to control the quality of a subscriber connection. Among the connection quality aspects that the QoS feature can control include limiting and boosting subscriber connection bandwidth, as well as tuning connection latency. The QoS RESTful interface allows the application to initiate the following operations:

  • Apply a QoS policy

  • Apply a QoS policy based upon a pre-defined template

  • Modify an existing QoS policy

  • Remove an existing QoS policy

  • Register and unregister for QoS-related events

  • Query a QoS policy

While the Services Gatekeeper QoS feature enables an application to control QoS, actually executing the applied QoS policy and applying quality changes to a subscriber connection requires a separate Policy and Charging Rule Function (PCRF), such as Oracle Communications Policy Controller, working in conjunction with a Policy and Charging Enforcement Function (PCEF), solutions which are provided by various third parties.

Note:

Services Gatekeeper applies a QoS plan to a subscriber ID and a framed IP address. Applying QoS plans to individual data streams for a particular subscriber ID is not supported.

An Example End to End QoS Solution

While Services Gatekeeper can apply and remove QoS plans, it provides no capability for actually enforcing QoS changes; instead it works in conjunction with PCRF and PCEF servers. Figure 2-1 illustrates a typical end to end QoS solution:

Figure 2-1 An Example End to End QoS Solution

Surrounding text describes Figure 2-1 .

In Figure 2-1:

  1. A subscriber's mobile device is registered with the Gateway GPRS Support Node (GGSN) or the PCEF.

  2. The GGSN or PCEF requests a default QoS plan from the PCRF.

  3. Once the QoS plan is returned from the PCRF, the GGSNor PCEF executes that plan and connects the subscriber's device to the Internet.

  4. A subscriber application sends a RESTful request to Services Gatekeeper for a change in QoS.

  5. Services Gatekeeper sends the QoS request to the PCRF using the Rx protocol.

  6. The PCRF pushes the new QoS plan to the PCEF using the Gx protocol, and the PCEF executes that plan.

  7. The PCRF interfaces with BRM or another billing management system to charge the subscriber appropriately.

Application Interfaces

For information about the RESTful-based interface for the QoS communication service, see the discussion of QoS interfaces in the Oracle Communications Services Gatekeeper RESTful Application Developer's Guide another document in this set.

Events and Statistics

The QoS communication service generates Event Data Records (EDRs) and alarms, to assist system administrators and developers in monitoring the service.

For general information, see Appendix A, "Events, Alarms, and Charging."

Event Data Records

Table 2-1 lists IDs of the EDRs created by the QoS communication service.

Table 2-1 Event Types Generated by the QoS Communication Service

EDR ID Method Called

91801

ApplyQoSFeatureResponse and applyQoSFeature

91802

QoSStatus and getQoSStatus

91803

ActualProperties and modifyQoSFeature

91804

removeQoSFeature

91805

QoSFeatureExpiration

91806

startQoSNotification

91807

stopQoSNotification

91808

sendInitAAR

91809

sendModifyAAR

91810

sendSTR

91811

handleRxRAR

91812

applicationQoSNotification_NotifyQoSEvent

91813

Application Tier: ApplyQoSFeatureResponse and applyQoSFeature

91814

Application Tier: QoSStatus and getQoSStatus

91815

Application Tier: ActualProperties and modifyQoSFeature

91816

Application Tier: removeQoSFeature

91817

Application Tier: startQoSNotification

91818

Application Tier: stopQoSNotification

91819

applyTemplateBasedQoS

91820

modifyTemplateBasedQoS

91821

Application Tier: applyTemplateBasedQos


Alarms

For the list of QoS-related alarms, see Oracle Communications Services Gatekeeper Alarm Handling Guide.

Specifications for the QoS Communication Service

Table 2-2 lists the technical specifications for the QoS communication service.

Table 2-2 Elements of the QoS Communication Service

Element Description

Managed object in Administration Console

domain_name then OCSG then AdminServer then Communication Services then Plugin_qos_diametern where n is the number of the particular plug-in instance.

MBean

Domain=com.bea.wlcp.wlng

Deployment Name=wlng_nt_qos#5.1.0.0

InstanceName=Plugin_qos_diametern where n is the number of the particular plug-in instance

Type=oracle.ocsg.plugin.qos.diameter.management.QoSMBean

Network protocol plug-in service ID

Plugin_qos_diameter

Network protocol plug-in instance ID

Plugin_qos_diamtern where n is the number of the particular plug-in instance

Supported address scheme

tel

Application-facing interface

RESTful

Network-facing interface

Diameter Rx

Service type

QoS RESTful management interface

Deployment artifacts

wlng_at_qos_rest.ear, wlng_nt_qos_rest.ear, com.bea.wlcp.wlng.plugin.qos.diameter.store_5.1.0.0.jar, and RestfulQoSClient.jar (PTE)


Managing the QoS Communication Service

This section describes properties and workflows for the QoS communication service plug-in instance.

General Configuration Workflow for the QoS Communication Service

The following procedure provides an outline to configure the QoS plug-in using the Administration Console or an MBean browser.

  1. Select wlng then PluginManager then createPluginInstance.

  2. Set PluginServiceId to Plugin_qos_diameter and PluginInstanceId to Plugin_qos_diametern where n is an integer that is not already in use by an existing QoS plug-in instance.

  3. Select wlng then PluginManager then addRoute.

  4. Set PluginInstanceId to the id you configured in step 2 and enter an appropriate value for AddressExpression depending upon your Services Gatekeeper configuration.

  5. Select the MBean wlng_nt_qos#5.1.0.0 and select the plug-in instance you created in step 2.

  6. Select wlng_nt_qos#5.1.0.0 then select the plug-in you created in step 2. Expand QoSMBean and configure the plug-in instance attributes:

    Note:

    DestinationHost and DestinationPort should be the correct values for your PCRF.
  7. Ensure that your PCRF is listening on the DestinationPort configured for the QoS plug-in.

Managing QoS Templates

Using the Administration Console or an MBean browser such as the Platform Test Environment, you can perform the following operations on QoS templates:

The creation of QoS templates and the usage of the QoS RESTful interface is covered in detail in the Oracle Communications Services Gatekeeper RESTful Application Developer's Guide, another document in this document set.

Load a QoS Template

For more information creating QoS templates, see "Template-based Apply QoS" in the Oracle Communications Services Gatekeeper RESTful Application Developer's Guide, another document in this document set. Once you have created a QoS template, to load it, do the following.

  1. Select the MBean wlng_nt_qos#5.1.0.0 and select the plug-in instance you wish to configure.

  2. Expand QoSMBean and select loadQoSRequestTemplate.

  3. In the MatchRule text box, enter a regular expression that matches the end user identifiers you want associated with the QoS template.

  4. In the Content text box, paste in the contents of a valid QoS template.

  5. Execute the MBean operation.

The QoS template is loaded and available for use. See "Operation: loadQoSRequestTemplate()" for more details.

Retrieve an Existing QoS Template

To retrieve an existing QoS template, do the following.

  1. Select the MBean wlng_nt_qos#5.1.0.0 and select the plug-in instance you wish to configure.

  2. Expand QoSMBean and select retrieveQoSRequestTemplate.

  3. In the MatchRule text box, enter a regular expression that matches the end user identifiers you have associated with a QoS template. If you are not sure which MatchRules are defined, you can use the listQoSRequestTemplateMatchRules operation.

  4. Execute the MBean operation.

The QoS template is returned in the Output text box. See "Operation: retrieveQoSRequestTemplate()" for more details.

List Match Rules for a QoS Template

To list match rules for a QoS template, do the following.

  1. Select the MBean wlng_nt_qos#5.1.0.0 and select the plug-in instance you wish to configure.

  2. Expand QoSMBean and select listQoSRequestTemplateMatchRules.

  3. Execute the MBean operation.

The MatchRules configured for the plug-in are returned in the Output text box. See "Operation: listQoSRequestTemplateMatchRule()" for more details.

Delete a QoS Template

To delete a QoS template, do the following.

  1. Select the MBean wlng_nt_qos#5.1.0.0 and select the plug-in instance you wish to configure using the Administration Console or an MBean browser.

  2. Expand QoSMBean and select deleteQoSRequestTemplate.

  3. In the MatchRule text box, enter a regular expression that matches the end user identifiers associated with the QoS template you want to delete.

  4. Execute the MBean operation.

The QoS template is deleted. See "Operation: deleteQoSRequestTemplate()" for more details.

Reference: Attributes and Operations for QoS

This section describes the attributes and operations for the configuration and maintenance of the QoS communication service:

Attribute: DestinationHost

Scope: Shared

Unit: Not applicable

Format: String

The host name of the PCRF diameter server.

Valid values are either a host name or a regular expression matching a host name. The default value is host.destination.com.

Attribute: DestinationPort

Scope: Shared

Unit: Not applicable

Format: Integer

Port number of the PCRF diameter server.

Valid values are 065535. The default value is 3588.

Attribute: DestinationRealm

Scope: Shared

Unit: Not applicable

Format: String

Diameter destination realm used for requests.

Valid values are either a realm or a regular expression matching a realm. The default value is destination.com.

Attribute: OriginHost

Scope: Local

Unit: Not applicable

Format: String

Host name of the machine running the QoS plug-in.

Valid values are either a host name or a regular expression matching a host name. The default value is host.origin.com.

Attribute: OriginPort

Scope: Local

Unit: Not applicable

Format: Integer

Port number of the machine running the QoS plug-in.

Valid values are 065535. A value of 0 indicates a random port and should be used when upgrading the plug-in. The default value is 0.

Attribute: OriginRealm

Scope: Local

Unit: Not applicable

Format: String

Diameter originating realm used for requests.

Valid values are either a realm or a regular expression matching a realm. The default value is origin.com.

Attribute: Connected

Scope: Local

Unit: Not applicable

Format: Boolean

Boolean value indicating whether the plug-in is connected.

Valid values are true or false. The default value false.

Operation: connect()

Scope: Local

Connects the QoS plug-in to the PCRF diameter server. If the plug-in is already connected, it will first be disconnected and then reconnected using the current parameters.

Signature:

connect()

Operation: disconnect()

Scope: Local

Disconnects the QoS plug-in from the PCRF diameter server. If the plug-in is not currently connected, no action is taken.

Signature:

disconnect()

Operation: loadQoSRequestTemplate()

Scope: Shared

This operation loads a QoS template for use with the template-based QoS interfaces.

The MatchRule parameter is a regular expression that determines to which subscriber IDs the QoS template will apply. For example a MatchRule value of tel:1234* will match any subscriber whose ID begins with tel:1234.

The Content parameter takes a template formatted according to the XSD found in the xsd subdirectory in the plugin_qos_diameter.jar file which itself is contained within the wlng_nt_qos.ear archive located in Middleware_Home/ocsg_5.1/applications directory.

For more information on QoS templates, see the section “Template-based Apply QoS” in the Oracle Communications Services Gatekeeper RESTful Application Developer's Guide, another document in this document set.

Signature:

loadQoSRequestTemplate(MatchRule: String, Content: XML)

Table 2-3 lists the parameters that the loadQoSRequestTemplate operation accepts.

Table 2-3 loadQoSRequestTemplate Parameters

Parameter Description

MatchRule

Literal or regular expression matching one or more subscriber IDs.

Content

A valid QoS template.


Operation: retrieveQoSRequestTemplate()

Scope: Local

This operation retrieves a QoS template associated with a particular subscriber ID or a range of subscriber IDs defined by the MatchRule parameter.

The MatchRule parameter is a regular expression that determines to which subscriber IDs the QoS template is applied. For example a MatchRule value of tel:1234* will match any subscriber whose ID begins with tel:1234.

Signature:

retrieveQoSRequestTemplate(MatchRule: String)

Table 2-4 lists the parameters that the retrieveQoSRequestTemplate operation accepts.

Table 2-4 retrieveQoSRequestTemplate Parameters

Parameter Description

MatchRule

Literal or regular expression matching one or more subscriber IDs.


Operation: listQoSRequestTemplateMatchRule()

Scope: Local

This operation lists all of the match rules that have been defined for the plug-in.

Signature:

listQoSRequestTemplateMatchRule()

Operation: deleteQoSRequestTemplate()

Scope: Shared

This operation deletes a QoS template associated with a particular subscriber ID or a range of subscriber IDs defined by the MatchRule parameter.

The MatchRule parameter is a regular expression that determines to which subscriber IDs the QoS template is applied. For example a MatchRule value of tel:1234* will match any subscriber whose ID begins with tel:1234.

Signature:

deleteQoSRequestTemplate(MatchRule: String)

Table 2-5 lists the operations that the deleteQoSRequestTemplate operation accepts.

Table 2-5 retrieveQoSRequestTemplate Parameters

Parameter Description

MatchRule

Literal or regular expression matching one or more subscriber IDs.