Contents

Title and Copyright Information

Preface

• Audience
• Related Documents
• Documentation Accessibility

Part I Configuring Converged Application Server

1 Overview of the Converged Application Server Architecture

• Goals of the Converged Application Server Architecture
• Load Balancer
• Engine Tier
• SIP Data tier
  • Example of Writing and Retrieving Call State Data
  • RDBMS Storage for Long-Lived Call State Data
• Geographically-Redundant Installations
• Example Hardware Configurations
• Alternate Configurations

2 Overview of Converged Application Server Configuration and Management

• Shared Configuration Tasks for Converged Application Server and WebLogic Server
• Converged Application Server Configuration Overview
  • Diameter Configuration
• Methods and Tools for Performing Configuration Tasks
  • Administration Console
  • WebLogic Scripting Tool (WLST)
  • Additional Configuration Methods
    • Editing Configuration Files
    • Custom JMX Applications
• Common Configuration Tasks

3 Configuring SIP Data Tier Partitions and Replicas

• Overview of SIP Data Tier Configuration
  • datatier.xml Configuration File
  • Configuration Requirements and Restrictions
• Best Practices for Configuring and Managing SIP Data Tier Servers
• Example SIP Data Tier Configurations and Configuration Files
  • SIP Data Tier with One Partition
  • SIP Data Tier with Two Partitions
  • SIP Data Tier with Two Partitions and Two Replicas
• Monitoring and Troubleshooting SIP Data Tier Servers

4 Provisioning Users With Sash

• Overview of Sash
• Launching Sash
  • Launching Sash from the Command Line
  • Connecting Sash to an External Converged Application Server Instance
    • Connecting to an External Instance of Converged Application Server
• Using Sash
  • Viewing Available Commands
    • Viewing Subcommands
• Creating a User
  • Creating a User from the Sash Command-Line Prompt
  • Creating a User with the Command Service MBean
  • Creating a User with the Identity Add Command
• Deleting a User
• Scripting with Sash
• Error Logging in Sash

5 Storing Long-Lived Call State Data in an RDBMS

• Overview of Long-Lived Call State Storage
• Requirements and Restrictions
• Steps for Enabling RDBMS Call State Storage
• Using the Configuration Wizard RDBMS Store Template
  • Modify the JDBC Datasource Connection Information
• Configuring RDBMS Call State Storage
  • Configure JDBC Resources
  • Configure Converged Application Server Persistence Options
  • Create the Database Schema
• Using Persistence Hints in SIP Applications

6 Configuring Geographically-Redundant Installations

• Introducing Geographic Redundancy
  • Situations Best Suited to Use Geo-Redundancy
  • Situations Not Suited to Use Geo-Redundancy
  • Geo-Redundancy Considerations
• Using Geographically-Redundant SIP Data Tiers
  • Example Domain Configurations
• Requirements and Limitations
• Steps for Configuring Geographic Persistence
• Using the Configuration Wizard Templates for Geographic Persistence
  • Installing and Configuring the Primary Site
  • Installing the Secondary Site
• Manually Configuring Geographic Redundancy
  • Configuring JDBC Resources (Primary and Secondary Sites)
  • Configuring Persistence Options (Primary and Secondary Sites)
  • Configuring JMS Resources (Secondary Site Only)
• Understanding Geo-Redundant Replication Behavior
  • Call State Replication Process
  • Call State Processing After Failover
• Removing Backup Call States
• Monitoring Replication Across Regional Sites
• Troubleshooting c Replication

7 Using the Engine Tier Cache

• Overview of Engine Tier Caching
• Configuring Engine Tier Caching
• Monitoring and Tuning Cache Performance

8 Configuring Engine Tier Container Properties

• Overview of SIP Container Configuration
• Using the Administration Console to Configure Container Properties
  • Locking and Persisting the Configuration
• Configuring Container Properties Using WLST (JMX)
  • Managing Configuration Locks
  • Configuration MBeans for the SIP Servlet Container
  • Locating the Converged Application Server MBeans
• WLST Configuration Examples
  • Invoking WLST
  • WLST Template for Configuring Container Attributes
  • Creating and Deleting MBeans
  • Working with URI Values
• Reverting to the Original Boot Configuration
• Configuring the Proxy Registrar
  • Setting Authentication for the Proxy Registrar
    • Using the Administration Console to Configure Trusted Hosts
  • Configuring the Proxy
  • Configuring the Registrar
