Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

Part I Introduction

1 Overview of SIP Servlet Application Development

• 1.1 What is a SIP Servlet?
• 1.2 SIP Servlets Versus HTTP Servlets
  • 1.2.1 Multiple Responses
  • 1.2.2 Receiving Responses
  • 1.2.3 Proxy Functions
  • 1.2.4 Message Body
    • 1.2.4.1 Servlet Request
    • 1.2.4.2 Servlet Response
    • 1.2.4.3 SipServletMessage
  • 1.2.5 Role of a Servlet Container
    • 1.2.5.1 Application Management
    • 1.2.5.2 SIP Messaging
    • 1.2.5.3 Utility Functions

Part II Developing and Programming SIP Applications

2 Developing Converged Applications

• 2.1 Overview of Converged Applications
• 2.2 Assembling and Packaging a Converged Application
• 2.3 Working with SIP and HTTP Sessions
  • 2.3.1 Modifying the SipApplicationSession
    • 2.3.1.1 Synchronous Access
    • 2.3.1.2 Asynchronous Access
• 2.4 Using the Converged Application Example

3 SIP Protocol Programming

• 3.1 Using Compact and Long Header Formats for SIP Messages
  • 3.1.1 Overview of Header Format APIs and Configuration
  • 3.1.2 Summary of Compact Headers
  • 3.1.3 Assigning Header Formats with WlssSipServletMessage
  • 3.1.4 Summary of API and Configuration Behavior
• 3.2 Using Content Indirection in SIP Servlets
  • 3.2.1 Overview of Content Indirection
  • 3.2.2 Using the Content Indirection API
  • 3.2.3 Additional Information
• 3.3 Generating SNMP Traps from Application Code
  • 3.3.1 Overview
  • 3.3.2 Requirement for Accessing SipServletSnmpTrapRuntimeMBean
  • 3.3.3 Obtaining a Reference to SipServletSnmpTrapRuntimeMBean
  • 3.3.4 Generating an SNMP Trap

4 Requirements and Best Practices for SIP Applications

• 4.1 Overview of Developing Distributed Applications
• 4.2 Applications Must Not Create Threads
• 4.3 Servlets Must Be Non-Blocking
• 4.4 Store all Application Data in the Session
• 4.5 All Session Data Must Be Serializable
• 4.6 Use setAttribute() to Modify Session Data in “No-Call” Scope
• 4.7 send() Calls Are Buffered
• 4.8 Mark SIP Servlets as Distributable
• 4.9 Use SipApplicationSessionActivationListener Sparingly
• 4.10 Session Expiration Best Practices
• 4.11 Observe Best Practices for Java EE Applications

5 Composing SIP Applications

• 5.1 Application Composition Model
• 5.2 Using the Default Application Router
• 5.3 Configuring a Custom Application Router
• 5.4 Session Key-Based Request Targeting

6 Securing SIP Servlet Resources

• 6.1 Overview of SIP Servlet Security
• 6.2 Triggering SIP Response Codes
• 6.3 Specifying the Security Realm
• 6.4 Role Mapping Features
• 6.5 Using Implicit Role Assignment
• 6.6 Assigning Roles Using security-role-assignment
  • 6.6.1 Important Requirements
  • 6.6.2 Assigning Roles at Deployment Time
  • 6.6.3 Dynamically Assigning Roles Using the Administrative Console
• 6.7 Assigning run-as Roles
• 6.8 Role Assignment Precedence for SIP Servlet Roles
• 6.9 Debugging Security Features
• 6.10 weblogic.xml Deployment Descriptor Reference

7 Enabling Message Logging

• 7.1 Overview
• 7.2 Enabling Message Logging
  • 7.2.1 Specifying a Predefined Logging Level
  • 7.2.2 Customizing Log Records
• 7.3 Specifying Content Types for Unencrypted Logging
• 7.4 Example Message Log Configuration and Output
• 7.5 Configuring Log File Rotation

Part III Using Diameter

8 Using the Diameter Base Protocol API

• 8.1 Diameter Protocol Packages
• 8.2 Overview of the Diameter API
  • 8.2.1 File Required for Compiling Application Using the Diameter API
• 8.3 Working with Diameter Nodes
• 8.4 Implementing a Diameter Application
• 8.5 Working with Diameter Sessions
• 8.6 Working with Diameter Messages
  • 8.6.1 Sending Request Messages
  • 8.6.2 Sending Answer Messages
  • 8.6.3 Creating New Command Codes
