cluster-ref (Sun GlassFish Enterprise Server 2.1 Administration Reference)

Sun GlassFish Enterprise Server 2.1 Administration Reference

cluster-ref

References a cluster.

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 or the enterprise profile. For information about profiles, see Usage Profiles in Sun GlassFish Enterprise Server 2.1 Administration Guide.

Superelements

lb-config

Subelements

The following table describes subelements for the cluster-ref element.

Table 1–25 cluster-ref Subelements


Element	Required	Description
health-checker	zero or one	Defines a health checker for the referenced cluster.

Attributes

The following table describes attributes for the cluster-ref element.

Table 1–26 cluster-ref Attributes


Attribute	Default	Description
`ref`	none	References the `name` attribute of a cluster element.
`lb-policy`	`round-robin`	(optional) Specifies the load balancing policy. Allowed values are: `round-robin` — The load balancer cycles through the cluster's server instances in a specified order. `weighted-round-robin` — The load balancer cycles through the server instances in a specified order, but routes more requests to instances with greater processing capacity. Processing capacity is represented by values of the `lb-weight` attribute of each server element referenced by the cluster. `user-defined` — The load balancing policy is defined in a custom module.
`lb-policy-module`	none	(optional) Specifies the absolute path to the shared library that implements the user-defined policy. The shared library must exist and be readable on the machine where the load balancer is running. Required only if `lb-policy` is set to `user-defined`.