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

M

mail-resource

Defines a JavaMail (javax.mail.Session) resource.

Superelements

resources

Subelements

The following table describes subelements for the mail-resource element.

mail-resource 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 mail-resource element.

mail-resource Attributes
Attribute
Default
Description
jndi-name
none
Specifies the JNDI name for the resource.
store-protocol
imap
(optional) Specifies the storage protocol service, which connects to a mail server, retrieves messages, and saves messages in folder(s). Allowed values are imap, pop3, imaps, and pop3s .
store-protocol-class
com.sun.mail.imap.IMAPStore
(optional) Specifies the service provider implementation class for storage. Allowed values are:

com.sun.mail.imap.IMAPStore

com.sun.mail.pop3.POP3Store

com.sun.mail.imap.IMAPSSLStore

com.sun.mail.pop3.POP3SSLStore

transport-protocol
smtp
(optional) Specifies the transport protocol service, which sends messages. Allowed values are smtp and smtps.
transport-protocol-class
com.sun.mail.smtp.SMTPTransport
(optional) Specifies the service provider implementation class for transport. Allowed values are:

com.sun.mail.smtp.SMTPTransport

com.sun.mail.smtp.SMTPSSLTransport

host
none
The mail server host name.
user
none
The mail server user name.
from
none
The email address the mail server uses to indicate the message sender.
debug
false
(optional) Determines whether debugging for this resource is enabled.
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 this resource is enabled at runtime.
Properties

You can set properties for the mail-resource element and then get these properties in a JavaMail Session object later. Every property name must start with a mail- prefix. The Enterprise Server changes the dash (-) character to a period (.) in the name of the property, then saves the property to the MailConfiguration and JavaMail Session objects. If the name of the property doesn’t start with mail-, the property is ignored.

For example, to define the property mail.password in a JavaMail Session object, first edit domain.xml as follows:

...
 <mail-resource jndi-name="mail/Session" ...>
     <property name="mail-password" value="adminadmin"/>
 </mail-resource>
 ...

After getting the JavaMail Session object, get the mail.password property to retrieve the value adminadmin, as follows:

String password = session.getProperty("mail.password");

For more information about JavaMail properties, see JavaMail API Documentation.

manager-properties

Specifies session manager properties.

Superelements

session-manager

Subelements

The following table describes subelements for the manager-properties element.

manager-properties Subelements
Element
Required
Description
zero or more
Specifies a property or a variable.
Attributes

The following table describes attributes for the manager-properties element.

manager-properties Attributes
Attribute
Default
Description
session-file-name
none; state is not preserved across restarts
(optional) Specifies the absolute or relative path to the directory in which the session state is preserved between application restarts, if preserving the state is possible. A relative path is relative to the temporary directory for this web application.

To disable this behavior and not preserve the session state, specify an empty string as the value of this attribute.

reap-interval-in-seconds
60
(optional) Specifies the time between checks for expired sessions.

If the persistence-frequency attribute of the web-container-availability element is set to time-based, active sessions are stored at this interval.

Set this value lower than the frequency at which session data changes. For example, this value should be as low as possible (1 second) for a hit counter servlet on a frequently accessed web site, or you could lose the last few hits each time you restart the server.

max-sessions
-1
(optional) Specifies the maximum number of sessions that can be in cache, or -1 for no limit. After this, an attempt to create a new session causes an IllegalStateException to be thrown.
session-id-generator-classname
internal class generator
(optional) Not implemented.

mdb-container

Configures the message-driven bean (MDB) container.

Superelements

config

Subelements

The following table describes subelements for the mdb-container element.

mdb-container Subelements
Element
Required
Description
zero or more
Specifies a property or a variable.
Attributes

The following table describes attributes for the mdb-container element.

mdb-container Attributes
Attribute
Default
Description
steady-pool-size
10
(optional) Specifies the initial and minimum number of beans maintained in the pool.
pool-resize-quantity
2
(optional) Specifies the number of beans to be removed when the idle-timeout-in-seconds timer expires. A cleaner thread removes any unused instances.

Must be 0 or greater and less than max-pool-size . The pool is not resized below the steady-pool-size.

max-pool-size
60
(optional) Specifies the maximum number of beans that can be created to satisfy client requests.
idle-timeout-in-seconds
600
(optional) Specifies the maximum time that a bean can remain idle in the pool. After this amount of time, the bean is destroyed. A value of 0 means a bean can remain idle indefinitely.
Properties

The following table describes properties for the mdb-container element.

mdb-container Properties
Property
Default
Description
cmt-max-runtime-exceptions
1
Specifies the maximum number of RuntimeException occurrences allowed from a message-driven bean’s onMessage() method when container-managed transactions are used. Deprecated.

message-security-config

Specifies configurations for message security providers.

Superelements

security-service

Subelements

The following table describes subelements for the message-security-config element.

message-security-config Subelements
Element
Required
Description
one or more
Specifies a configuration for one message security provider.
Attributes

The following table describes attributes for the message-security-config element.

message-security-config Attributes
Attribute
Default
Description
auth-layer
HttpServlet
Specifies the message layer at which authentication is performed. The value must be SOAP or HttpServlet.
default-provider
none
(optional) Specifies the server provider that is invoked for any application not bound to a specific server provider.
default-client-provider
none
(optional) Specifies the client provider that is invoked for any application not bound to a specific client provider.

module

Defines a stand-alone module or a component of a Java EE application.

