Configuration

Transports

String

"UDP,TCP"

A comma-separated list containing supported SIP transports (one or more of UDP, TCP). The SIP Protocol Adaptor will open listen sockets for these transports. The first transport on the list will be used in the "transport" field of Via header in outgoing request when set as AUTO in a scenario.

Port

Integer

5060

Port that will be used for unencrypted SIP transports (UDP, TCP).

SecurePort

Integer

5061

Port that will be used for encrypted SIP transports (TLS). CAUTION: In current version of SIP Scenario Pack TLS is not supported.

ViaSentByAddress

String

null

Specifies an address (IP address or hostname) that will be used in the "address" field of Via header in outgoing request when set as AUTO in a scenario. By default this property is null, and the SIP Protocol Adaptor will use the local IP address of the endpoint.

AckRetransmitTimer

Long

32000

Specifies the duration (ms) after which a processed ACK will be removed from the internal cache, which affects the ACK/200 OK response retransmit behaviour. For the client, the SIP Protocol Adaptor will retransmit an ACK (if cached) on each matching final response retransmission to INVITE. For the server, it will retransmit an 200 OK response until it receives (caches for filtering out future retransmissions) a matching ACK.

Rel1xxRetransmitTimer

Long

32000

Specifies the duration (ms) of the 1xx (provisional) reliable responses retransmit timer. The SIP Protocol Adaptor will retransmit an 1xx reliable response until it receives a matching PRACK request or the associated timer expires.

ServerTransactionTimeout

Long

32000

The duration (ms) for which the SIP Protocol Adaptor will do automatic expiration any pending (which remain in state Trying/Proceeding) server transactions.

CcmWorkaroundEnabled

Boolean

false

The workaround for Cisco Call Manager, which may not have unique branch IDs. Use from-tag as an additional field in the transaction ID, to make it unique.

StackName

String

"OCSIP"

Sets a user friendly name to identify the underlying SIP Stack implementation to the property value i.e. "alice". The stack name should contain no spaces.

OutboundProxy

String

null

Sets the outbound proxy of the SIP Stack. The format for this string is "ipaddress:port/transport" i.e. 129.1.22.333:5060/UDP.

Automatic100TryingSupport

Boolean

false

If enabled, the SIP Stack will automatically generate 100 Trying responses for INVITEs.

ErrorResponsesAckSuppression

Boolean

false

If enabled, the SIP Stack will suppress, and not pass up to the SIP Protocol Adaptor, incoming ACKs to error (3xx-6xx) responses to INVITEs. CAUTION: If enabled, ACKs to error responses should not be defined in scenarios.

MaxContentLength

Integer

131072

The maximum length (bytes) of SIP messages.

WorkerPoolSize

Integer

4

Number of worker threads the SIP Stack will use to process incoming messages. If zero, the SIP Protocol Adaptor will receive and process messages in the same I/O thread. Otherwise, the pool will be used so that incoming messages can be processed concurrently.

WorkerQueueSize

Integer

50

Queue size for the worker thread pool. If the queue fills then the SIP Stack will drop packets (UDP) or temporarily suspend reads (TCP).

TcpIoThreads

Integer

1

Number of threads for handling TCP I/O. TCP connections will be divided between the I/O threads.

TcpListenBacklog

Integer

0

Size of listen backlog queue for TCP server sockets. Increase to allow the server to accept more concurrent connection requests. A value less than or equal to 0 means use the Java platform’s default.

AllowLoopbackSend

Boolean

false

Allow the SIP Stack to send SIP messages to itself. Disabled by default.

Rfc3263FailoverEnabled

Boolean

false

Specifies whether to use RFC 3263 failover. By default this is disabled, to match existing behaviour. If enabled, the SIP Stack 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.

Rfc3263FailoverTimer

Long

10000

Specifies the duration (ms) of the failover timer. If RFC 3263 failover is enabled and this timer expires before any responses were received, the SIP Stack 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.

Rfc3263BlacklistTimer

Long

300000

The duration (ms) for which a server will be blacklisted after a failure is detected. This avoids the SIP Stack 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 Retry-After duration in a 503 response, that value will be used instead.