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

T

thread-pool

Defines a thread pool.

Superelements

thread-pools

Subelements

The following table describes subelements for the thread-pool element.

thread-pool Subelements
Element
Required
Description
zero or more
Specifies a property or a variable.
Attributes
thread-pool Attributes
Attribute
Default
Description
name
none
Specifies the thread pool name.
classname
com.sun.grizzly.http.StatsThreadPool
(Optional) Specifies the class name of the thread pool implementation.
min-thread-pool-size
2
(optional) Specifies the minimum number of threads in the pool. These are created when the thread pool is instantiated.
max-thread-pool-size
5
(optional) Specifies the maximum number of threads the pool can contain. To optimize this thread pool for use with an iiop-listener, set this value to 200.
idle-thread-timeout-seconds
900
(optional) Specifies the amount of time after which idle threads are removed from the pool.
max-queue-size
4096
(optional) Specifies the maximum number of messages that can be queued until threads are available to process them for , network-listener or iiop-listener elements. A value of -1 specifies no limit.

thread-pools

Contains thread pools.

Superelements

config

Subelements

The following table describes subelements for the thread-pools element.

thread-pools Subelements
Element
Required
Description
one or more
Defines a thread pool.

transaction-service

Configures the Java Transaction Service (JTS).

Superelements

config

Subelements

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

transaction-service Subelements
Element
Required
Description
zero or more
Specifies a property or a variable.
Attributes

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

transaction-service Attributes
Attribute
Default
Description
automatic-recovery
false
(optional) If true, the server instance attempts transaction recovery during startup.
timeout-in-seconds
0
(optional) Specifies the amount of time after which the transaction is aborted. If set to 0, the transaction never times out.
tx-log-dir
directory specified by the log-root attribute of the domain element
(optional) Specifies the parent directory of the transaction log directory instance-name/tx. The directory in which the transaction logs are kept must be writable by the user account under which the server runs. A relative path is relative to the log-root attribute of the domain element.
heuristic-decision
rollback
(optional) If the outcome of a distributed transaction cannot be determined because other participants are unreachable, this property determines the outcome. Allowed values are rollback and commit.
retry-timeout-in-seconds
600
(optional) Determines the retry time in the following scenarios:
  • At the transaction recovery time, if resources are unreachable.

  • If there are any transient exceptions in the second phase of a two phase commit protocol.

    A negative value specifies infinite retries. A value of 0 (zero) specifies no retries. A positive value indicates the time after which a retry is attempted.

keypoint-interval
65536 (64 K)
(optional) Specifies the number of transactions between keypoint operations in the log. Keypoint operations reduce the size of the transaction log file by compressing it. A larger value for this attribute results in a larger transaction log file, but fewer keypoint operations and potentially better performance. A smaller value results in smaller log files, but slightly reduced performance due to the greater frequency of keypoint operations.
Properties

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

transaction-service Properties
Property
Default
Description
oracle-xa-recovery-workaround
true
If true, the Oracle XA Resource workaround is used in transaction recovery.
disable-distributed-transaction-logging
false
If true, disables transaction logging, which might improve performance.

If the automatic-recovery attribute is set to true , this property is ignored.

xaresource-txn-timeout
specific to the XAResource used
Changes the XAResource timeout. In some cases, the XAResource default timeout can cause transactions to be aborted, so it is desirable to change it.
pending-txn-cleanup-interval
none if this property is absent, 60 if this property is present but has no value
Specifies the interval, in seconds, at which an asynchronous thread checks for pending transactions and completes them.
use-last-agent-optimization
true
If true, enables last agent optimization, which improves the throughput of transactions. If one non-XA resource is used with XA resources in the same transaction, the non XA resource is the last agent.
db-logging-resource
none
Specifies the JNDI name of the JDBC resource for the database to which transactions are logged. For more information, see Chapter 15, Using the Transaction Service, in Sun GlassFish Enterprise Server v3 Application Development Guide.
xa-servername
host name on which the Enterprise Server runs
Specifies the host name that the transaction service uses to identify transactions being managed by the installed Enterprise Server. This can sometimes be useful for recovering transactions from the log file that was created on a different host running the Enterprise Server.

transformation-rule

This element is deprecated. Web services are implemented in the engine element.

Configures an eXtensible Stylesheet Language Transformation (XSLT) rule, which transforms a web service message.

Superelements

web-service-endpoint

Subelements

The following table describes subelements for the transformation-rule element.

transformation-rule Subelements
Element
Required
Description
zero or one
Contains a text description of this element.
Attributes

The following table describes attributes for the transformation-rule element.

transformation-rule Attributes
Attribute
Default
Description
name
none
The name of the rule.
enabled
true
(optional) Determines whether the rule is enabled.
apply-to
request
(optional) Specifies whether the rule is applied to the request, the response, or both. Allowed values are:
  • request - Transformations are applied to the request in the order specified.

  • response - Transformations are applied to the response in the order specified.

  • both - Transformations are applied to both the request and the response. The order is reversed for the response.

rule-file-location
domain-dir/generated/xml/app-or-module/xslt-file
A fully qualified or relative path to the rule file that performs the transformation. Only XSLT files are allowed.

transport

Configures a transport. You can configure a TCP or UDP transport or provide a custom transport implementation.

Superelements

transports

Subelements

none

Attributes

The following table describes attributes for the transport element.

transport Attributes
Attribute
Default
Description
name
none
Specifies a unique name for the transport.
classname
com.sun.grizzly.TCPSelectorHandler
(Optional) Specifies the class name of the transport implementation.
selection-key-handler
none
(optional) Specifies the name of the selection-key-handler associated with this transport.
idle-key-timeout-seconds
30
(Optional) Specifies the idle key timeout.
read-timeout-millis
30000 (30 seconds)
(optional) Specifies the amount of time the Enterprise Server waits during the header and body parsing phase.
write-timeout-millis
30000 (30 seconds)
(optional) Specifies the amount of time the Enterprise Server waits before considering the remote client disconnected when writing the response.
selector-poll-timeout-millis
1000 (1 second)
(optional) Specifies the time a NIO Selector blocks waiting for events (user requests).
display-configuration
false
(optional) If true, flushes the internal network configuration to the server log. Useful for debugging, but reduces performance.
snoop-enabled
false
(optional) If true, writes request/response information to the server log. Useful for debugging, but reduces performance.
tcp-no-delay
false
(optional) If true, enables TCP_NODELAY (also called Nagle's algorithm).
max-connections-count
4096
(optional) Specifies the maximum number of pending connections on a network-listener that references this transport.
acceptor-threads
1
(optional) Specifies the number of processors in the machine.

To set the number of request processing threads, use the max-thread-pool-size attribute of the thread-poolelement.

byte-buffer-type
HEAP
(optional) Specifies the type of the buffer to be provided for input streams created by a network-listener. Allowed values are HEAP and DIRECT.
buffer-size-bytes
8192
(optional) Specifies the size, in bytes, of the buffer to be provided for input streams created by a network-listener.

transports

Contains transports.

Superelements

network-config

Subelements

The following table describes subelements for the transports element.

transports Subelements
Element
Required
Description
zero or more
Configures a selection key handler.
one or more
Configures a transport.