Contents

Title and Copyright Information

Preface

• Audience
• Related Documents
• Documentation Accessibility

Part I Introduction to Developing Applications for Converged Application Server

1 About Developing Applications for the Converged Application Server

• About Converged Application Server APIs
• About this Book

Part II Developing Applications with the Service Creation Environment

2 Getting Started

• About the Service Creation Environment
  • SCE Workflow Overview
• About Converged Application Projects
  • Converged Application Project Configuration
  • Converged SIP Diameter Project Configuration
• Before Starting
• Enabling Converged Application Server Debug Option
• Installing the Converged Application Service Creation Environment
• Creating a Converged Application Project
• Adding Converged Application Project Facets to an Existing Project
• Creating an Ant Build File
• Deploying SIP Applications from Eclipse

3 Creating Applications with the Converged Application SCE Wizards

• About SCE Wizards
  • About SIP Servlet Templates
• Using the SIP Servlet Wizard
  • Creating a SIP Servlet
  • Creating a SIP Servlet Based on a Template
• Using the SIP Listener Wizard
• Using the SFT Communication Bean Wizard

4 Using Simulators and Other Testing Tools

• About the SCE Tools
• Using the XDMS Simulator
  • Deploying and Starting the XDMS Simulator
  • Using the XCAP Interface to Populate and Query the XDMS
• Configuring the Media Server Driver
• Configuring the Diameter Simulator Settings
• Extending Domains with Diameter Capabilities
• Using the SIPp Plug-in

Part III Developing SIP Applications

5 Overview of SIP Servlet Application Development

• About the SIP Protocol
  • SIP Requests
  • SIP Responses
• What are SIP Servlets?
• Differences Between HTTP Servlets and SIP Servlets
• Differences from HTTP Servlets
  • Multiple Responses
  • Receiving Responses
  • Proxy Functions
  • Message Body
    • Servlet Request
    • Servlet Response
    • SipServletMessage
  • Role of a Servlet Container
    • Application Management
    • SIP Messaging
    • Utility Functions
      • SIP Session, Application Session
      • SIP Factory
      • Proxy

6 Porting Existing Applications to Oracle Communications Converged Application Server

• Application Router and Legacy Application Composition
• SipSession and SipApplicationSession Not Serializable
• SipServletResponse.setCharacterEncoding() API Change
• Transactional Restrictions for SipServletRequest and SipServletResponse
• Immutable Parameters for New Parameterable Interface
• Stateless Transaction Proxies Deprecated
• Backward-Compatibility Mode for v1.0 Deployments
  • Validation Warnings for v1.0 Servlet Deployments
  • Modifying Committed Messages
  • Path Header as System Header
  • SipServletResponse.createPrack() Exception
  • Proxy.proxyTo() Exceptions
  • Changes to Proxy Branch Timers
• Deprecated APIs
• SNMP MIB Changes
• Renamed Diagnostic Monitors and Actions

7 Requirements and Best Practices for SIP Applications

• Overview of Developing Distributed Applications for Converged Application Server
• Applications Must Not Create Threads
• Servlets Must Be Non-Blocking
• Store all Application Data in the Session
• All Session Data Must Be Serializable
• Use setAttribute() to Modify Session Data in “No-Call” Scope
• send() Calls Are Buffered
• Mark SIP Servlets as Distributable
• Use SipApplicationSessionActivationListener Sparingly
• Session Expiration Best Practices
• Observe Best Practices for Java EE Applications
• Optimizing Memory Utilization and Performance with Serialization

8 Using Compact and Long Header Formats for SIP Messages

• Overview of Header Format APIs and Configuration
• Summary of Compact Headers
• Assigning Header Formats with WlssSipServletMessage
• Summary of API and Configuration Behavior

9 Composing SIP Applications

• Using the Application Router
  • Using the Default Application Router
  • Configuring a Custom Application Router
  • Using the Built-in Custom Application Router
    • Configuring the Custom Application Router
