Network Deployment (Distributed operating systems), v8.0 > Reference > Custom properties
SIP container custom properties
We can add any of the following custom properties to the configuration settings for a SIP container.
To specify custom properties for a specific SIP container, navigate to the custom properties page, and then specify a value for the custom property.
The custom properties are supported as the primary method of configuration. Therefore, if a custom property is set and then you set the corresponding setting in the admin console, the custom property value is used.
- In the admin console, expand Servers > Server Types > WebSphere application servers >
server_name
to open the configuration tab for the server.
- From Container settings, expand SIP Container settings, and click SIP container.
- From Additional properties, select Custom Properties > New .
- On the settings page, type the custom property to configure in the Name field, and then type the value of the custom property in the Value field.
- Click Apply or OK.
- Click Save on the console task bar to save the configuration changes.
- Restart the server.
The following list of SIP container custom properties is provided with the product. These properties are not shown on the settings page for the container.
We can define the following SIP container custom properties that are provided with the product. These properties are not shown on the settings page for the container.
- auth.int.enable
- com.ibm.sip.sm.lnm.size
- com.ibm.webspehere.sip.security.digest.ldap.cachecleanperiod
- com.ibm.websphere.sip.security.tai.usercachecleanperiod
- com.ibm.ws.sip.key.set
- com.ibm.ws.sip.tai.DisableSIPBasicAuth
- DigestPasswordServerClass
- enable.system.headers.modify
- end.of.service.replication
- immediate.replication
- javax.servlet.sip.ar.dar.configuration
- javax.servlet.sip.ar.spi.SipApplicationRouterProvider
- javax.sip.bind.retries
- javax.sip.bind.retry.delay
- javax.sip.detect.pre.escaped.params
- javax.sip.force.connection.reuse
- javax.sip.hide.message.body
- javax.sip.hide.message.headers
- javax.sip.hide.request.uri
- javax.sip.OUTBOUND_PROXY
- javax.sip.PATH_MTU
- javax.sip.stat.report.interval
- javax.sip.trace.msg.in
- javax.sip.trace.msg.out
- javax.sip.transaction.invite.auto100
- javax.sip.transaction.timer.a
- javax.sip.transaction.timer.b
- javax.sip.transaction.timer.cancel
- javax.sip.transaction.timer.d
- javax.sip.transaction.timer.e
- javax.sip.transaction.timer.f
- javax.sip.transaction.timer.g
- javax.sip.transaction.timer.h
- javax.sip.transaction.timer.i
- javax.sip.transaction.timer.invite.server
- javax.sip.transaction.timer.j
- javax.sip.transaction.timer.k
- javax.sip.transaction.timer.non.invite.server
- javax.sip.transaction.timer.t1
- javax.sip.transaction.timer.t2
- javax.sip.transaction.timer.t4
- on.outgoing.message.replication
- pws_atr_name
- replicate.with.confirmed.dialog.only
- sip.container.heartbeat.enabled
- sip.jsr289.parse.address
- SIP_RFC3263_nameserver
- thread.message.queue.max.size
- weight.overload.watermark
Browse all SIP topics
Configure the SIP container
auth.int.enable
Auth-int quality of protection (QOP) for digest authentication. Digest authentication defines two types of QOP: auth and auth-int. By default, auth is used. When this custom property is set to True, the highest level of protection is used, which is the auth-int QOP.
| Data type | String |
|---|---|
| Default | False |
com.ibm.sip.sm.lnm.size
Number of logical names in the application server. Each SIP object that can be replicated, such as a SIP session, is associated with a logical name. All objects with the same logical name are replicated to the same back-up container. The proxy can route messages to the correct container using the logical name found in the message. The value must be greater than 1.
| Data type | String |
|---|---|
| Default | 10 |
com.ibm.webspehere.sip.security.digest.ldap.cachecleanperiod
Clean LDAP cache period in minutes.
| Data type | String |
|---|---|
| Default | 120 |
com.ibm.websphere.sip.security.tai.usercachecleanperiod
Clean security subject cache period in minutes.
| Data type | String |
|---|---|
| Default | 15 |
com.ibm.ws.sip.key.set
Key to use for SIP flow token security. When a value is specified for this property, SIP flow token security is automatically enabled.
| Data type | String |
|---|---|
| Default | There is no default value |
com.ibm.ws.sip.tai.DisableSIPBasicAuth
Whether to allow basic authentication for SIP.
| Data type | String |
|---|---|
| Default | False |
DigestPasswordServerClass
Specifies types of user registries that are supported, except LDAP.
To configure DigestTAI without the LDAP user registry, complete the following steps.
- Create a class that implements this interface: com.ibm.ws.sip.security.digest.DigestPasswordServer
- Add the following property to the SIP container custom property:
- Default LdapPasswordServer
- Default LdapPasswordServer
- Ensure that all users declared by the impl class are declared in the user registry configured for the product security.
| Data type | String |
|---|---|
| Default | impl |
enable.system.headers.modify
Whether the application has access to headers that are otherwise restricted.
| Data type | String |
|---|---|
| Default | False |
end.of.service.replication
Whether changes are buffered until the thread for a siplet is about to end. If the value is set to true, then each change is buffered until the thread for the siplet is about to end.
| Data type | Boolean |
|---|---|
| Default | true |
immediate.replication
Whether each change is immediately sent to the Data Replication Service. When this property is set to true, when replication is issued from a non-SIP container thread, the replication is immediately performed on the calling thread. When this property is set to false, the changes are buffered, and replication does not occur until all changes are made.
Set this property to true might have a negative impact on performance.
| Data type | Boolean |
|---|---|
| Default | false |
javax.servlet.sip.ar.dar.configuration
Location of the default application router (DAR) properties file. The properties file defines the order in which the application router sends SIP requests to applications as described in Appendix C of the JSR 289 specification.
| Data type | String |
|---|---|
| Default | Null |
javax.servlet.sip.ar.spi.SipApplicationRouterProvider
Custom application router implementation fully qualified class name as described in section 15.4.2 of the JSR 289 specification. The custom application router implementation class defines the order in which the application router sends SIP requests to applications.
| Data type | String |
|---|---|
| Default | Null |
javax.sip.bind.retries
Amount of time, in milliseconds, between attempts to start the SIP channel if the SIP port is busy with another process during server startup.
| Data type | String |
|---|---|
| Default | 60 |
javax.sip.bind.retry.delay
Delay, in milliseconds, between attempts to start the SIP channel if the SIP port is busy with another process during server startup.
| Data type | String |
|---|---|
| Default | 5000 |
javax.sip.detect.pre.escaped.params
Whether to prevent the container from re-escaping Uniform Resource Identifier (URI) parameters that were pre-escaped by the application.
Enable this property provides the application with more control over escaping URI parameters, when calling the javax.servlet.sip.SipFactory.createURI() and the javax.servlet.sip.SipURI.setParameter() parameters.
By default, the container only escapes characters that it must encode according to the RFC 3261 25.1 specification. In some cases, however, escaping additional characters might be required. Due to a limitation in the JSR 116 (5.2.1) specification, the application cannot perform its own escaping. Because of this limitation, attempts by the application to encode URI parameters causes the container to re-encode the percent sign. If the value of this property is set to true, the container cannot re-encode the percent sign.
Set the value to true is not in compliance with the JSR 116 (5.2.1) specification, but provides the application with greater control over URI parameter escaping. APAR PK37192 describes the problem and the workaround.
| Data type | String |
|---|---|
| Default | False |
javax.sip.force.connection.reuse
Whether to force reuse of inbound connections for outbound requests. This custom property is only relevant for stream transports, such as Transmission Control Protocol (TCP) and Transport Layer Security (TLS). Disabling this property causes the container to create a separate connection for outbound requests, even if an existing connection is already established to the same peer address. The connection is automatically reused if the top Via header in the inbound request contains an alias parameter. (http://www.ietf.org/internet-drafts/draft-ietf-sip-connect-reuse-07.txt)
| Data type | String |
|---|---|
| Default | False |
Deprecated feature: This custom property is deprecated.
Do not use this custom property unless you are running in a mixed cell environment that includes at least one core group that contains a mixture of v7.0 and v6.x processes.depfeat
Mixed-version environment: If you are running in a mixed cell environment, and we have core groups that contain a mixture of v7.0 and v6.x processes, continue to use this custom property.mixv
javax.sip.hide.message.body
Specifies to hide message content in logs. Set the value of this property to true to remove the message body text from SIP messages printed in the log files. This property only affects the representation of the messages in log files.
| Data type | String |
|---|---|
| Default | False |
Deprecated feature: This custom property is deprecated.
Do not use this custom property unless you are running in a mixed cell environment that includes at least one core group that contains a mixture of v7.0 and v6.x processes.depfeat
Mixed-version environment: If you are running in a mixed cell environment, and we have core groups that contain a mixture of v7.0 and v6.x processes, continue to use this custom property.mixv
javax.sip.hide.message.headers
Specifies to hide the specified message header field names in log files. The value of this property is a comma-separated list of header field names that you want removed from SIP messages printed in the log files. This property only affects the representation of the messages in log files.
| Data type | String |
|---|---|
| Default | None |
javax.sip.hide.request.uri
Specifies to hide request URIs in log files. Set the value of this property to true to remove request URIs from SIP messages printed in the log files. This property only affects the representation of the messages in log files.
| Data type | Boolean |
|---|---|
| Default | False |
javax.sip.OUTBOUND_PROXY
Fixed address for routing all outbound SIP messages. The format is address:port/transport, such as 1.2.3.4:5065/tcp.
Do not use this property if the container is fronted by an application server SIP proxy.
| Data type | String |
|---|---|
| Default | null |
Deprecated feature: This custom property is deprecated.
Do not use this custom property unless you are running in a mixed cell environment that includes at least one core group that contains a mixture of v7.0 and v6.x processes.depfeat
Mixed-version environment: If you are running in a mixed cell environment, and we have core groups that contain a mixture of v7.0 and v6.x processes, continue to use this custom property.mixv
javax.sip.PATH_MTU
Maximum transmission unit, in bytes, for outbound User Datagram Protocol (UDP) requests. The SIP stack measures the size of a request before sending it out on the UDP channel. If the request is larger than the value specified for PATH_MTU-200 (1300 bytes by default), then the transport is switched from UDP to TCP before transmission. Increase this value to send larger requests over the UDP channel; however, messages might be truncated or dropped. See the RFC 3261-18.1.1 specification for details.
| Data type | String |
|---|---|
| Default | 1500 |
Deprecated feature: This custom property is deprecated.
Do not use this custom property unless you are running in a mixed cell environment that includes at least one core group that contains a mixture of v7.0 and v6.x processes.depfeat
Mixed-version environment: If you are running in a mixed cell environment, and we have core groups that contain a mixture of v7.0 and v6.x processes, continue to use this custom property.mixv
javax.sip.stat.report.interval
Amount of time, in milliseconds, for reporting dispatch and timer statistics to a system.out file. A value of zero indicates no report.
| Data type | String |
|---|---|
| Default | 0 |
javax.sip.trace.msg.in
Whether to print incoming messages to a system.out file.
| Data type | String |
|---|---|
| Default | False |
javax.sip.trace.msg.out
Whether to print outbound messages to a system.out file.
| Data type | String |
|---|---|
| Default | False |
javax.sip.transaction.invite.auto100
Whether to automatically reply to invite requests with a 100 Trying response. Disabling this property might increase the number of invite retransmissions.
| Data type | String |
|---|---|
| Default | True |
Deprecated feature: This custom property is deprecated.
Do not use this custom property unless you are running in a mixed cell environment that includes at least one core group that contains a mixture of v7.0 and v6.x processes.depfeat
Mixed-version environment: If you are running in a mixed cell environment, and we have core groups that contain a mixture of v7.0 and v6.x processes, continue to use this custom property.mixv
javax.sip.transaction.timer.a
Specifies, for UDP only, the amount of time, in milliseconds, before retransmitting invite requests for timer A for the RFC 3261 specification. This property is relevant for the invite client transaction.
| Data type | String |
|---|---|
| Default | javax.sip.transaction.timer.t1 |
Deprecated feature: This custom property is deprecated.
Do not use this custom property unless you are running in a mixed cell environment that includes at least one core group that contains a mixture of v7.0 and v6.x processes.depfeat
Mixed-version environment: If you are running in a mixed cell environment, and we have core groups that contain a mixture of v7.0 and v6.x processes, continue to use this custom property.mixv
javax.sip.transaction.timer.b
Amount of time, in milliseconds, for the invite client transaction timeout timer (timer B) for the RFC 3261 specification.
| Data type | String |
|---|---|
| Default | 64*javax.sip.transaction.timer.t1 |
Deprecated feature: This custom property is deprecated.
Do not use this custom property unless you are running in a mixed cell environment that includes at least one core group that contains a mixture of v7.0 and v6.x processes.depfeat
Mixed-version environment: If you are running in a mixed cell environment, and we have core groups that contain a mixture of v7.0 and v6.x processes, continue to use this custom property.mixv
javax.sip.transaction.timer.cancel
Amount of timer, in milliseconds, for the timer to keep the cancelled client transaction in the proceeding state before completing the cancelled transaction for the RFC 3261 9.1 specification. This property is relevant for the invite client transaction.
| Data type | String |
|---|---|
| Default | 64*javax.sip.transaction.timer.t1 |
javax.sip.transaction.timer.d
Wait time, in milliseconds, before retransmission of the invite response for timer D for the RFC 3261 specification. This property is relevant for the invite client transaction.
| Data type | String |
|---|---|
| Default | 32000 |
Deprecated feature: This custom property is deprecated.
Do not use this custom property unless you are running in a mixed cell environment that includes at least one core group that contains a mixture of v7.0 and v6.x processes.depfeat
Mixed-version environment: If you are running in a mixed cell environment, and we have core groups that contain a mixture of v7.0 and v6.x processes, continue to use this custom property.mixv
javax.sip.transaction.timer.e
Specifies, for UDP only, the amount of time, in milliseconds, before the retransmission of the initial non-invite request for timer E for the RFC 3261 specification. This property is relevant for the non-invite client transaction.
| Data type | String |
|---|---|
| Default | javax.sip.transaction.timer.t1 |
Deprecated feature: This custom property is deprecated.
Do not use this custom property unless you are running in a mixed cell environment that includes at least one core group that contains a mixture of v7.0 and v6.x processes.depfeat
Mixed-version environment: If you are running in a mixed cell environment, and we have core groups that contain a mixture of v7.0 and v6.x processes, continue to use this custom property.mixv
javax.sip.transaction.timer.f
Amount of time, in milliseconds, for the non-invite transaction timeout timer (timer F) for the RFC 3261 specification. This property is relevant for the non-invite client transaction.
| Data type | String |
|---|---|
| Default | 64*javax.sip.transaction.timer.t1 |
Deprecated feature: This custom property is deprecated.
Do not use this custom property unless you are running in a mixed cell environment that includes at least one core group that contains a mixture of v7.0 and v6.x processes.depfeat
Mixed-version environment: If you are running in a mixed cell environment, and we have core groups that contain a mixture of v7.0 and v6.x processes, continue to use this custom property.mixv
javax.sip.transaction.timer.g
Amount of time, in milliseconds, before retransmission of an initial invite response for timer G for the RFC 3261 specification. This property is relevant for the invite server transaction.
| Data type | String |
|---|---|
| Default | javax.sip.transaction.timer.t1 |
Deprecated feature: This custom property is deprecated.
Do not use this custom property unless you are running in a mixed cell environment that includes at least one core group that contains a mixture of v7.0 and v6.x processes.depfeat
Mixed-version environment: If you are running in a mixed cell environment, and we have core groups that contain a mixture of v7.0 and v6.x processes, continue to use this custom property.mixv
javax.sip.transaction.timer.h
Amount of time, in milliseconds, to wait for an acknowledgement (ACK) receipt for timer H for the RFC 3261 specification. This property is relevant for the invite server transaction.
| Data type | String |
|---|---|
| Default | 64*javax.sip.transaction.timer.t1 |
Deprecated feature: This custom property is deprecated.
Do not use this custom property unless you are running in a mixed cell environment that includes at least one core group that contains a mixture of v7.0 and v6.x processes.depfeat
Mixed-version environment: If you are running in a mixed cell environment, and we have core groups that contain a mixture of v7.0 and v6.x processes, continue to use this custom property.mixv
javax.sip.transaction.timer.i
Amount of time in milliseconds to wait for an ACK retransmission for timer I for the RFC 3261 specification. This property is relevant for the invite server transaction.
| Data type | String |
|---|---|
| Default | javax.sip.transaction.timer.t4 |
Deprecated feature: This custom property is deprecated.
Do not use this custom property unless you are running in a mixed cell environment that includes at least one core group that contains a mixture of v7.0 and v6.x processes.depfeat
Mixed-version environment: If you are running in a mixed cell environment, and we have core groups that contain a mixture of v7.0 and v6.x processes, continue to use this custom property.mixv
javax.sip.transaction.timer.invite.server
Amount of time, in milliseconds, for the timer to keep the invite server transaction in the complete state. This timer is not defined in the RFC specification.
To avoid creating a new server transaction when a client retransmits an invite request, keep the completed server transaction for a period of time before removing invite retransmissions. This timer is started when the transaction changes to the terminated state. When the timer completes, the transaction is removed.
| Data type | String |
|---|---|
| Default | 32000 |
javax.sip.transaction.timer.j
Amount of time in milliseconds to wait for non-invite request retransmission for timer J for the RFC 3261 specification. This property is relevant for the non-invite server transaction.
| Data type | String |
|---|---|
| Default | 64*javax.sip.transaction.timer.t1 |
Deprecated feature: This custom property is deprecated.
Do not use this custom property unless you are running in a mixed cell environment that includes at least one core group that contains a mixture of v7.0 and v6.x processes.depfeat
Mixed-version environment: If you are running in a mixed cell environment, and we have core groups that contain a mixture of v7.0 and v6.x processes, continue to use this custom property.mixv
javax.sip.transaction.timer.k
Amount of time, in milliseconds, to wait for non-INVITE response retransmissions for timer K for the RFC 3261 specification. This property is relevant for the non-invite client transaction.
| Data type | String |
|---|---|
| Default | javax.sip.transaction.timer.t4 |
Deprecated feature: This custom property is deprecated.
Do not use this custom property unless you are running in a mixed cell environment that includes at least one core group that contains a mixture of v7.0 and v6.x processes.depfeat
Mixed-version environment: If you are running in a mixed cell environment, and we have core groups that contain a mixture of v7.0 and v6.x processes, continue to use this custom property.mixv
javax.sip.transaction.timer.non.invite.server
Amount of time, in milliseconds, for an API timer for the application to respond to a non-invite request. This property is relevant for non-invite server transactions.
This timer is not defined in the RFC specification. This property is needed to stop the transaction if the application does not generate a final response to the request. The timer starts when the request arrives in the stack and stops when a response is generated by the application. If no response is generated before the timer stops, then the transaction completes.
| Data type | String |
|---|---|
| Default | 34000 |
javax.sip.transaction.timer.t1
Amount of time, in milliseconds, for a network round trip delay for timer T1 for the RFC 3261 specification. The value is used as a base for calculating some timers and is relevant for all types of transactions, such as client, server, invite, and non-invite transactions.
| Data type | String |
|---|---|
| Default | 500 |
Deprecated feature: This custom property is deprecated.
Do not use this custom property unless you are running in a mixed cell environment that includes at least one core group that contains a mixture of v7.0 and v6.x processes.depfeat
Mixed-version environment: If you are running in a mixed cell environment, and we have core groups that contain a mixture of v7.0 and v6.x processes, continue to use this custom property.mixv
javax.sip.transaction.timer.t2
Maximum time in milliseconds before retransmitting non-invite requests and invite responses for timer T2 for the RFC 3261 specification.
| Data type | String |
|---|---|
| Default | 4000 |
Deprecated feature: This custom property is deprecated.
Do not use this custom property unless you are running in a mixed cell environment that includes at least one core group that contains a mixture of v7.0 and v6.x processes.depfeat
Mixed-version environment: If you are running in a mixed cell environment, and we have core groups that contain a mixture of v7.0 and v6.x processes, continue to use this custom property.mixv
javax.sip.transaction.timer.t4
Maximum amount of time, in milliseconds, for a message to remain in the network. This value is used as a base for calculating other timers for timer T4 for the RFC 3261 specification.
| Data type | String |
|---|---|
| Default | 5000 |
Deprecated feature: This custom property is deprecated.
Do not use this custom property unless you are running in a mixed cell environment that includes at least one core group that contains a mixture of v7.0 and v6.x processes.depfeat
Mixed-version environment: If you are running in a mixed cell environment, and we have core groups that contain a mixture of v7.0 and v6.x processes, continue to use this custom property.mixv
on.outgoing.message.replication
Whether changes are buffered until a siplet issues a request.send() or response.send() call. If the value is set to true, then each change is buffered until a siplet issues a request.send() or response.send() call.
| Data type | Boolean |
|---|---|
| Default | false |
pws_atr_name
Specifies the LDAP attribute name that stores the user password.
| Data type | String |
|---|---|
| Default | userpassword |
replicate.with.confirmed.dialog.only
Whether to replicate the application session, even when no dialogs are confirmed. If the value is set to false, then the application session is replicated immediately after the session is created. Otherwise, the application session is only replicated when an associated dialog is confirmed.
| Data type | String |
|---|---|
| Default | False |
sip.container.heartbeat.enabled
Whether or not SIP network outage detection is enabled for the SIP container. SIP network outage detection allows the SIP proxy to send keepalive messages to the SIP container if the value of this property is set to true.
If the value is set to false for the SIP container, then this property has no effect on the SIP proxy. However, if the value is set to true for the SIP container, the value should also be set to true for the SIP proxy to ensure that keepalive messages are answered at the SIP container and not presented to the application.
| Data type | String |
|---|---|
| Default | true |
sip.jsr289.parse.address
Specifies to use the SIP Servlet Specification 1.1, JSR 289 required format for createRequest() and createAddress() methods.
For transitioning users: The JSR 289 API requires that for any SIP URI that contains address parameters, enclose the SIP URI in angle brackets. The default behavior of the sip.jsr289.parse.address property is compliant with JSR 289 and correctly parses the address parameter as if it belongs to the SIP address. For example, when the property is set to false, the SIP address, sip:fred@acme.com;param1=1, is converted to
<sip:fred@acme.com;param1=1>.
When the property is set to true, the SIP address sip:fred@acme.com;param1=1, is converted to
<sip:fred@acme.com;>param1=1. trns
| Data type | String |
|---|---|
| Default | True |
SIP_RFC3263_nameserver
Whether to allow a SIP URI to be resolved through Domain Name System (DNS) into the IP address, port, and transport protocol of the next hop.
The value of the property is a string containing one or two address and port tuples, where two tuples are separated by a space. The following examples specify a one address and port tuple or a two address and port tuple.
- dottedDecimalAddress@.port
- hostname.domain@port
- IPV6address@port
The following example values represent a single tuple.
- 1.2.3.4@53
- example.com@53
- a:b:c::d@53
The following example values represent two tuples separated by a space.
- 1.2.3.4@53 example.com@53
- a:b:c::d@53 9.32.211.14@53
| Data type | String |
|---|---|
| Default | null |
Deprecated feature: This custom property is deprecated.
Do not use this custom property unless you are running in a mixed cell environment that includes at least one core group that contains a mixture of v7.0 and v6.x processes.depfeat
Mixed-version environment: If you are running in a mixed cell environment, and we have core groups that contain a mixture of v7.0 and v6.x processes, continue to use this custom property.mixv
thread.message.queue.max.size
Maximum number of events allowed in the container threads queue. When this number is exceeded, the proxy server is notified that the container is overloaded and requests for new sessions are not accepted. Instead, the container returns an error message that indicates that the container is temporarily unavailable.
This value represents the total number of messages for all queues and reflects the state of the CPU. When the CPU approaches 100%, the maximum value for this custom property is reached quickly. Configure the system to limit the queue size and prevent the queue from reaching this threshold.
| Data type | String |
|---|---|
| Default | 1000 |
weight.overload.watermark
Threshold value for the internal weight calculated by the container. When the container calculates the internal weight to be higher than the value specified, an overloaded container becomes available for service again.
This custom property represents a percentage of the maximum internal weight, such as 30 percent when the default value is set. When the high-water mark, or maximum threshold, is exceeded, the container waits until the weight drops below the maximum weight. This value cannot exceed 10.
| Data type | String |
|---|---|
| Default | 3 |