• Configuring Timer Processing
  • Configuring Timer Affinity (Optional)
  • Configuring NTP for Accurate SIP Timers
• Configuring the JSR 309 Media Server Control Driver
  • Install the Media Server Control Driver
  • Configure the JSR 309 Resource for the Media Server Control Driver
    • Configure the JSR 309 Resource for Proxy Registrar Domains
    • Configure the JSR 309 Resource for Administration and Replicated Domains
  • Configure the Media Server Control Factory

9 Improving Failover Performance for Physical Network Failures

• Overview of Failover Detection
  • WlssEchoServer Failure Detection
  • Forced Shutdown for Failed Replicas
• WlssEchoServer Requirements and Restrictions
• Starting WlssEchoServer on SIP Data Tier Server Machines
• Enabling and Configuring the Heartbeat Mechanism on Servers

10 Upgrading WebLogic SIP Server 3.x to Converged Application Server 4.0

• About the Upgrade Process
• Step 1: Install Software and Prepare Domain
• Step 2: Upgrade Version 3.x Domain Artifacts

11 Upgrading From Converged Application Server Release 4.0 to Converged Application Server Release 5.0

• About the Upgrade Process
• Step 1: Install Software and Prepare the Domain
• Step 2: Upgrade Version 4.0 Domain Artifacts

12 Tuning JVM Garbage Collection for Production Deployments

• Goals for Tuning Garbage Collection Performance
• Modifying JVM Parameters in Server Start Scripts
• Tuning Garbage Collection with JRockit
  • Using Oracle JRockit Real Time (Deterministic Garbage Collection)
  • Using Oracle JRockit without Deterministic Garbage Collection
• Tuning Garbage Collection with Sun JDK

13 Avoiding JVM Delays Caused By Random Number Generation

• Avoiding JVM Delays Caused by Random Number Generation

Part II Converged Application Server Operations

14 Starting and Stopping Servers

• Startup Sequence for a Converged Application Server Domain
• Administration Server Best Practices

15 Configuring SNMP

• Overview of Converged Application Server SNMP
• Browsing the MIB
• Configuring SNMP
• Understanding and Responding to SNMP Traps
  • Files for Troubleshooting
  • Trap Descriptions
    • connectionLostToPeer
      • Recovery Procedure
    • connectionReestablishedToPeer
      • Recovery Procedure
    • dataTierServerStopped
      • Recovery Procedure
    • overloadControlActivated, overloadControlDeactivated
      • Recovery Procedure
      • Additional Overload Information
    • replicaAddedToPartition
      • Recovery Procedure
    • replicaRemovedEnginesRegistration
      • Recovery Procedure
    • replicaRemovedFromPartition
      • Recovery Procedure
    • serverStopped
      • Recovery Procedure
      • Additional Shutdown Information
    • sipAppDeployed
      • Recovery Procedure
    • sipAppUndeployed
      • Recovery Procedure
    • sipAppFailedToDeploy
      • Recovery Procedure

16 Using the WebLogic Server Diagnostic Framework (WLDF)

• Overview of Converged Application Server and the WLDF
• Data Collection and Logging
• Watches and Notifications
• Image Capture
• Instrumentation
  • Configuring Server-Scoped Monitors
  • Configuring Application-Scoped Monitors

17 Logging SIP Requests and Responses

• Overview of SIP Logging
• Defining Logging Servlets in sip.xml
• Configuring the Logging Level and Destination
• Specifying the Criteria for Logging Messages
  • Using XML Documents to Specify Logging Criteria
  • Using Servlet Parameters to Specify Logging Criteria
• Specifying Content Types for Unencrypted Logging
• Enabling Log Rotation and Viewing Log Files
• trace-pattern.dtd Reference
• Adding Tracing Functionality to SIP Servlet Code
• Order of Startup for Listeners and Logging Servlets

18 Upgrading Deployed SIP Applications

• Overview of SIP Application Upgrades
• Requirements and Restrictions for Upgrading Deployed Applications
• Steps for Upgrading a Deployed SIP Application
• Assign a Version Identifier
  • Defining the Version in the Manifest
• Deploy the Updated Application Version
• Undeploy the Older Application Version
• Roll Back the Upgrade Process
• Accessing the Application Name and Version Identifier
• Using Administration Mode

19 Avoiding and Recovering From Server Failures

