24 Extended Web Services Quality of Service /Diameter

Using Degraded Mode

This communication service offers a degraded mode feature to multi-tier Services Gatekeeper implementations that use databases on standalone systems. Degraded mode allows your implementation to continue processing traffic using Oracle coherence storage in the event that the database becomes unavailable for any reason. Processing time is not degraded, however this is intended as a short-term solution. Your coherence memory is limited and can fill up depending on your request rate and the size of your coherence memory. Once the coherence memory is full, your implementation will no longer process requests.

To use this feature you must configure your Oracle Coherence settings; see "Configuring Coherence to Use Degraded Mode" for details.

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 24-1 illustrates a typical end to end QoS solution:

Figure 24-1 An Example End to End QoS Solution

In Figure 24-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 GGSN or 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.

Event Data Records

Table 24-1 lists IDs of the EDRs created by the Extended Web Services Quality of Service (QoS)/Diameter communication service.

Alarms

For the list of QoS-related alarms, see Services Gatekeeper Alarms Handling Guide.

General Configuration Workflow

The following procedure provides an outline to configure the Extended Web Services Quality of Service (QoS)/Diameter plug-in using the Administration Console or an MBean browser.

1. Select wlng, then PluginManager, and 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#6.0.0.0 and select the plug-in instance you created in step 2.

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

   • Attribute: DestinationHost

   • Attribute: DestinationPort

   • Attribute: DestinationRealm

   • Attribute: OriginHost

   • Attribute: OriginPort

   • Attribute: OriginRealm

   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.

Configuring Coherence to Use Degraded Mode

Degraded mode uses coherence storage for processing in the even that an external database is unavailable. You need to configure the coherence storage cache settings from write-through to use both write-behind and refresh-ahead, and specify the database tables to use for processing.

See "Using Degraded Mode" for a discussion on when to use this option.

See "Caching Data Sources" in Developing Applications with Oracle Coherence for a discussion of the write-through, write-behind, and refresh-ahead options. See ”Managing and Configuring the Storage Service” in Services Gatekeeper System Administrator's Guide for instructions on how to change this setting in Services Gatekeeper.

To configure degraded mode:

1. Open the Gatekeeper_home/modules/com.bea.wlcp.wlng.storage.tc_6.0.0.0.jar/gk-coherence-cache-config.xml file for editing.

2. Configure the coherence cache to use write-behind and refresh-ahead as shown in the example below. This example sets up a write-behind cache with a write-requeue-threshold of 10, a refresh-ahead factor of 0.5, and an expiry-delay of 20 seconds.

       <distributed-scheme>
         <scheme-name>default-wlng-write-behind</scheme-name>
         <service-name>DistributedCache</service-name>
         <backing-map-scheme>
           <read-write-backing-map-scheme>
             <internal-cache-scheme>
               <local-scheme>
                 <scheme-ref>default-rw-local-scheme</scheme-ref>
               </local-scheme>
             </internal-cache-scheme>
             <cachestore-scheme>
               <class-scheme>
                 <scheme-ref>default-db-class-scheme</scheme-ref>
               </class-scheme>
             </cachestore-scheme>
             <read-only>false</read-only>
             <write-delay>20s</write-delay>
             <write-batch-factor>0.2</write-batch-factor>
   
             <write-requeue-threshold>10</write-requeue-threshold>
             <refresh-ahead-factor>0.5</refresh-ahead-factor>
             <expiry-delay>20s</expiry-delay>
   
           </read-write-backing-map-scheme>
         </backing-map-scheme>
         <autostart>true</autostart>
       </distributed-scheme>
   

3. Save and close the file.

4. Open the domain_home/config/stora_schema/com.bea.wlcp.wlng.plugin.qos.diameter.store_5.1.0.0.jar/wlng-cachestore-config-extensions.xml file for writing.

