Oracle GlassFish Server 3.0.1 Domain File Format Reference

L

`lifecycle-module`

This element is deprecated. Use an application element instead.

Specifies a deployed lifecycle module. For more information about lifecycle modules, see the Oracle GlassFish Server 3.0.1 Application Development Guide.

Superelements

applications

Subelements

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

Table 1–94 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–95 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. For a lifecycle module, the only allowed value is `user`.
`enabled`	`true`	(optional) Determines whether the lifecycle module is enabled.

`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 or access-log 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

Subelements

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

Table 1–96 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–97 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`	`java.util.logging.ConsoleHandler`	(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` .
`alarms`	`false`	(optional) If `true`, displays alarms for `module-log-levels` values of `WARNING` or `SEVERE`.
`retain-error-statistics-for-hours`	`0`	(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.

Properties

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

Table 1–98 log-service Properties


Attribute	Default	Description
`max-queue-size`	`5000`	Specifies the number of entries the log queue holds. When the log queue is full, the system blocks until a record is written to the log file. Changing this property requires a server restart.
`flush-frequency`	`1`	Specifies the maximum number of messages written from the log queue to the log file at once.