• Working with SIP and HTTP Sessions
  • Modifying the SipApplicationSession
    • Synchronous Access
    • Asynchronous Access
• Session Key-Based Request Targeting
• Join and Replaces Header Support
  • About the Join Header
  • About the Replaces Header
  • Enabling Support for Join and Replaces Headers
• API to Set Transport Parameter on Record-Route Header
• Setting Content in SIP Responses

10 Developing Converged Applications

• Overview of Converged Applications
• Assembling and Packaging a Converged Application
• Converged Application Samples

11 Developing Custom Profile Service Providers

• Overview of the Profile Service API
• Implementing Profile Service API Methods
• Configuring and Packaging Profile Providers
  • Mapping Profile Requests to Profile Providers
• Configuring Profile Providers Using the Administration Console

12 Using Content Indirection in SIP Servlets

• Overview of Content Indirection
• Using the Content Indirection API
• Additional Information

13 Securing SIP Servlet Resources

• Overview of SIP Servlet Security
• Triggering SIP Response Codes
• Specifying the Security Realm
• Converged Application Server Role Mapping Features
• Using Implicit Role Assignment
• Assigning Roles Using security-role-assignment
  • Important Requirements
  • Assigning Roles at Deployment Time
  • Dynamically Assigning Roles Using the Administration Console
• Assigning run-as Roles
• Role Assignment Precedence for SIP Servlet Roles
• Debugging Security Features
• weblogic.xml Deployment Descriptor Reference

14 Enabling Message Logging

• Overview
• Enabling Message Logging
  • Specifying a Predefined Logging Level
  • Customizing Log Records
• Specifying Content Types for Unencrypted Logging
• Example Message Log Configuration and Output
• Configuring Log File Rotation

15 Generating SNMP Traps from Application Code

• Overview
• Requirement for Accessing SipServletSnmpTrapRuntimeMBean
• Obtaining a Reference to SipServletSnmpTrapRuntimeMBean
• Generating an SNMP Trap

16 Using the Location Service RESTful Interface

• About the Location Service RESTful Interface
• About REST
• About JSON Body Parameters
• About the Context Root
• Using Authentication and Authorization
• RESTful APIs for the Location Service
  • Store Registrations for Address-of-Record
  • Lookup an Address-of-Record
  • Clear All Address of Record Bindings

Part IV Developing Applications With the Service Foundation Toolkit

17 Introduction to the Service Foundation Toolkit

• The Service Foundation Toolkit Programming Model
• About the Communication Interface
• About Communication Beans
• About Participants
• About SIP Messages and SFT
• About Communication Context Types
• About Agents
• About Media Control
• Searching Communications
• Packaging and Deploying SFT Applications
• SFT Annotations
  • Using the @CommunicationBean Annotation
• About Event Handling
  • Understanding Event Flow
  • Event Walkthrough
  • Using the @CommunicationEvent Annotation
  • About Communication and Participant Events
    • CommunicationEvent Enumeration Types
  • Using the @ParticipantEvent Annotation
    • ParticipantEvent Enumeration Types
• SFT Sample Application

18 Packaging and Deploying SFT Applications

• Structure of a SFT Application
  • Packaging SFT Applications
  • Integrating SFT with SIP Servlets
  • SFT.XML Deployment Descriptor

19 SFT Deployment Descriptor and Schema Reference

• Application-Based Deployment
• XML Schema Definitions and Namespace Declarations
• Annotation-based Configuration
  • Using the @ServiceAttributes Annotation
• About the sft.xml Deployment Descriptor Elements
  • About the communication-bean Element
  • The service-attributes Element
  • Annotation Scanning
  • Overriding Annotations with the SFT.XML Deployment Descriptor
• SFT.XML Schema

20 Event Orchestration in the Service Foundation Toolkit