5. Change the table type names for these database tables in the wlng-cachestore-config-extensions.xml file:

   • rest_qos_session_data

   • rest_qos_notification_corres

   • rest_qos_notification_register

   • rest_qos_template

   You need to change the type_id of these tables from wlng.db.wt to wlng.db.wb. For example, change wlng.db.wt.plugin.qos.diameter.session_data to wlng.db.wb.plugin.qos.diameter.session_data.

   Example 24-1 shows these tables with the correct table names:

   Example 24-1 Changing the rest_qos tables in wlng-cachestore-config-extensions.xml

   - <store type_id="wlng.db.wb.plugin.qos.diameter.session_data" db_table_name="rest_qos_session_data">
   - <identifier>
     <classes key-class="java.lang.String" value-class="oracle.ocsg.plugin.qos.diameter.store.AFSessionData" /> 
     </identifier>
     </store>
   - <query name="com.bea.wlcp.wlng.plugin.qos.diameter.SessionDataQuery">
   - <sql>
   - <![CDATA[ SELECT * FROM rest_qos_session_data WHERE sessionId = ?
     ]]> 
     </sql>
     <filter-class>oracle.ocsg.plugin.qos.diameter.store.FilterImpl</filter-class> 
     </query>
   - <query name="com.bea.wlcp.wlng.plugin.qos.diameter.SessionDataQueryByNodeId">
   - <sql>
   - <![CDATA[ SELECT * FROM rest_qos_session_data WHERE nodeid = ?
     ]]> 
     </sql>
     <filter-class>oracle.ocsg.plugin.qos.diameter.store.FilterImpl</filter-class> 
     </query>
   - <db_table name="rest_qos_notification_corres" desc="qos notification correlator">
     <key_column name="correlator" data_type="VARCHAR(255)" desc="correlator" /> 
     <bucket_column name="correlatorData" desc="correlator data" /> 
     </db_table>
   - <store type_id="wlng.db.wb.plugin.qos.diameter.notification.correlator" db_table_name="rest_qos_notification_corres">
   - <identifier>
     <classes key-class="java.lang.String" value-class="oracle.ocsg.plugin.qos.diameter.store.CorrelatorData" /> 
     </identifier>
     </store>
   - <query name="com.bea.wlcp.wlng.plugin.qos.diameter.CorrelatorQuery">
   - <sql>
   - <![CDATA[ SELECT * FROM rest_qos_notification_corres
     ]]> 
     </sql>
     <filter-class>oracle.ocsg.plugin.qos.diameter.store.FilterImpl</filter-class> 
     </query>
   - <db_table name="rest_qos_notification_register" desc="">
   - <multi_key_column name="endUserId" data_type="VARCHAR(255)" desc="">
   - <methods>
     <get_method name="getEndUserId" /> 
     <set_method name="setEndUserId" /> 
     </methods>
     </multi_key_column>
   - <multi_key_column name="eventCriteria" data_type="INT" desc="">
   - <methods>
     <get_method name="getEvent" /> 
     <set_method name="setEvent" /> 
     </methods>
     </multi_key_column>
     <bucket_column name="qoSRegisterData" desc="The register data of the qos notification" /> 
   - <value_column name="correlator" data_type="VARCHAR(255)" desc="correlator from client(parlayRest)">
   - <methods>
     <get_method name="getCorrelator" /> 
     <set_method name="setCorrelator" /> 
     </methods>
     </value_column>
   - <value_column name="endpoint" data_type="VARCHAR(255)" desc="end point">
   - <methods>
     <get_method name="getEndPoint" /> 
     <set_method name="setEndPoint" /> 
     </methods>
     </value_column>
     </db_table>
   - <store type_id="wlng.db.wb.plugin.qos.diameter.qos_register_data" db_table_name="rest_qos_notification_register">
   - <identifier>
     <classes key-class="oracle.ocsg.plugin.qos.diameter.store.QoSEventRegistrationKey" value-class="oracle.ocsg.plugin.qos.diameter.store.QoSEventRegistration" /> 
     </identifier>
     </store>
   - <query name="com.bea.wlcp.wlng.plugin.qos.diameter.NotificationRegisterQueryByCorrelator">
   - <sql>
   - <![CDATA[ SELECT * FROM rest_qos_notification_register WHERE correlator = ?
     ]]> 
     </sql>
     <filter-class>oracle.ocsg.plugin.qos.diameter.store.FilterImpl</filter-class> 
     </query>
   - <db_table name="rest_qos_template" desc="">
   - <multi_key_column name="pluginInstanceId" data_type="VARCHAR(255)" desc="">
   - <methods>
     <get_method name="getPluginId" /> 
     <set_method name="setPluginId" /> 
     </methods>
     </multi_key_column>
   - <multi_key_column name="matchRule" data_type="VARCHAR(255)" desc="">
   - <methods>
     <get_method name="getMatchRule" /> 
     <set_method name="setMatchRule" /> 
     </methods>
     </multi_key_column>
     <bucket_column name="qoSTemplateData" desc="The template data of the apply qos request" /> 
   - <value_column name="content" data_type="BLOB" desc="template configuration in xml style">
   - <methods>
     <get_method name="getContent" /> 
     <set_method name="setContent" /> 
     </methods>
     </value_column>
     </db_table>
   

6. Save and close the file.

7. If the domain is running, stop and restart it.

Managing Extended Web Services Quality of Service Templates

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

• Load a QoS Template

• Retrieve an Existing QoS Template

• List Match Rules for a QoS Template

• Delete a QoS Template

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

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 0–65535. 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 0–65535. 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_6.0/applications directory.

For more information on QoS templates, see the discussion on template-based apply QoS in Services Gatekeeper Application Developer's Guide.

Signature:

loadQoSRequestTemplate(MatchRule: String, Content: XML)

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

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 24-4 lists the parameters that the retrieveQoSRequestTemplate operation accepts.

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 24-5 lists the operations that the deleteQoSRequestTemplate operation accepts.