The following sections describe how to configure SIP Container features in the engine tier of a WebLogic SIP Server deployment:
You can configure SIP Container properties either by using a JMX utility such as the Administration Console or WebLogic Scripting Tool (WLST), or by programming a custom JMX application. Using the Administration Console to Configure Container Properties describes how to configure container properties using the Administration Console graphical user interface.
Configuring Container Properties Using WLST (JMX) describes how to directly access JMX MBeans to modify the container configuration. All examples use WLST to illustrate JMX access to the configuration MBeans.
The Administration Console included with WebLogic SIP Server enables you to configure and monitor core WebLogic Server functionality as well as the SIP Servlet container functionality provided with WebLogic SIP Server. To configure or monitor SIP Servlet features using the Administration Console:
The right pane of the console provides two levels of tabbed pages that are used for configuring and monitoring WebLogic SIP Server. Table 6-1 summarizes the available pages and provides links to additional information about configuring SIP container properties.
Configure
proxy routing URIs and proxy policies.
|
||
Configure the conditions for enabling and disabling automatic
overload controls.
|
||
Enable or disable SIP
message logging on a development system.
|
||
Identify
trusted hosts for which authentication is not performed.
|
||
Configure persistence options for
storing long-lived session data in an RDBMS, or for
replicating long-lived session data to a remote, geographically-redundant site.
|
||
View the current
configuration of data tier servers.
|
||
Configure the mapping of multiple clusters to internal virtual IP addresses during a
software upgrade.
|
||
Configure
connection reuse pools to minimize communication overhead with a Session Border Control (SBC) function or Serving Call Session Control Function (S-CSCF).
|
||
View runtime information about the current
status and the work performed by servers in the data tier.
|
In order to modify information on any of the WebLogic SIP Server configuration pages, you must first obtain a lock on the configuration by clicking the Lock & Edit button. Locking a configuration prevents other Administrators from modifying the configuration at the same time.
If you obtain a lock on the configuration, you can change SIP Servlet container attribute values on multiple configuration pages, saving the changes as needed. You then have two options depending on whether you want to keep or discard the changes you have made:
Note that WebLogic SIP Server automatically saves the original boot configuration in the file sipserver.xml.booted
in the config/custom
subdirectory of the domain directory. You can use this file to revert to the booted configuration if necessary to discard all configuration changes made since the server was started.
Notes: | The WebLogic Scripting Tool (WLST) is a utility that you can use to observe or modify JMX MBeans available on a WebLogic Server or WebLogic SIP Server instance. Full documentation for WLST is available at http://download.oracle.com/docs/cd/E13222_01/wls/docs92/config_scripting/index.html. |
Note: | Before using WLST to configure a WebLogic SIP Server domain, set you environment to add required WebLogic SIP Server classes to your classpath. Use either a domain environment script or the setWLSEnv.sh script located in WLSS_HOME/server/bin where WLSS_HOME is the root of your WebLogic SIP Server installation. |
Table 6-2 summarizes the WLST methods used to lock a configuration and apply changes.
A typical configuration session involves the following tasks:
startEdit()
to obtain a lock on the active configuration.save()
to persist all changes to a temporary configuration file named sipserver.xml.saved
, oractivate()
to persist changes to the sipserver.xml.saved
file, rename sipserver.xml.saved
to sipserver.xml
(copying over the existing file), and apply changes to the running engine tier server nodes.Note: | When you boot the Administration Server for a WebLogic SIP Server domain, the server parses the current container configuration in sipserver.xml and creates a copy of the initial configuration in a file named sipserver.xml.booted . You can use this copy to revert to the booted configuration, as described in Reverting to the Original Boot Configuration. |
ConfigManagerRuntimeMBean
manages access to and persists the configuration MBean attributes described in Table 6-3. Although you can modify other configuration MBeans, such as WebLogic Server MBeans that manage resources such as network channels and other server properties, those MBeans are not managed by ConfigManagerRuntimeMBean
.
Manages the mapping of multiple clusters to internal virtual IP addresses during a software upgrade. This attribute is not used during normal operations. See also Upgrading Software in the Operations Guide for more information. |
||
Manages overload settings for throttling incoming SIP requests. See also
overload in the Configuration Reference Manual.
|
||
Manages the URIs routing policies for proxy servers. See also
proxy—Setting Up an Outbound Proxy Server in the Configuration Reference Manual.
|
||
Defines trusted hosts for which authentication is not performed. See also
sip-security in the Configuration Reference Manual.
|
||
Configuration MBean that represents the entire
sipserver.xml configuration file. You can use this MBean to obtain and manage each of the individual MBeans described in this table, or to set SIP timer or SIP Session timeout values. See also Creating and Deleting MBeans , default-behavior, enable-local-dispatch, max-application-session-lifetime, t1-timeout-interval, t2-timeout-interval, t4-timeout-interval, timerB-timeout-interval, and timerF-timeout-interval in the Configuration Reference Manual.
|
All SIP Servlet container configuration MBeans are located in the “serverConfig” MBean tree, accessed using the serverConfig()
command in WLST. Within this bean tree, individual configuration MBeans can be accessed using the path:
CustomResources/sipserver/Resource/sipserver
For example, to browse the default Proxy MBean for a WebLogic SIP Server domain you would enter these WLST commands:
serverConfig()
cd(‘CustomResources/sipserver/Resource/sipserver/Proxy’)
ls()
Runtime MBeans, such as ConfigManagerRuntime
, are accessed in the “custom” MBean tree, accessed using the custom()
command in WLST. Runtime MBeans use the path:
mydomain
:Location=myserver
,Name=myserver
,Type=mbeantype
Certain configuration settings, such as proxy and overload protection settings, are defined by default in sipserver.xml
. Configuration MBeans are generated for these settings when you boot the associated server, so you can immediately browse the Proxy
and OverloadProtection
MBeans. Other configuration settings are not configured by default and you will need to create the associated MBeans before they can be accessed. See Creating and Deleting MBeans.
The following sections provide example WLST scripts and commands for configuring SIP Servlet container properties.
To use WLST with WebLogic SIP Server, you must ensure that all WebLogic SIP Server JAR files are included in your classpath. Follow these steps:
Because a typical configuration session involves accessing ConfigManagerRuntimeMBean
twice—once for obtaining a lock on the configuration, and once for persisting the configuration and/or applying changes—JMX applications that manage container attributes generally have a similar structure. Listing 6-1 shows a WLST script that contains the common commands needed to access ConfigManagerRuntimeMBean
. The example script modifies the proxy RoutingPolicy
attribute, which is set to supplemental
by default in new WebLogic SIP Server domains. You can use this listing as a basic template, modifying commands to access and modify the configuration MBeans as necessary.
# Connect to the Administration Server
connect('weblogic','weblogic','t3://localhost:7001')
# Navigate to ConfigManagerRuntimeMBean and start an edit session.
custom()
cd('mydomain:Location=myserver,Name=sipserver,ServerRuntime=myserver,Type=ConfigManagerRuntime')
cmo.startEdit()
# --MODIFY THIS SECTION AS NECESSARY--
# Edit SIP Servlet container configuration MBeans
cd('mydomain:DomainConfig=mydomain,Location=myserver,Name=myserver,SipServer=myserver,Type=Proxy')
set('RoutingPolicy','domain')
# Navigate to ConfigManagerRuntimeMBean and persist the configuration
# to sipserver.xml
cd('mydomain:Location=myserver,Name=sipserver,ServerRuntime=myserver,Type=ConfigManagerRuntime')
cmo.activate()
The SipServer
MBean represents the entire contents of the sipserver.xml
configuration file. In addition to having several attributes for configuring SIP timers and SIP application session timeouts, SipServer
provides helper methods to help you create or delete MBeans representing proxy settings and overload protection controls.
Listing 6-2 shows an example of how to use the helper commands to create and delete configuration MBeans that configuration elements in sipserver.xml
. See also
Listing 6-3, SIP Container Configuration MBeans, on page 6-6 for a listing of other helper methods in SipServer
, or refer to the
WebLogic SIP Server JavaDocs.
connect()
custom()
cd('mydomain:Location=myserver,Name=sipserver,ServerRuntime=myserver,Type=ConfigManagerRuntime')
cmo.startEdit()
cd('mydomain:DomainConfig=mydomain,Location=myserver,Name=sipserver,ServerRuntime=myserver,Type=SipServer')
cmo.destroyOverloadProtection()
cmo.createProxy()
cd('mydomain:Location=myserver,Name=sipserver,ServerRuntime=myserver,Type=ConfigManagerRuntime')
cmo.save()
Configuration MBeans such as Proxy
require URI objects passed as attribute values. BEA provides a helper class, com.bea.wcp.sip.util.URIHelper
, to help you easily generate URI objects from an array of Strings. Listing 6-3 modifies the sample shown in
Listing 6-2, WLST Commands for Creating and Deleting MBeans, on page 6-10 to add a new URI attribute to the LoadBalancer
MBean. See also the
WebLogic SIP Server JavaDocs for a full reference to the URIHelper
class.
# Import helper method for converting strings to URIs.
from com.bea.wcp.sip.util.URIHelper import stringToSipURIs
connect()
custom()
cd('mydomain:Location=myserver,Name=sipserver,ServerRuntime=myserver,Type=ConfigManagerRuntime')
cmo.startEdit()
cd('mydomain:DomainConfig=mydomain,Location=myserver,Name=sipserver,Type=SipServer')
cmo.createProxy()
cd('mydomain:DomainConfig=mydomain,Location=myserver,Name=sipserver,SipServer=sipserver,Type=Proxy')
stringarg = jarray.array([java.lang.String("sip://siplb.bea.com:5060")],java.lang.String)
uriarg = stringToSipURIs(stringarg)
set('ProxyURIs',uriarg)
cd('mydomain:Location=myserver,Name=sipserver,ServerRuntime=myserver,Type=ConfigManagerRuntime')
cmo.save()
When you boot the Administration Server for a WebLogic SIP Server domain, the server creates parses the current container configuration in sipserver.xml
, and generates a copy of the initial configuration in a file named sipserver.xml.booted
. This backup copy of the initial configuration is preserved until you next boot the server; modifying the configuration using JMX does not affect the backup copy.
If you modify the SIP Servlet container configuration and later decide to roll back the changes, copy the sipserver.xml.booted
file over the current sipserver.xml
file. Then reboot the server to apply the new configuration.
As engine tier servers add new call state data to the data tier, data tier instances queue and maintain the complete list of SIP protocol timers and application timers associated with each call. Engine tier servers periodically poll all partitions of the data tier to determine which timers have expired, given the current time. (Multiple engine tier polls to the data tier are staggered to avoid contention on the timer tables.) Engine tier servers then process expired timers using threads allocated in the sip.timer.Default
execute queue.
In order for the SIP protocol stack to function properly, all engine and data tier servers must accurately synchronize their system clocks to a common time source, to within one or two milliseconds. Large differences in system clocks cause a number of severe problems such as:
BEA recommends using a Network Time Protocol (NTP) client or daemon on each WebLogic SIP Server instance and synchronizing to a common NTP server.
WARNING: | You must accurately synchronize server system clocks to a common time source (to within one or two milliseconds) in order for the SIP protocol stack to function properly. Because the initial T1 timer value of 500 milliseconds controls the retransmission interval for INVITE request and responses, and also sets the initial values of other timers, even small differences in system clock settings can cause improper SIP protocol behavior. For example, an engine tier server with a system clock 250 milliseconds faster than other servers will process more expired timers than other engine tier servers, will cause retransmits to begin in half the allotted time, and may force messages to timeout prematurely. |