• About Event Orchestration
• Using Annotations to Define the Invocation Order
• Using XML to Define the Invocation Order
• Filtering and Overriding Communication Beans
  • Filtering Communication Beans
  • Filtering Specific Communication Bean Annotations
  • Overriding CommunicationBean Annotations

21 Implementing Call Control Services

• About Converged Application Framework and VoLTE
• Call Forwarding
  • Accessing Call Forwarding History
  • Discovering Call Reject Reasons
  • Call Forwarding Example
• Call Barring
• Communication Hold
  • Setting the Communication Hold Bandwidth
• Identity Presentation and Restriction
  • Identity Presentation and Restriction Interfaces
  • Privacy Service Behavior
  • Enabling User-Level Privacy
  • Providing Privacy for the History-Info Header
• Communication Waiting
  • Supporting Network- and Terminal-based Communication Waiting
    • About Network-based Communication Waiting
    • About Terminal-based Communication Waiting
  • About the Communication Waiting Interfaces
  • Creating a Communication Waiting Application
  • CallWaitingBean Example Code
• Message Waiting Indication
  • Configuring Message Waiting Indication
  • About the Message Waiting Indication Interfaces
  • Creating a Message Waiting Indication Application
    • Sending MWI Notifications to Subscribers
    • Removing a Subscription
  • Message Waiting Indication Example

22 Using Announcements

• About Announcements
• APIs for Announcement Support
  • MediaPartner
  • CommunicationEvent Enumeration Types
  • ParticipantEvent Enumeration Types
• About the MediaPartner and UserPartner Interfaces
• Callout Announcement
• Call Barring Announcement
  • Call Barring Announcement Using Error-Info
  • Call Barring Announcement Using Early Media
  • Playing a Call Barring Announcement With Established Sessions
• Playing a Colorful Ring Tone
• Playing Colorful Ring Back Tone
  • Colorful Ring Back Tone by Alert-Info
  • Colorful Ring Back Tone Without Early Media Exchange
  • CRBT After Early Media Exchange
• Playing a Call Rejection Announcement
  • Call Rejection Using Error-Info
  • Call Rejection Announcements Using Early Media
• Call Forwarding Announcements
  • Un-Conditional Call Forwarding Announcement
  • Conditional Call Forwarding
• Call Waiting Announcement
  • Call Waiting Announcement Using ALERT-INFO
  • Call Waiting Announcement Using Early Media
• Pickup Announcement

23 Conferencing With Media Control

• Conferencing with Media Control
  • About the Conferencing and Media Control Interfaces
  • Creating a Conference With the Focus Interface
  • Creating Conferences Using Resource-Contained Lists
• Ad-Hoc Conferencing
  • Configuring the Conference Event Package
  • Handling Subscription and Notification Events
    • Handling Conference Subscription Events
    • Handling Conference Notification Events

24 Using the XCAP Interfaces

• About XCAP and VoLTE
• Creating and Accessing an XCAP Client
• Fetching, Creating, and Deleting Resources With XCAP
  • Fetching Documents from the XDMS
  • Creating or Replacing Documents in the XDMS
  • Deleting a Document from the XDMS
• Using XCAP for IR.92 Supplementary Services
  • XCAP Supplementary Service APIs
  • Creating Supplementary Service Rules
• Adding and Editing Elements
• Validating Data
• XCAP Authentication and Authorization
  • Using Digest Authentication
  • Using Transport Layer Security
  • Using X-3GPP-Asserted-Identity Header Authentication

25 Creating Instant Messaging and Rich Media Services

• About Rich Communication Services
• Discovering Device Capability
  • About the Capability Discovery Interfaces
  • Using the Capability Discovery Interfaces
• Using In-dialog, SIP Options-based Capability Discovery
• Using End User Confirmation Request
  • About the EUCR Interfaces
  • Using EUCR in Response to a File Transfer
• Conferencing Using MSRP
• Using Instant Message Disposition Notification
  • About the IMDN Interfaces
  • Creating an Instant Message with IMDN Request
  • Creating an IMDN With CommunicationBean