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

W

web-container

Configures the web container.

Superelements

config

Subelements

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

web-container Subelements
Element
Required
Description
zero or one
Specifies session configuration information for the web container.
zero or more
Specifies a property or a variable.
Properties

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

web-container Properties
Property
Default
Description
dispatcher-max-depth
20
Prevents recursive include or forward statements from creating an infinite loop by setting a maximum nested dispatch level. If this level is exceeded, the following message is written to the server log:

Exceeded maximum depth for nested request dispatches

web-module

This element is deprecated. Use an application element instead.

Specifies a deployed web module.

Superelements

applications

Subelements

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

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

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

web-module Attributes
Attribute
Default
Description
name
none
The name of the web module.
context-root
none
The context root at which the web module is deployed. The context root can be the empty string or just /. The context root can start with the / character, but doesn’t have to.
location
none
A fully qualified or relative path to the directory to which the contents of the .war file have been extracted. If relative, it is relative to the following directory:

domain-dir/applications/

object-type
user
(optional) Defines the type of the resource. For a web module, the only allowed value is user.
enabled
true
(optional) Determines whether the web module is enabled.
libraries
none
(optional) Specifies an absolute or relative path to libraries specific to this module or application. A relative path is relative to domain-dir/lib/applibs. If the path is absolute, the path must be accessible to the domain administration server (DAS), which means it must be under domain-dir. To include more than one path, use a system-specific separator, such as a colon for Solaris or a semicolon for Windows. The libraries are made available to the application in the order in which they are specified.
directory-deployed
false
(optional) Specifies whether the application has been deployed as a directory.

web-module-config

Configures the grandparent web module. Applicable only if the parent engine element has a sniffer value of web.

Superelements

engine

Subelements

The following table describes subelements for the web-module-config element.

web-module-config Subelements
Element
Required
Description
zero or more
Configures an environment entry for a web module.
zero or more
Configures a context parameter for a web module.

web-service-endpoint

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

Configures a web service endpoint, which can be a JAX-RPC/JAXWS 2.0 or JSR-109 web service.

Superelements

ejb-module, j2ee-application, web-module

Subelements

The following table describes subelements for the web-service-endpoint element.

web-service-endpoint Subelements
Element
Required
Description
zero or more
Specifies the registry where web service endpoint artifacts are published.
zero or more
Configures an eXtensible Stylesheet Language Transformation (XSLT) rule.
Attributes

The following table describes attributes for the web-service-endpoint element.

web-service-endpoint Attributes
Attribute
Default
Description
name
none
The fully qualified name of the web service. For a web service endpoint within an application, the format is as follows:
module-name#endpoint-name

For example:

jaxrpc-simple.war#HelloIF

For a web service endpoint that is a stand-alone module, the name is just the endpoint-name.

monitoring
OFF
(optional) Specifies the monitoring level for this web service. For information about monitoring levels, see module-monitoring-levels.
max-history-size
25
(optional) Specifies the maximum number of monitoring records stored for this endpoint.
jbi-enabled
false
(optional) Determines whether the visibility of this endpoint as a Java Business Integration service is enabled or disabled.

work-security-map

Defines a work security map, which maps a principal associated with an incoming work instance to a principal in the Enterprise Server's security domain. It is possible to map multiple EIS group or user principals to the same Enterprise Server principal.

This is different from a security-map, which maps the principal received during servlet or EJB authentication to the credentials accepted by the EIS.

Superelements

resources

Subelements

The following table describes subelements for the work-security-map element.

work-security-map Subelements
Element
Required
Description
zero or more
Maps an EIS principal to a principal defined in the Enterprise Server domain.
zero or more
Maps an EIS group to a group defined in the Enterprise Server domain.
Attributes

The following table describes attributes for the work-security-map element.

work-security-map Attributes
Attribute
Default
Description
name
none
Specifies a unique name for the work security map.
description
none
Specifies a text description for this element.