Go to main content
1/36
Contents
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Documents
Conventions
Part I General Configuration
1
Introduction to Oracle WebLogic Communication Services
1.1
Oracle WebLogic Communication Services
1.1.1
Messaging
1.1.2
Telephony
1.1.3
Presence
1.1.4
WebLogic Server 10.3 Platform with support for SIP and converged applications
2
Shared Configuration Tasks
2.1
Shared Configuration Tasks for Oracle WebLogic Communication Services and Oracle WebLogic Server
2.2
Oracle WebLogic Communication Services Configuration Overview
2.2.1
Diameter Configuration
2.3
Methods and Tools for Performing Configuration Tasks
2.3.1
Administration Console
2.3.2
WebLogic Scripting Tool (WLST)
2.3.3
Additional Configuration Methods
2.3.3.1
Editing Configuration Files
2.3.3.2
Custom JMX Applications
2.4
Starting and Stopping Servers
2.5
Administration Server Best Practices
2.6
Common Configuration Tasks
3
Configuring SIP Servlet Container Properties
3.1
Overview of SIP Container Configuration
3.2
Using the Administration Console to Configure Container Properties
3.2.1
Locking and Persisting the Configuration
3.3
Configuring Container Properties Using WLST (JMX)
3.3.1
Managing Configuration Locks
3.3.2
Locating the Oracle WebLogic Communication Services MBeans
3.4
WLST Configuration
3.4.1
Invoking WLST
3.4.2
Creating and Deleting MBeans
3.5
Configuring Timer Processing
3.5.1
Configuring Timer Affinity (Optional)
3.5.2
Configuring NTP for Accurate SIP Timers
4
Managing Network Resources
4.1
Overview of Network Configuration
4.1.1
IPv4 and IPv6
4.2
Configuring Load Balancer Addresses
4.2.1
Multiple Load Balancers and Multi-homed Load Balancers
4.3
Enabling Domain Name Service (DNS) Support
4.4
Configuring Network Channels for SIP or SIPS
4.4.1
Reconfiguring an Existing Channel
4.4.2
Creating a New SIP or SIPS Channel
4.4.3
Configuring Custom Timeout, MTU, and Other Properties
4.4.4
Configuring SIP Channels for Multi-Homed Machines
4.5
Configuring TCP and TLS Channels for Diameter Support
4.6
Configuring Engine Servers to Listen on Any IP Interface
4.7
Configuring Unique Listen Address Attributes for SIP Data Tier Replicas
4.8
Production Network Architectures and Configuration
4.8.1
Single-NIC Configurations with TCP and UDP Channels
4.8.1.1
Static Port Configuration for Outbound UDP Packets
4.8.2
Multi-homed Server Configurations Overview
4.8.3
Multi-homed Servers Listening On All Addresses (IP_ANY)
4.8.4
Multi-homed Servers Listening on Multiple Subnets
4.8.4.1
Understanding the Route Resolver
4.8.4.2
IP Aliasing with Multi-homed Hardware
4.8.5
Load Balancer Configurations
4.8.5.1
Single Load Balancer Configuration
4.8.5.2
Multiple Load Balancers and Multi-homed Load Balancers
4.8.5.3
Network Address Translation Options
4.9
Example Network Configuration
4.9.1
Example Network Topology
4.9.2
Oracle WebLogic Communication Services Configuration
4.9.3
Load Balancer Configuration
4.9.3.1
NAT-based configuration
4.9.3.2
maddr-Based Configuration
4.9.3.3
rport-Based Configuration
5
Administering Security Features
5.1
Authentication for SIP Servlets
5.1.1
Authentication Providers
5.2
Overriding Authentication with Trusted Hosts
5.3
Identity Assertion Support
5.4
Role Assignment for SIP Servlet Declarative Security
5.5
Security Event Auditing
5.6
Common Security Configuration Tasks
5.7
Configuring Digest Authentication
5.7.1
What Is Digest Authentication?
5.7.2
Digest Authentication Support in Oracle WebLogic Communication Services
5.7.3
Prerequisites for Configuring LDAP Digest Authentication
5.7.4
Steps for Configuring Digest Authentication
5.7.4.1
Configure the LDAP Server or RDBMS
5.7.4.2
Reconfigure the DefaultAuthenticator Provider
5.7.4.3
Configure an Authenticator Provider
5.7.4.4
Configure a New Digest Identity Asserter Provider
5.7.5
Sample Digest Authentication Configuration Using Embedded LDAP
5.7.5.1
Store User Password Information in the Description Field
5.7.5.2
Set the Embedded LDAP Password
5.7.5.3
Configure the Digest Identity Asserter Provider
5.8
Configuring Client-Cert Authentication
5.8.1
Configuring SSL and X509 for Oracle WebLogic Communication Services
5.8.1.1
Configuring the Default Identity Asserter
5.8.1.2
Configuring the LDAP X509 Identity Asserter
5.8.2
Configuring Oracle WebLogic Communication Services to Use WL-Proxy-Client-Cert
5.8.3
Supporting Perimeter Authentication with a Custom IA Provider
5.9
Configuring SIP Servlet Identity Assertion Mechanisms
5.9.1
Understanding Trusted Host Forwarding with P-Asserted-Identity
5.9.2
Overview of Strict and Non-Strict P-Asserted-Identity Asserter Providers
5.9.3
Configuring a P-Asserted-Identity Assertion Provider
5.9.4
Understanding Identity Assertion with the Identity and Identity-Info Headers
5.9.5
Configuring the Identity Header Assertion Provider
5.10
Configuring 3GPP HTTP Identity Assertion Providers
5.10.1
Configuring a X-3GPP-Asserted-Identity Provider
5.11
Configuring Basic Authentication for HTTP Servlets
5.12
Provisioning Resources in Oracle Internet Directory
5.12.1
Configuring Oracle Internet Directory
5.12.2
Configuring Static Verifiers
5.12.2.1
Add Oracle WebLogic Communication Services
5.12.2.2
Install the Static Verifier
5.12.3
Add a New Oracle WebLogic Communication Services
5.12.4
Grant Verifier Privileges to the Oracle WebLogic Communication Services Instance
5.13
Provisioning Users
5.13.1
Create a New User
5.13.2
Create a Group
5.13.3
Assign Group Memberships to Users
5.13.4
Set JAAS Realm for Users
5.14
Configuring OWLCS Server Instance
5.14.1
Add an LDAP Authenticator (Setting Up Roles)
5.14.2
Improving LDAP Authenticator Performance
5.14.3
Configuring Userservice to work with OID
6
Configuring SIP Data Tier Partitions and Replicas
6.1
Overview of SIP Data Tier Configuration
6.1.1
datatier.xml Configuration File
6.1.2
Configuration Requirements and Restrictions
6.2
Best Practices for Configuring and Managing SIP Data Tier Servers
6.3
Example SIP Data Tier Configurations and Configuration Files
6.3.1
SIP Data Tier with One Partition
6.3.2
SIP Data Tier with Two Partitions
6.3.3
SIP Data Tier with Two Partitions and Two Replicas
6.4
Storing Long-Lived Call State Data In A RDBMS
6.4.1
Requirements and Restrictions
6.4.2
Steps for Enabling RDBMS Call State Storage
6.4.3
Using the Configuration Wizard RDBMS Store Template
6.4.3.1
Modify the JDBC Datasource Connection Information
6.4.4
Configuring RDBMS Call State Storage by Hand
6.4.4.1
Configure JDBC Resources
6.4.4.2
Configure Oracle WebLogic Communication Services Persistence Options
6.4.4.3
Create the Database Schema
6.4.5
Using Persistence Hints in SIP Applications
6.5
Introducing Geo-Redundancy
6.5.1
Situations Best Suited to Use Geo-Redundancy
6.5.2
Situations Not Suited to Use Geo-Redundancy
6.5.3
Geo-Redundancy Considerations: Before Your Begin
6.6
Using Geographically-Redundant SIP Data Tiers
6.6.1
Example Domain Configurations
6.6.2
Requirements and Limitations
6.6.3
Steps for Configuring Geographic Persistence
6.6.4
Using the Configuration Wizard Templates for Geographic Persistence
6.6.4.1
Installing and Configuring the Primary Site
6.6.4.2
Installing the Secondary Site
6.6.5
Manually Configuring Geographical Redundancy
6.6.5.1
Configuring JDBC Resources (Primary and Secondary Sites)
6.6.5.2
Configuring Persistence Options (Primary and Secondary Sites)
6.6.5.3
Configuring JMS Resources (Secondary Site Only)
6.6.6
Understanding Geo-Redundant Replication Behavior
6.6.6.1
Call State Replication Process
6.6.6.2
Call State Processing After Failover
6.6.7
Removing Backup Call States
6.6.8
Monitoring Replication Across Regional Sites
6.6.9
Troubleshooting Geographical Replication
6.7
Caching SIP Data in the Engine Tier
6.7.1
Configuring Engine Tier Caching
6.7.2
Monitoring and Tuning Cache Performance
6.8
Monitoring and Troubleshooting SIP Data Tier Servers
7
Provisioning Users With Sash
7.1
Overview of Sash
7.2
Launching Sash
7.2.1
Launching Sash from the Command Line
7.2.2
Connecting Sash to an External OWLCS Instance
7.2.2.1
Connecting to an External Instance of OWLCS
7.3
Using Sash
7.3.1
Viewing Available Commands
7.3.1.1
Viewing Subcommands
7.4
Creating a User
7.4.1
Creating a User from the Sash Command-Line Prompt
7.4.2
Creating a User with the Command Service MBean
7.4.3
Creating a User with the Identity Add Command
7.4.3.1
Deleting a User Account with the identity delete Command
7.5
Provisioning the XDMS Using Sash
7.5.1
Provisioning XDMS User Accounts Using the CommandService MBean
7.5.2
Provisioning XDMS User Accounts from the Sash Prompt
7.5.3
Using xcap Commands
7.5.3.1
Provisioning XDMS User Accounts
7.5.3.2
Adding XDMS Users
7.5.3.3
Removing an XDMS User
7.5.3.4
Searching for Application Usage for an XDMS User
7.5.3.5
Listing XDMS Users
7.5.3.6
Provisioning Application Usage
7.5.3.7
Listing All Application Usages
7.6
Scripting with Sash
7.7
Error Logging in Sash
8
Monitoring and Troubleshooting
8.1
Avoiding and Recovering from Server Failures
8.1.1
Failure Prevention and Automatic Recovery Features
8.1.1.1
Overload Protection
8.1.1.2
Redundancy and Failover for Clustered Services
8.1.1.3
Automatic Restart for Failed Server Instances
8.1.1.4
Managed Server Independence Mode
8.1.1.5
Automatic Migration of Failed Managed Servers
8.1.1.6
Geographic Redundancy for Regional Site Failures
8.1.2
Directory and File Backups for Failure Recovery
8.1.2.1
Enabling Automatic Configuration Backups
8.1.2.2
Storing the Domain Configuration Offline
8.1.2.3
Backing Up Server Start Scripts
8.1.2.4
Backing Up Logging Servlet Applications
8.1.2.5
Backing Up Security Data
8.1.2.6
Backing Up Additional Operating System Configuration Files
8.1.3
Restarting a Failed Administration Server
8.1.3.1
Restarting an Administration Server on the Same Machine
8.1.3.2
Restarting an Administration Server on Another Machine
8.1.4
Restarting Failed Managed Servers
8.2
Overview of Failover Detection
8.2.1
WlssEchoServer Failure Detection
8.2.2
Forced Shutdown for Failed Replicas
8.3
Improving Failover Performance for Physical Network Failures
8.3.1
Starting WlssEchoServer on SIP Data Tier Server Machines
8.3.2
Enabling and Configuring the Heartbeat Mechanism on Servers
8.4
Configuring SNMP
8.4.1
Browsing the MIB
8.4.2
Steps for Configuring SNMP
8.5
Understanding and Responding to SNMP Traps
8.5.1
Files for Troubleshooting
8.5.2
Trap Descriptions
8.5.2.1
connectionLostToPeer
8.5.2.2
connectionReestablishedToPeer
8.5.2.3
dataTierServerStopped
8.5.2.4
overloadControlActivated, overloadControlDeactivated
8.5.2.5
replicaAddedToPartition
8.5.2.6
replicaRemovedEnginesRegistration
8.5.2.7
replicaRemovedFromPartition
8.5.2.8
serverStopped
8.5.2.9
sipAppDeployed
8.5.2.10
sipAppUndeployed
8.5.2.11
sipAppFailedToDeploy
8.6
Using the WebLogic Diagnostics Framework (WLDF)
8.6.1
Data Collection and Logging
8.6.2
Watches and Notifications
8.6.3
Image Capture
8.6.4
Instrumentation
8.6.4.1
Configuring Server-Scoped Monitors
8.6.4.2
Configuring Application-Scoped Monitors
8.7
Logging SIP Requests and Responses
8.7.1
Defining Logging Servlets in sip.xml
8.7.2
Configuring the Logging Level and Destination
8.7.3
Specifying the Criteria for Logging Messages
8.7.3.1
Using XML Documents to Specify Logging Criteria
8.7.3.2
Using Servlet Parameters to Specify Logging Criteria
8.7.4
Specifying Content Types for Unencrypted Logging
8.7.5
Enabling Log Rotation and Viewing Log Files
8.7.6
trace-pattern.dtd Reference
8.7.7
Adding Tracing Functionality to SIP Servlet Code
8.7.8
Order of Startup for Listeners and Logging Servlets
8.8
Tuning JVM Garbage Collection for Production Deployments
8.8.1
Modifying JVM Parameters in Server Start Scripts
8.8.2
Tuning Garbage Collection with JRockit
8.8.3
Using Oracle JRockit Real Time (Deterministic Garbage Collection)
8.8.4
Using Oracle JRockit without Deterministic Garbage Collection
8.8.5
Tuning Garbage Collection with Sun JDK
8.9
Avoiding JVM Delays Caused By Random Number Generation
Part II Configuring Presence
9
Configuring Presence and Presence Web Services
9.1
Overview of Presence
9.2
Configuring Presence
9.2.1
Configuring XDMS
9.2.2
Bus
9.2.3
PackageManager
9.2.4
Presence
9.2.5
PresenceEventPackage
9.2.6
PresenceWInfoEventPackage
9.2.7
UA-ProfileEventPackage
9.2.8
Command Service (XDMS Provisioning)
9.2.9
XCapConfigManager
9.2.10
Aggregation Proxy
9.2.11
Configuring Default Application Router for OPTIONS
9.3
Configuring Presence Web Services
9.3.1
PresenceSupplierWebService
9.3.2
PresenceConsumerWebService
9.3.3
MessagingWebServiceConfig
Part III Configuring Diameter
10
Configuring Diameter Client Nodes and Relay Agents
10.1
Overview of Diameter Protocol Configuration
10.2
Steps for Configuring Diameter Client Nodes and Relay Agents
10.3
Installing the Diameter Domain
10.4
Enabling the Diameter Console Extension
10.5
Creating TCP, TLS, and SCTP Network Channels for the Diameter Protocol
10.5.1
Configuring Two-Way SSL for Diameter TLS Channels
10.5.2
Configuring and Using SCTP for Diameter Messaging
10.6
Configuring Diameter Nodes
10.6.1
Creating a New Node Configuration (General Node Configuration)
10.6.2
Configuring Diameter Applications
10.6.2.1
Configuring the Sh Client Application
10.6.2.2
Configuring the Rf Client Application
10.6.2.3
Configuring the Ro Client Application
10.6.2.4
Configuring a Diameter Relay Agent
10.6.2.5
Configuring the Sh and Rf Simulator Applications
10.6.2.6
Enabling Profile Service (using an Sh backend)
10.6.3
Configuring Peer Nodes
10.6.4
Configuring Routes
10.7
Example Domain Configuration
10.8
Troubleshooting Diameter Configurations
Part IV Oracle User Messaging Services
11
Configuring Oracle User Messaging Service
11.1
User Messaging Service Overview
11.1.1
Components
11.1.2
Architecture
11.2
Introduction to Oracle User Messaging Service Configuration
11.3
Accessing User Messaging Service Configuration Pages
11.3.1
How to Set the Storage Method
11.3.2
How to Add or Remove User Messaging Preferences Business Terms
11.3.2.1
Adding Business Terms
11.3.2.2
Removing Business Terms
11.4
Configuring User Messaging Service Drivers
11.4.1
How to Configure a Driver
11.4.1.1
About Driver Properties
11.4.1.2
Securing Passwords
11.4.1.3
Configuring the E-Mail Driver
11.4.1.4
Configuring the SMPP Driver
11.4.1.5
Configuring the XMPP Driver
11.4.1.6
Configuring the VoiceXML Driver
11.4.1.7
Configuring the Worklist Driver
11.4.1.8
Configuring the Proxy Driver
11.5
Securing User Messaging Service
11.5.1
Web Service Security on Notification
11.5.2
Enabling UMS Service Security
11.5.3
Enabling Client Security
11.5.4
Keystore Configuration
11.5.5
Client Aliases
11.6
Troubleshooting Oracle User Messaging Service
12
Monitoring Oracle User Messaging Service
12.1
Monitoring Oracle User Messaging Service
12.1.1
Using Message Status
12.1.2
Deregistering Messaging Client Applications
12.1.3
Monitoring Drivers Using the All Tab
12.2
Log Files
12.2.1
Configuring Logging
12.3
Metrics and Statistics
13
Managing Oracle User Messaging Service
13.1
Deploying Drivers
13.1.1
Using WebLogic Server Administration Console
13.1.2
Using Oracle Enterprise Manager to Deploy Drivers
13.1.3
Using WLST Commands
13.1.3.1
deployUserMessagingDriver
13.1.4
Using the Oracle Fusion Middleware Configuration Wizard
13.2
Undeploying and Unregistering Drivers
Part V Confiding SIP Infrastructure Applications
14
Configuring SIP Infrastructure Applications
14.1
Proxy Registrar
14.2
STUN Service
Part VI Deploying Oracle WebLogic Communication Services
15
Oracle WebLogic Communication Services Base Platform Topologies
15.1
Goals of the Oracle WebLogic Communication Services Base Platform
15.2
Load Balancer
15.3
Engine Tier
15.4
SIP Data tier
15.4.1
Example of Writing and Retrieving Call State Data
15.4.2
RDBMS Storage for Long-Lived Call State Data
15.5
Geographically-Redundant Installations
15.6
Example Hardware Configurations
15.7
Alternate Configurations
16
Deployment Topologies for Communication Services
16.1
Terminology
16.2
OWLCS Deployment Topologies
16.2.1
Single-node Topologies
16.3
Oracle WebLogic Communication Services Enterprise Deployment Topology
16.3.1
Introduction to OWLCS Enterprise Deployment Topology
16.3.1.1
Runtime Processes
16.3.1.2
Request Flow
16.3.1.3
Client Connections
16.3.1.4
Artifacts
16.3.1.5
Topology Components
16.3.1.6
Overview of SIP State Tier Configuration
16.3.1.7
Example SIP State Tier Configurations and Configuration Files
16.3.1.8
Storing Long-Lived Call State Data in an RDBMS
16.3.2
Geographic Redundancy
16.3.3
Failover
16.3.3.1
OWLCS Presence Failover
16.3.3.2
Presentity Migration
16.3.3.3
Standby Server Pool
16.3.3.4
Failure Types
16.3.3.5
Failover Actions
16.3.3.6
Overload Policy
16.3.3.7
Synchronization of Failover Events
16.3.3.8
Expanding the Cluster
16.3.3.9
Failover Use Cases
17
Upgrading Deployed SIP Applications
17.1
Overview of SIP Application Upgrades
17.2
Requirements and Restrictions for Upgrading Deployed Applications
17.3
Steps for Upgrading a Deployed SIP Application
17.4
Assign a Version Identifier
17.4.1
Defining the Version in the Manifest
17.5
Deploy the Updated Application Version
17.6
Undeploy the Older Application Version
17.7
Roll Back the Upgrade Process
17.8
Accessing the Application Name and Version Identifier
17.9
Using Administration Mode
18
Parlay X Web Services Architecture
18.1
Architecture of Web Service Client Applications
18.2
Web Service Security
18.2.1
Web Service Security on Notification
18.2.2
Enabling OWLCS Service Security
18.2.3
Enabling Client Security
18.2.4
Keystore Configuration
18.2.5
Client Aliases
18.3
Installing the Web Services
Part VII Reference
A
SIP Servlet Container Configuration Reference
A.1
Overview of sipserver.xml
A.2
Editing sipserver.xml
A.2.1
Steps for Editing sipserver.xml
A.3
XML Schema
A.4
Example sipserver.xml File
A.5
XML Element Description
A.5.1
enable-timer-affinity
A.5.2
overload
A.5.2.1
Selecting an Appropriate Overload Policy
A.5.2.2
Overload Control Based on Session Generation Rate
A.5.2.3
Overload Control Based on Capacity Constraints
A.5.2.4
Two Levels of Overload Protection
A.5.3
message-debug
A.5.4
proxy—Setting Up an Outbound Proxy Server
A.5.5
t1-timeout-interval
A.5.6
t2-timeout-interval
A.5.7
t4-timeout-interval
A.5.8
timer-b-timeout-interval
A.5.9
timer-f-timeout-interval
A.5.10
max-application-session-lifetime
A.5.11
enable-local-dispatch
A.5.12
cluster-loadbalancer-map
A.5.13
default-behavior
A.5.14
default-servlet-name
A.5.15
retry-after-value
A.5.16
sip-security
A.5.17
route-header
A.5.18
engine-call-state-cache-enabled
A.5.19
server-header
A.5.20
server-header-value
A.5.21
persistence
A.5.22
use-header-form
A.5.23
enable-dns-srv-lookup
A.5.24
connection-reuse-pool
A.5.25
globally-routable-uri
A.5.26
domain-alias-name
A.5.27
enable-rport
A.5.28
image-dump-level
A.5.29
stale-session-handling
A.5.30
enable-contact-provisional-response
A.5.31
app-router
A.5.32
use-custom-app-router
A.5.33
app-router-config-data
A.5.34
custom-app-router-jar-file-name
A.5.35
default-application-name
B
SIP Data Tier Configuration Reference
B.1
Overview of datatier.xml
B.2
Editing datatier.xml
B.3
XML Schema
B.4
Example datatier.xml File
B.5
XML Element Description
C
Diameter Configuration Reference
C.1
Overview of diameter.xml
C.2
Graphical Representation
C.3
Editing diameter.xml
C.3.1
Steps for Editing diameter.xml
C.4
XML Schema
C.5
Example diameter.xml File
C.6
XML Element Description
C.6.1
configuration
C.6.2
target
C.6.3
host
C.6.4
realm
C.6.5
address
C.6.6
port
C.6.7
tls-enabled
C.6.8
sctp-enabled
C.6.9
debug-enabled
C.6.10
message-debug-enabled
C.6.11
application
C.6.11.1
class-name
C.6.11.2
param*
C.6.12
peer-retry-delay
C.6.13
allow-dynamic-peers
C.6.14
request-timeout
C.6.15
watchdog-timeout
C.6.16
supported-vendor-id+
C.6.17
include-origin-state
C.6.18
peer+
C.6.18.1
host
C.6.18.2
address
C.6.18.3
port
C.6.18.4
protocol
C.6.19
route
C.6.19.1
realm
C.6.19.2
application-id
C.6.19.3
action
C.6.19.4
server+
C.6.20
default-route
C.6.20.1
action
C.6.20.2
server+
D
Startup Command Options
E
Supported Platforms, Protocols, RFCs and Standards
E.1
Supported Configurations
E.2
Supported SIP Clients
E.3
Supported Load Balancer
E.4
Supported Databases
E.5
Overview of Oracle WebLogic Communication Services Standards Alignment
E.6
Java Sun Recommendation (JSR) Standards Compliance
E.7
IETF RFC Compliance
E.8
3GPP R6 Specification Conformance
F
Using Oracle WebLogic Communication Services Export/Import
F.1
Export
F.1.1
Export the Database Data from the Current Environment
F.2
Import
G
Deploying a Scalable Presence Deployment
G.1
Presence Cluster
G.2
XDM Cluster
G.3
Presence Node
G.4
XDM Node
G.5
Complete Presence and XDM Cluster
Index