sip-container-availability (Sun GlassFish Communications Server 2.0 Administration Reference)

Sun GlassFish Communications Server 2.0 Administration Reference

sip-container-availability

Enables availability in the SIP container, including replicated session persistence.

If availability is disabled, there is no high availability for session persistence.

If availability is enabled, the hard-coded session persistence configuration is as follows:

persistence-type=replicated
persistence-frequency=sip-transaction
persistence-scope=session

For additional replicated session persistence properties you can set, see availability-service.

The following table describes subelements for the sip-container-availability element.

Table 1–193 sip-container-availability Subelements


Element	Required	Description
property	zero or more	Specifies a property or a variable.

The following table describes attributes for the sip-container-availability element.

Table 1–194 sip-container-availability Attributes


Attribute	Default	Description
`availability-enabled`	`true`	(optional) If set to `true`, and if availability is enabled for the server instance (see availability-service), high-availability features apply to all SIP extension modules deployed to the server instance that do not have availability disabled. All instances in a cluster should have the same availability value to ensure consistent behavior.
`persistence-type`	`memory` (availability disabled) `replicated` (availability enabled)	(optional) Specifies the session persistence mechanism for SIP extension modules that have availability enabled. Allowed values are `memory` (no persistence) and `replicated` (other servers).
`persistence-frequency`	`sip-transaction`	(optional) Specifies how often the session state is stored. The default, `sip-transaction`, is the only allowed value. The session state is stored at the end of each request prior to sending a response back to the client. This provides the best guarantee that the session state is fully updated in case of failure.
`persistence-scope`	`session`	(optional) Specifies how much of the session state is stored. The default, `session`, is the only allowed value. The entire session state is stored every time.
`repair-during-failure`	`false`	(optional) Deprecated. If `true`, specifies that a forward and reverse repair should be performed on an instance that has joined or rejoined the cluster.

The following table describes properties for the sip-container-availability element.

Table 1–195 sip-container-availability Properties


Property	Default	Description
`uuid-impl-class`	none	Specifies the name of the class that generates session IDs. If this property is not specified, the Communications Server's internal session ID generator is used. It is the developer's responsibility to ensure that generated IDs are universally unique even when running on multiple JVMs on multiple machines in a cluster. Failure to ensure this in the algorithm results in nondeterministic behavior and likely corruption of session data.