• 8.7 Working with AVPs
  • 8.7.1 Creating New Attributes
• 8.8 Creating Converged Diameter and SIP Applications

9 Using the Profile Service API

• 9.1 Overview of Profile Service API and Sh Interface Support
• 9.2 Enabling the Sh Interface Provider
• 9.3 Overview of the Profile Service API
• 9.4 Creating a Document Selector Key for Application-Managed Profile Data
• 9.5 Using a Constructed Document Key to Manage Profile Data
• 9.6 Monitoring Profile Data with ProfileListener
  • 9.6.1 Prerequisites for Listener Implementations
  • 9.6.2 Implementing ProfileListener

10 Developing Custom Profile Service Providers

• 10.1 Overview of the Profile Service API
• 10.2 Implementing Profile Service API Methods
• 10.3 Configuring and Packaging Profile Providers
  • 10.3.1 Mapping Profile Requests to Profile Providers
• 10.4 Configuring Profile Providers Using the Administration Console

11 Using the Diameter Rf Interface API for Offline Charging

• 11.1 Overview of Rf Interface Support
• 11.2 Understanding Offline Charging Events
  • 11.2.1 Event-Based Charging
  • 11.2.2 Session-Based Charging
• 11.3 Configuring the Rf Application
• 11.4 Using the Offline Charging API
  • 11.4.1 Accessing the Rf Application
  • 11.4.2 Implementing Session-Based Charging
    • 11.4.2.1 Specifying the Session Expiration
    • 11.4.2.2 Sending Asynchronous Events
  • 11.4.3 Implementing Event-Based Charging
  • 11.4.4 Using the Accounting Session State

12 Using the Diameter Ro Interface API for Online Charging

• 12.1 Overview of Ro Interface Support
• 12.2 Understanding Credit Authorization Models
  • 12.2.1 Credit Authorization with Unit Determination
  • 12.2.2 Credit Authorization with Direct Debiting
  • 12.2.3 Determining Units and Rating
• 12.3 Configuring the Ro Application
• 12.4 Overview of the Online Charging API
• 12.5 Accessing the Ro Application
• 12.6 Implementing Session-Based Charging
  • 12.6.1 Handling Re-Auth-Request Messages
• 12.7 Sending Credit-Control-Request Messages
• 12.8 Handling Failures

Part IV Reference

A Profile Service Provider Configuration Reference (profile.xml)

• A.1 Overview of profile.xml
• A.2 Graphical Representation
• A.3 Editing profile.xml
  • A.3.1 Steps for Editing profile.xml
• A.4 XML Schema
• A.5 Example profile.xml File
• A.6 XML Element Description
  • A.6.1 profile-service
  • A.6.2 mapping
    • A.6.2.1 map-by
    • A.6.2.2 map-by-prefix
    • A.6.2.3 map-by-router
  • A.6.3 provider
    • A.6.3.1 name
    • A.6.3.2 provider-class
    • A.6.3.3 param

B Developing SIP Servlets Using Eclipse

• B.1 Overview
  • B.1.1 SIP Servlet Organization
• B.2 Setting Up the Development Environment
  • B.2.1 Creating a Oracle WebLogic Server SIP Container Domain
  • B.2.2 Verifying the Default Eclipse JVM
  • B.2.3 Creating a New Eclipse Project
• B.3 Building and Deploying the Project
• B.4 Debugging SIP Servlets

C Porting Existing Applications to Oracle WebLogic Server SIP Container

• C.1 Application Router and Legacy Application Composition
• C.2 SipSession and SipApplicationSession Not Serializable
• C.3 SipServletResponse.setCharacterEncoding() API Change
• C.4 Transactional Restrictions for SipServletRequest and SipServletResponse
• C.5 Immutable Parameters for New Parameterable Interface
• C.6 Stateless Transaction Proxies Deprecated
• C.7 Backward-Compatibility Mode for v1.0 Deployments
  • C.7.1 Validation Warnings for v1.0 Servlet Deployments
  • C.7.2 Modifying Committed Messages
  • C.7.3 Path Header as System Header
  • C.7.4 SipServletResponse.createPrack() Exception
  • C.7.5 Proxy.proxyTo() Exceptions
  • C.7.6 Changes to Proxy Branch Timers
• C.8 Deprecated APIs
• C.9 SNMP MIB Changes
• C.10 Renamed Diagnostic Monitors and Actions

Index