• Failure Prevention and Automatic Recovery Features
  • Overload Protection
  • Redundancy and Failover for Clustered Services
  • Automatic Restart for Failed Server Instances
  • Managed Server Independence Mode
  • Automatic Migration of Failed Managed Servers
  • Geographic Redundancy for Regional Site Failures
• Directory and File Backups for Failure Recovery
  • Enabling Automatic Configuration Backups
  • Storing the Domain Configuration Offline
  • Backing Up Server Start Scripts
  • Backing Up Logging Servlet Applications
  • Backing Up Security Data
    • Backing Up the WebLogic LDAP Repository
    • Backing Up SerializedSystemIni.dat and Security Certificates
  • Backing Up Additional Operating System Configuration Files
• Restarting a Failed Administration Server
  • Restarting an Administration Server on the Same Machine
  • Restarting an Administration Server on Another Machine
• Restarting Failed Managed Servers

20 Upgrading Converged Application Server Software

• Overview of System Upgrades
• Requirements for Upgrading a Production System
• Upgrading to a New Version of Converged Application Server
  • Configure the Load Balancer
  • Configure the New Engine Tier Cluster
  • Define the Cluster-to-Load Balancer Mapping
  • Duplicate the SIP Servlet Configuration
  • Upgrade Engine Tier Servers and Target Applications to the New Cluster
  • Upgrade SIP Data Tier Servers
• Applying Software Patches and Updates
  • Applying Patches with Ant

Part III Configuring Network Resources

21 Managing Network Resources

• Overview of Network Configuration
  • IPv4 and IPv6
• Configuring Load Balancer Addresses
  • Multiple Load Balancers and Multihomed Load Balancers
• Enabling DNS Support
• Configuring Network Channels for SIP or SIPS
  • Reconfiguring an Existing Channel
  • Creating a New SIP or SIPS Channel
• Configuring Custom Timeout, MTU, and Other Properties
• Configuring SIP Channels for Multihomed Machines
• Configuring TCP and TLS Channels for Diameter Support
• Configuring Engine Servers to Listen on Any IP Interface
• Configuring Unique Listen Address Attributes for SIP Data Tier Replicas

22 Production Network Architectures and Configuration

• Overview
• Single-NIC Configurations with TCP and UDP Channels
  • Static Port Configuration for Outbound UDP Packets
• Multihomed Server Configurations Overview
• Multihomed Servers Listening On All Addresses (IP_ANY)
• Multihomed Servers Listening on Multiple Subnets
  • Understanding the Route Resolver
  • IP Aliasing with Multihomed Hardware
• Load Balancer Configurations
  • Single Load Balancer Configuration
  • Multiple Load Balancers and Multihomed Load Balancers
  • Network Address Translation Options
    • IP Masquerading Alternative to Source NAT

23 Example Network Configuration

• Overview
• Example Network Topology
• Converged Application Server Configuration
• Load Balancer Configuration
  • NAT-based Configuration
  • maddr-based Configuration
  • rport-based Configuration

24 Configuring Diameter Client Nodes and Relay Agents

• Overview of Diameter Protocol Configuration
• About the Diameter Domain Template
• Steps for Configuring Diameter Client Nodes and Relay Agents
• Installing the Diameter Domain Template
• Enabling the Diameter Console Extension
• Creating TCP, TLS, and SCTP Network Channels for the Diameter Protocol
  • Configuring Two-Way SSL for Diameter TLS Channels
  • Configuring and Using SCTP for Diameter Messaging
• Configuring Diameter Nodes
  • Creating a New Node Configuration (General Node Configuration)
  • Configuring Diameter Applications
    • Configuring the Sh Client Application
    • Configuring the Rf Client Application
    • Configuring the Ro Client Application
    • Configuring a Diameter Relay Agent
    • Configuring the Sh and Rf Simulator Applications
    • Enabling Profile Service (Using an Sh Backend)
  • Configuring Peer Nodes
  • Configuring Routes
• Example Domain Configuration
• Troubleshooting Diameter Configurations

Part IV Configuring Converged Application Server Security

25 Overview of Security Features

• Authentication for SIP Servlets
  • Authentication Providers
• Overriding Authentication with Trusted Hosts
• Identity Assertion Support
• Role Assignment for SIP Servlet Declarative Security
• Security Event Auditing
• Common Security Configuration Tasks

26 Configuring Digest Authentication

• Overview of Digest Authentication
  • What Is Digest Authentication?
  • Digest Authentication Support in Converged Application Server
