Sun GlassFish Enterprise Server 2.1 Administration Reference

L

lb-config

Defines a load balancer configuration, which can be referenced by a physical load-balancer.

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-configs

Subelements

The following table describes subelements for the lb-config element.

Table 1–101 lb-config Subelements


Element	Required	Description
cluster-ref	zero or more; zero if a `server-ref` is defined	References a cluster. This element contains some attributes related to load balancing.
server-ref	zero or more; zero if a `cluster-ref` is defined	References a server instance that does not belong to a cluster. The referenced server element contains some attributes related to load balancing.
property	zero or more	Specifies a property or a variable.

Attributes

The following table describes attributes for the lb-config element.

Table 1–102 lb-config Attributes


Attribute	Default	Description
`name`	none	Specifies the name of the load balancer configuration.
`response-timeout-in-seconds`	`60`	(optional) Specifies the time within which a server must return a response or it is considered unhealthy.
`https-routing`	`false`	(optional) If `true`, HTTPS requests to the load balancer result in HTTPS requests to the server. If `false`, HTTPS requests to the load balancer result in HTTP requests to the server.
`reload-poll-interval-in-seconds`	`60`	(optional) Specifies the interval between checks for changes to the load balancer configuration file (`loadbalancer.xml`). When changes are detected, the file is reloaded. A value of zero disables reloading.
`monitoring-enabled`	`false`	(optional) If `true`, enables monitoring of load balancing.

lb-configs

Contains load balancer configurations.

Superelements

domain

Subelements

The following table describes subelements for the lb-configs element.

Table 1–103 lb-configs Subelements


Element	Required	Description
lb-config	zero or more	Defines a load balancer configuration.

lifecycle-module

Specifies a deployed lifecycle module. For more information about lifecycle modules, see the Sun GlassFish Enterprise Server 2.1 Developer’s Guide.

Superelements

applications

Subelements

The following table describes subelements for the lifecycle-module element.

Table 1–104 lifecycle-module Subelements


Element	Required	Description
description	zero or one	Contains a text description of this element.
property	zero or more	Specifies a property or a variable.

Attributes

The following table describes attributes for the lifecycle-module element.

Table 1–105 lifecycle-module Attributes


Attribute	Default	Description
`name`	none	The name of the lifecycle module.
`class-name`	none	The fully qualified name of the lifecycle module’s class file, which must implement the `com.sun.appserv.server.LifecycleListener` interface.
`classpath`	value of `application-root` attribute of domain element	(optional) The classpath for the lifecycle module. Specifies where the module is located.
`load-order`	none	(optional) Determines the order in which lifecycle modules are loaded at startup. Modules with smaller integer values are loaded sooner. Values can range from `101` to the operating system’s `MAXINT`. Values from `1` to `100` are reserved.
`is-failure-fatal`	`false`	(optional) Determines whether the server is shut down if the lifecycle module fails.
`object-type`	`user`	(optional) Defines the type of the resource. Allowed values are: `system-all` - A system resource for all server instances and the domain application server. `system-admin` - A system resource only for the domain application server. `system-instance` - A system resource for all server instances only. `user` - A user resource.
`enabled`	`true`	(optional) Determines whether the lifecycle module is enabled.

listener-config

Configures the listener class that listens for alerts from notification emitters. For example:

<listener-config
    listener-class-name="com.sun.enterprise.admin.notification.MailAlert"
    subcribe-listener-with="LogMBean,ServerStatusMonitor" >
    <property name="recipients" value="Huey@sun.com,Dewey@sun.com" />
    <property name="fromAddress" value="Louie@sun.com" />
    <property name="subject" value="Help!" />
    <property name="includeDiagnostics" value="false" />
    <property name="mailSMTPHost" value="ducks.sun.com" />
</listener-config>

Superelements

alert-subscription

Subelements

The following table describes subelements for the listener-config element.

Table 1–106 listener-config Subelements


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

Attributes

The following table describes attributes for the listener-config element.

Table 1–107 listener-config Attributes


