These configuration properties may be specified when creating or updating an RA entity (createRAEntity
and updateRAEntityConfigProperties
management commands).
Name | Type | Default Value | Reconfigurable while active? | Description |
---|---|---|---|---|
config-profile |
String |
None, a value must be supplied on RA entity creation. |
✅ |
The ProfileID of the Configuration Profile that will be used to configure this RA entity. The string must be in the form "table-name/profile-name". |
WorkerPoolSize |
Integer |
4 |
❌ |
Number of worker threads the SIP Servlet RA will use to process incoming messages. If zero, the RA will process messages in the receiving I/O thread. Otherwise, messages will be handed off to the pool so they can be processed concurrently. |
WorkerQueueSize |
Integer |
500 |
❌ |
Queue size for the worker thread pool. If the queue fills, then the RA will drop packets (UDP) or temporarily suspend socket reads (TCP). |
TCPIOThreads |
Integer |
1 |
❌ |
Number of threads for handling TCP I/O. TCP connections will be divided between the I/O threads. |
AllowLoopbackSend |
Boolean |
false |
❌ |
Controls whether the RA may send SIP requests to its own addresses. Disabled by default to prevent accidental loops. |
Automatic100TryingSupport |
Boolean |
true |
✅ |
If enabled, the RA will automatically generate 100 Trying responses for INVITEs. |
OffsetPorts |
Boolean |
false |
❌ |
Required if running multiple cluster nodes on the same host. If true, the RA will automatically add an offset to each SIP network interface port, so that each RA instance gets a different port number. See |
PortOffset |
Integer |
0 |
❌ |
Required when running multiple cluster nodes on the same host. If |
fiber-pool.core-pool-size |
Integer |
2 |
✅ |
The RA’s fiber pool is a thread pool used for ordering execution of tasks within the SIP Servlet implementation. The core pool size is the minimum size of this thread pool. |
fiber-pool.max-pool-size |
Integer |
8 |
✅ |
The maximum number of threads that may be used by the fiber pool. |
fiber-pool.queue-size |
Integer |
500 |
✅ |
The maximum size of the fiber pool’s input queue. |
RFC3263:failover_enabled |
Boolean |
false |
❌ |
Specifies whether to use RFC 3263 Failover & Load Balancing. By default this is disabled, to match existing behaviour. If enabled, the RA uses RFC 3263 DNS procedures to find possible servers and automatically fails over to backup servers where available. If multiple servers are found in DNS, they are sorted and tried according to their SRV priority and weight as per RFC 2782. If disabled, the DNS procedures are still used to find server addresses, but only the first address is used. |
RFC3263:failover_timer |
Long |
10000 |
❌ |
Specifies the duration of the failover timer in milliseconds. If RFC 3263 failover is enabled and this timer expires before any responses were received, the RA treats this as a transport error and tries sending the request to the next available server. This timer should be set to a value smaller than the default Timer B and Timer F timers (32s) so that failures can be detected promptly. A value of zero or less disables this timer. |
RFC3263:blacklist_timer |
Long |
300000 |
❌ |
The duration in milliseconds for which a server will be blacklisted after a failure is detected.
This avoids the RA trying to use the server immediately after a failure when it is most likely just going to fail again.
After this time has passed the failed server may be tried again on subsequent client transactions.
If a server specifies a |
SSL/TLS Properties
These properties are only used if a network interface is configured to use the TLS transport.
Name | Type | Default Value | Reconfigurable while active? | Description |
---|---|---|---|---|
Keystore |
String |
${rhino.dir.base}/ sipservlet-data/ sipservlet.keystore |
❌ |
The name of a keystore file used to store private key material. |
KeystoreType |
String |
jks |
❌ |
The type of keystore implementation. |
KeystorePassword |
String |
Empty string (no password). |
❌ |
Password to unlock the keystore. |
Truststore |
String |
${rhino.dir.base}/ sipservlet-data/ sipservlet.keystore |
❌ |
The name of a truststore file containing trusted CA certificates. May be same as |
TruststoreType |
String |
jks |
❌ |
|
TruststorePassword |
String |
Empty string |
❌ |
Password to unlock the truststore. |
CRLURL |
String |
None. |
❌ |
The location of a certificate revocation list. |
CRLRefreshTimeout |
Integer |
86400 |
❌ |
The certificate revocation list refresh timeout, in seconds. |
CRLLoadFailureRetryTimeout |
Integer |
900 |
❌ |
The certificate revocation list load failure timeout, in seconds. |
CRLNoCRLLoadFailure RetryTimeout |
Integer |
60 |
❌ |
The certificate revocation list load failure retry timeout, in seconds. |
ClientAuthentication |
String |
NEED |
❌ |
Indicate whether clients need to be authenticated against certificates in the truststore, must be one of
|
EnabledCipherSuites |
String |
❌ |
Comma-separated list of cipher suites to enable on all TLS sockets. If empty, the JVM’s default cipher suites will be used. See Java SE 6 cipher suites. |