• Prerequisites for Configuring LDAP Digest Authentication
• Steps for Configuring Digest Authentication
  • Configure the LDAP Server or RDBMS
    • Using Unencrypted Passwords
    • Using Precalculated Hash Values
    • Using Reverse-Encrypted Passwords
  • Reconfigure the DefaultAuthenticator Provider
  • Configure an Authenticator Provider
  • Configure a New Digest Identity Asserter Provider
    • Configure an LDAP Digest Identity Asserter Provider
    • Configure an RDBMS Digest Identity Asserter Provider
• Sample Digest Authentication Configuration Using Embedded LDAP
  • Store User Password Information in the Description Field
  • Set the Embedded LDAP Password
  • Configure the Digest Identity Asserter Provider

27 Configuring Client-Cert Authentication

• Overview of Client-Cert Authentication
• Configuring SSL and X509 for Converged Application Server
  • Configuring the Default Identity Asserter
  • Configuring the LDAP X509 Identity Asserter
• Configuring Converged Application Server to Use WL-Proxy-Client-Cert
• Supporting Perimeter Authentication with a Custom IA Provider

28 Configuring Identity Assertion for SIP Servlets

• Overview of SIP Servlet Identity Assertion Mechanisms
• Understanding Trusted Host Forwarding with P-Asserted-Identity
• Overview of Strict and Non-Strict P-Asserted-Identity Asserter Providers
• Configuring a P-Asserted-Identity Assertion Provider
• Understanding Identity Assertion with the Identity and Identity-Info Headers
• Configuring the Identity Header Assertion Provider

29 Configuring 3GPP HTTP Authentication Providers

• Overview
• Configuring a X-3GPP-Asserted-Identity Provider

Part V Converged Application Server Configuration File Reference

30 Engine Tier Configuration Reference (sipserver.xml)

• Overview of sipserver.xml
• Editing sipserver.xml
  • Steps for Editing sipserver.xml
• XML Schema
• Example sipserver.xml File
• XML Element Description
  • enable-timer-affinity
  • overload
    • Selecting an Appropriate Overload Policy
    • Overload Control Based on Session Generation Rate
    • Overload Control Based on Capacity Constraints
    • Two Levels of Overload Protection
  • message-debug
  • proxy—Setting Up an Outbound Proxy Server
  • t1-timeout-interval
  • t2-timeout-interval
  • t4-timeout-interval
  • timer-b-timeout-interval
  • timer-f-timeout-interval
  • max-application-session-lifetime
  • enable-local-dispatch
  • cluster-loadbalancer-map
  • default-behavior
  • default-servlet-name
  • retry-after-value
  • sip-security
  • route-header
  • engine-call-state-cache-enabled
  • server-header
  • server-header-value
  • persistence
  • use-header-form
  • enable-dns-srv-lookup
  • connection-reuse-pool
  • globally-routable-uri
  • domain-alias-name
  • enable-rport
  • image-dump-level
  • stale-session-handling
  • enable-contact-provisional-response
  • app-router
  • use-custom-app-router
  • app-router-config-data
  • custom-app-router-jar-file-name
  • default-application-name

31 SIP Data Tier Configuration Reference (datatier.xml)

• Overview of datatier.xml
• Editing datatier.xml
• XML Schema
• Example datatier.xml File
• XML Element Description

32 Diameter Configuration Reference (diameter.xml)

• Overview of diameter.xml
• Graphical Representation
• Editing diameter.xml
  • Steps for Editing diameter.xml
• XML Schema
• Example diameter.xml File
• XML Element Description
  • configuration
  • target
  • host
  • realm
  • address
  • port
  • tls-enabled
  • sctp-enabled
  • debug-enabled
  • message-debug-enabled
  • application
    • class-name
    • param*
      • name
      • value
  • peer-retry-delay
  • allow-dynamic-peers
  • request-timeout
  • watchdog-timeout
  • supported-vendor-id+
  • include-origin-state
  • peer+
    • host
    • address
    • port
    • protocol
  • route
    • realm
    • application-id
    • action
    • server+
  • default-route
    • action
    • server+

33 Profile Service Provider Configuration Reference (profile.xml)

• Overview of profile.xml
• Graphical Representation
• Editing profile.xml
  • Steps for Editing profile.xml
• XML Schema
• Example profile.xml File
• XML Element Description
  • profile-service
  • mapping
    • map-by
    • map-by-prefix
    • map-by-router
  • provider
    • name
    • provider-class
    • param

34 Startup Command Options

• Startup Command Options