availability-service (Sun GlassFish Communications Server 1.5 Administration Reference)

Sun GlassFish Communications Server 1.5 Administration Reference

availability-service

Configures the availability service. Enables high-availability features, such as session state and stateful session bean state persistence.

Note –

Some topics in the documentation pertain to features that are available only in domains that are configured to support clusters. Examples of domains that support clusters are domains that are created with the cluster profile. For information about profiles, see Usage Profiles in Sun GlassFish Communications Server 1.5 Administration Guide.

Availability can be enabled or disabled at the following levels:

The server instance (attribute of availability-service). Default is true (enabled).
The EJB or web container (attribute of ejb-container-availability or web-container-availability). Default is true (enabled).
The application (attribute of j2ee-application). Default is false (disabled).
The stand-alone EJB or web module (attribute of ejb-module or web-module). Default is false (disabled).
The stateful session bean. Default is false (disabled). See the Sun GlassFish Communications Server 1.5 Developer’s Guide.

For availability to be enabled at a given level, it must be enabled at all higher levels, as well. For example, to enable availability at the application level, you must also enable it at the server instance and container levels.

Superelements

config

Subelements

The following table describes subelements for the availability-service element.

Table 1–19 availability-service Subelements


Element	Required	Description
web-container-availability	zero or one	Enables availability in the web container.
ejb-container-availability	zero or one	Enables availability in the EJB container.
sip-container-availability	zero or one	Enables availability in the SIP container. This element is not implemented.
converged-load-balancer	zero or one	Defines and configures a converged load balancer.
property	zero or more	Specifies a property or a variable.

Attributes

The following table describes attributes for the availability-service element.

Table 1–20 availability-service Attributes


Attribute	Default	Description
`availability-enabled`	`true`	(optional) If set to `true`, high-availability features apply to all applications 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.

Properties

The following table describes properties for the availability-service element. For more information about replicated session persistence, see web-container-availability and ejb-container-availability.

Table 1–21 availability-service Properties

Attribute

Default

Description

replication_measurement_enabled

false

If true, logs measurements of replication times.

One of these messages appears in the sending instance's log:

messageSendSucceeded: id = session-id fastAckTime = 8  to partner: instance-name
messageSendFailed: id = session-id fastAckTime = 8  to partner: instance-name

This message appears in the receiving instance's log:

messageReceiptSucceeded: bulkId = 1 receiptTime =  12 from partner: instance-name

replication_measurement_interval

1

Specifies the frequency of measurement of replication. It must be a positive integer: 1 means every replication, 2 means once every 2 replications, 3 means once every 3 replications, and so on. Applicable only if replication_measurement_enabled is set to true.