Attribute	Default	Description
`listener-class-name`	none	Specifies the class name of the listener. The `com.sun.appserv.admin.notification.MailAlert` class is provided with the Enterprise Server, but a custom listener can be used.
`subscribe-listener-with`	none	Specifies a comma-separated list of notification emitters to which the listener listens. The `LogMBean` and `ServerStatusMonitor` notification emitters are provided with the Enterprise Server, but custom emitters can be used.

load-balancer

Defines and configures a load balancer. For more information about load balancing in the Enterprise Server, see the Sun GlassFish Enterprise Server 2.1 High Availability Administration Guide.

Note –

Superelements

load-balancers

Subelements

The following table describes subelements for the load-balancer element.

Table 1–108 load-balancer Subelements


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

Attributes

The following table describes attributes for the load-balancer element.

Table 1–109 load-balancer Attributes


Attribute	Default	Description
`name`	none	Specifies the name of the load balancer.
`lb-config-name`	none	Specifies the `name` of the lb-config used by the load balancer.
`auto-apply-enabled`	`false`	(optional) If `true`, changes to the specified lb-config are automatically applied to the load balancer.

Properties

The following table describes properties for the load-balancer element.

Table 1–110 load-balancer Properties


Property	Default	Description
`device-host`	none	Specifies the host name or IP address for the load balancer.
`device-admin-port`	none	Specifies the load balancer's administration port number.
`ssl-proxy-host`	none	Specifies the load balancer's proxy host used for outbound HTTP.
`ssl-proxy-port`	none	Specifies the load balancer's proxy port used for outbound HTTP.

load-balancers

Contains load balancers.

Superelements

domain

Subelements

The following table describes subelements for the load-balancers element.

Table 1–111 load-balancers Subelements


Element	Required	Description
load-balancer	zero or more	Defines a load balancer.

log-service

Configures the server log file, which stores messages from the default virtual server. Messages from other configured virtual servers also go here, unless the log-file attribute is explicitly specified in the virtual-server element. The default name is server.log.

Other log files are configured by other elements:

A virtual server log file stores messages from a virtual-server element that has an explicitly specified log-file attribute. See virtual-server.
The access log file stores HTTP access messages from the default virtual server. The default name is access.log. See access-log and http-access-log.
The transaction log files store transaction messages from the default virtual server. The default name of the directory for these files is tx. See transaction-service.

Superelements

config, node-agent

Subelements

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

Table 1–112 log-service Subelements


Element	Required	Description
module-log-levels	zero or one	Specifies log levels.
property	zero or more	Specifies a property or a variable.

Attributes

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

Table 1–113 log-service Attributes


Attribute	Default	Description
`file`	`server.log` in the directory specified by the `log-root` attribute of the domain element	(optional) Overrides the name or location of the server log. The file and directory in which the server log is kept must be writable by the user account under which the server runs. An absolute path overrides the `log-root` attribute of the domain element. A relative path is relative to the `log-root` attribute of the domain element. If no `log-root` value is specified, it is relative to `domain-dir/config` .
`use-system-logging`	`false`	(optional) If `true`, uses the UNIX `syslog` service to produce and manage logs.
`log-handler`	none	(optional) Specifies a custom log handler to be added to end of the chain of system handlers to log to a different destination.
`log-filter`	none	(optional) Specifies a log filter to do custom filtering of log records.
`log-to-console`	`false`	(optional) Deprecated and ignored.
`log-rotation-limit-in-bytes`	`2000000`	(optional) Log files are rotated when the file size reaches the specified limit.
`log-rotation-timelimit-in-minutes`	`0`	(optional) Enables time-based log rotation. The valid range is `60` minutes (1 hour) to `14400` minutes (102460 minutes or 10 days). If the value is zero, the files are rotated based on the size specified in `log-rotation-limit-in-bytes`. If the value is greater than zero, `log-rotation-timelimit-in-minutes` takes precedence over `log-rotation-limit-in-bytes` .
`retain-error-statistics-for-hours`	`5`	(optional) Specifies the number of most recent hours for which error statistics are retained in memory. The default and minimum value is `5` hours. The maximum value allowed is `500` hours. Larger values incur additional memory overhead.