Sun Java System Application Server Platform Edition 9 Administration Reference

L

lifecycle-module

Specifies a deployed lifecycle module. For more information about lifecycle modules, see the Sun Java System Application Server Platform Edition 9 Developer’s Guide.

Superelements

applications

Subelements

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

Table 1–81 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–82 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 server 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. 

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–83 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–84 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 Application 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 Application Server, but custom emitters can be used.

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:

Superelements

config

Subelements

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

Table 1–85 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–86 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 (10*24*60 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.