Exit Print View

Sun GlassFish Enterprise Server v3 Domain File Format Reference

  This Document Entire Library
Print View

Document Information

Preface

1.  The domain.xml File

About the domain.xml File

Verification

Extensibility

Backup

Default Values

Variables

Element Referencing

Element Hierarchy

Alphabetical List of Elements

A

access-log

Superelements

Subelements

Attributes

admin-object-resource

Superelements

Subelements

Attributes

Properties

admin-service

Superelements

Subelements

Attributes

appclient-module

Superelements

Subelements

Attributes

application

Superelements

Subelements

Attributes

Properties

application-ref

Superelements

Subelements

Attributes

applications

Superelements

Subelements

audit-module

Superelements

Subelements

Attributes

Properties

auth-realm

Superelements

Subelements

Attributes

Properties

B

backend-principal

Superelements

Subelements

Attributes

C

config

Superelements

Subelements

Attributes

configs

Superelements

Subelements

connection-pool

Superelements

Subelements

Attributes

connector-connection-pool

Superelements

Subelements

Attributes

Properties

connector-module

Superelements

Subelements

Attributes

connector-resource

Superelements

Subelements

Attributes

connector-service

Superelements

Subelements

Attributes

context-param

Superelements

Subelements

Attributes

custom-resource

Superelements

Subelements

Attributes

D

das-config

Superelements

Subelements

Attributes

description

Superelements

Subelements

domain

Superelements

Subelements

Attributes

E

ejb-container

Superelements

Subelements

Attributes

ejb-module

Superelements

Subelements

Attributes

ejb-timer-service

Superelements

Subelements

Attributes

engine

Superelements

Subelements

Attributes

env-entry

Superelements

Subelements

Attributes

env-entry-name

Superelements

Subelements

env-entry-type

Superelements

Subelements

env-entry-value

Superelements

Subelements

extension-module

Superelements

Subelements

Attributes

external-jndi-resource

Superelements

Subelements

Attributes

F

file-cache

Superelements

Subelements

Attributes

G

group-map

Superelements

Subelements

Attributes

H

http

Superelements

Subelements

Attributes

http-access-log

Superelements

Subelements

Attributes

http-file-cache

Superelements

Subelements

Attributes

http-listener

Superelements

Subelements

Attributes

Properties

http-protocol

Superelements

Subelements

Attributes

http-service

Superelements

Subelements

Attributes

Properties

I

iiop-listener

Superelements

Subelements

Attributes

iiop-service

Superelements

Subelements

Attributes

J

j2ee-application

Superelements

Subelements

Attributes

jacc-provider

Superelements

Subelements

Attributes

Properties

java-config

Superelements

Subelements

Attributes

jdbc-connection-pool

Superelements

Subelements

Attributes

Properties

jdbc-resource

Superelements

Subelements

Attributes

jms-host

Superelements

Subelements

Attributes

jms-service

Superelements

Subelements

Attributes

Properties

jmx-connector

Superelements

Subelements

Attributes

jruby-container

Superelements

Subelements

Attributes

jruby-runtime-pool

Superelements

Subelements

Attributes

jvm-options

Superelements

Subelements

K

keep-alive

Superelements

Subelements

Attributes

L

lifecycle-module

Superelements

Subelements

Attributes

log-service

Superelements

Subelements

Attributes

Properties

M

mail-resource

Superelements

Subelements

Attributes

Properties

manager-properties

Superelements

Subelements

Attributes

mdb-container

Superelements

Subelements

Attributes

Properties

message-security-config

Superelements

Subelements

Attributes

module

Superelements

Subelements

Attributes

module-log-levels

Superelements

Subelements

Attributes

module-monitoring-levels

Superelements

Subelements

Attributes

monitoring-service

Superelements

Subelements

N

network-config

Superelements

Subelements

network-listener

Superelements

Subelements

Attributes

network-listeners

Superelements

Subelements

O

orb

Superelements

Subelements

Attributes

P

param-name

Superelements

Subelements

param-value

Superelements

Subelements

port-unification

Superelements

Subelements

Attributes

principal

Superelements

Subelements

principal-map

Superelements

Subelements

Attributes

profiler

Superelements

Subelements

Attributes

property

Superelements

Subelements

Attributes

protocol

Superelements

Subelements

Attributes

protocol-chain

Superelements

Subelements

Attributes

protocol-chain-instance-handler

Superelements

Subelements

Attributes

protocol-filter

Superelements

Subelements

Attributes

protocol-finder

Superelements

Subelements

Attributes

protocols

Superelements

Subelements

provider-config

Superelements

Subelements

Attributes

Properties

R

registry-location

Superelements

Subelements

Attributes

request-policy

Superelements

Subelements

Attributes

request-processing

Superelements

Subelements

Attributes

resource-adapter-config

Superelements

Subelements

Attributes

Properties

resource-ref

Superelements

Subelements

Attributes

resources

Superelements

Subelements

response-policy

Superelements

Subelements

Attributes

S

security-map

Superelements

Subelements

Attributes

security-service

Superelements

Subelements

Attributes

selection-key-handler

Superelements

Subelements

Attributes

server

Superelements

Subelements

Attributes

servers

Superelements

Subelements

session-config

Superelements

Subelements

session-manager

Superelements

Subelements

session-properties

Superelements

Subelements

Attributes

Properties

ssl

Superelements

Subelements

Attributes

ssl-client-config

Superelements

Subelements

store-properties

Superelements

Subelements

Attributes

system-applications

Superelements

Subelements

system-property

Superelements

Subelements

Attributes

Properties

T

thread-pool

Superelements

Subelements

Attributes

thread-pools

Superelements

Subelements

transaction-service

Superelements

Subelements

Attributes

Properties

transformation-rule

Superelements

Subelements

Attributes

transport

Superelements

Subelements

Attributes

transports

Superelements

Subelements

U

user-group

Superelements

Subelements

V

virtual-server

Superelements

Subelements

Attributes

Properties

W

web-container

Superelements

Subelements

Properties

web-module

Superelements

Subelements

Attributes

web-module-config

Superelements

Subelements

web-service-endpoint

Superelements

Subelements

Attributes

work-security-map

Superelements

Subelements

Attributes

Index

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 Sun GlassFish Enterprise Server v3 Application Development Guide.

Superelements

applications

Subelements

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

lifecycle-module Subelements
Element
Required
Description
zero or one
Contains a text description of this element.
zero or more
Specifies a property or a variable.
Attributes

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

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:

Superelements

config

Subelements

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

log-service Subelements
Element
Required
Description
zero or one
Specifies log levels.
zero or more
Specifies a property or a variable.
Attributes

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

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 (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 .

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.

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.