An engine runs a sniffer during deployment, which is responsible for identifying a type of deployment artifact (such as a WAR file) and setting up the associated container (such as the web container). Multiple engines, each with its own sniffer, can be associated with a given module.

Superelements

application

Subelements

The following table describes subelements for the module element.

module Subelements
Element
Required
Description
one or more
Specifies an engine.
zero or more
Specifies a property or a variable.
Attributes

The following table describes attributes for the module element.

module Attributes
Attribute
Default
Description
name
none
The name of the module.

module-log-levels

Controls the level of messages logged by server subsystems to the server log. Allowed values (levels) of each subsystem attribute are, from highest to lowest: FINEST , FINER, FINE, CONFIG, INFO, WARNING, SEVERE, and OFF. Each value logs all messages for all lower values. The default value is INFO, which logs all INFO, SEVERE , and WARNING messages.

Superelements

log-service

Subelements

The following table describes subelements for the module-log-levels element.

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

The following table describes attributes for the module-log-levels element. The attribute names are the names of the Enterprise Server system loggers.

module-log-levels Attributes
Attribute
Default
Description
root
INFO
(optional) Specifies the default level of messages logged by the entire Enterprise Server installation.
server
INFO
(optional) Specifies the default level of messages logged by the server instance.
ejb-container
INFO
(optional) Specifies the level of messages logged by the EJB container.
cmp-container
INFO
(optional) Specifies the level of messages logged by the CMP subsystem of the EJB container.
mdb-container
INFO
(optional) Specifies the level of messages logged by the MDB container.
web-container
INFO
(optional) Specifies the level of messages logged by the web container.
classloader
INFO
(optional) Specifies the level of messages logged by the classloader hierarchy.
configuration
INFO
(optional) Specifies the level of messages logged by the configuration subsystem.
naming
INFO
(optional) Specifies the level of messages logged by the naming subsystem.
security
INFO
(optional) Specifies the level of messages logged by the security subsystem.
jts
INFO
(optional) Specifies the level of messages logged by the Java Transaction Service.
jta
INFO
(optional) Specifies the level of messages logged by the Java Transaction API.
admin
INFO
(optional) Specifies the level of messages logged by the Administration Console subsystem.
deployment
INFO
(optional) Specifies the level of messages logged by the deployment subsystem.
verifier
INFO
(optional) Specifies the level of messages logged by the deployment descriptor verifier.
jaxr
INFO
(optional) Specifies the level of messages logged by the XML registry.
jaxrpc
INFO
(optional) Specifies the level of messages logged by the XML RPC module.
saaj
INFO
(optional) Specifies the level of messages logged by the SOAP with Attachments API for Java module.
corba
INFO
(optional) Specifies the level of messages logged by the ORB.
javamail
INFO
(optional) Specifies the level of messages logged by the JavaMail subsystem.
jms
INFO
(optional) Specifies the level of messages logged by the Java Message Service.
connector
INFO
(optional) Specifies the level of messages logged by the connector subsystem.
jdo
INFO
(optional) Specifies the level of messages logged by the Java Data Objects module.
cmp
INFO
(optional) Specifies the level of messages logged by the CMP subsystem.
util
INFO
(optional) Specifies the level of messages logged by the utility subsystem.
resource-adapter
INFO
(optional) Specifies the level of messages logged by the resource adapter subsystem.
synchronization
INFO
(optional) Specifies the level of messages logged by the synchronization subsystem.
node-agent
INFO
(optional) Specifies the level of messages logged by the node agent subsystem.
self-management
INFO
(optional) Specifies the level of messages logged by the self-management (management rules) subsystem.
group-management-service
INFO
(optional) Specifies the level of messages logged by the Group Management Service.
management-event
INFO
(optional) Specifies the level of messages logged by the self-management event subsystem.

module-monitoring-levels

Controls the level of monitoring of server subsystems. Allowed values of each subsystem attribute are LOW, HIGH, and OFF.

Superelements

monitoring-service

Subelements

The following table describes subelements for the module-monitoring-levels element.

module-monitoring-levels Subelements
Element
Required
Description
zero or more
Specifies a property or a variable.
Attributes
module-monitoring-levels Attributes
Attribute
Default
Description
thread-pool
OFF
(optional) Specifies the level of monitoring of the thread pool subsystem.
orb
OFF
(optional) Specifies the level of monitoring of the ORB.
ejb-container
OFF
(optional) Specifies the level of monitoring of the EJB container.
web-container
OFF
(optional) Specifies the level of monitoring of the web container.
transaction-service
OFF
(optional) Specifies the level of monitoring of the transaction service.
http-service
OFF
(optional) Specifies the level of monitoring of the HTTP service.
jdbc-connection-pool
OFF
(optional) Specifies the level of monitoring of the JDBC connection pool subsystem.
connector-connection-pool
OFF
(optional) Specifies the level of monitoring of the connector connection pool subsystem.
connector-service
OFF
(optional) Specifies the level of monitoring of the connector service.
jms-service
OFF
(optional) Specifies the level of monitoring of the JMS service.
jvm
OFF
(optional) Specifies the level of monitoring of the JVM subsystem.

monitoring-service

Configures the monitoring service.

Superelements

config

Subelements

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

monitoring-service Subelements
Element
Required
Description
zero or one
Controls the level of monitoring of server subsystems.
zero or more
Specifies a property or a variable.