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

R

registry-location

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

Specifies the registry where web service endpoint artifacts are published.

Superelements

web-service-endpoint

Subelements

none

Attributes

The following table describes attributes for the registry-location element.

registry-location Attributes
Attribute
Default
Description
connector-resource-jndi-name
none
Specifies the jndi-name of the connector-resource used as the registry.

request-policy

Defines the authentication policy requirements of the authentication provider’s request processing.

Superelements

provider-config

Subelements

none

Attributes

The following table describes attributes for the request-policy element.

request-policy Attributes
Attribute
Default
Description
auth-source
none
Specifies the type of required authentication, either sender (user name and password) or content (digital signature).
auth-recipient
none
Specifies whether recipient authentication occurs before or after content authentication. Allowed values are before-content and after-content.

request-processing

This element is not supported. If this element is present in the domain.xml file, its attributes are remapped to other elements and then it is deleted. For remapping details, see the Attributes table for this element.

Superelements

http-service

Subelements

none

Attributes

The following table describes attributes for the request-processing element.

request-processing Attributes
Attribute
Default
Description
thread-count
20
Remapped to the max-thread-pool-size attribute of a thread-pool element.
initial-thread-count
2
Remapped to the min-thread-pool-size attribute of a thread-pool element.
thread-increment
1
Not implemented. Do not use.
request-timeout-in-seconds
30
Remapped to the request-timeout-seconds attribute of an http element.
header-buffer-length-in-bytes
8192
Remapped to the header-buffer-length-bytes attribute of an http element.

resource-adapter-config

Defines a connector (resource adapter) configuration. Stores configuration information for the resource adapter JavaBean in property subelements.

Superelements

resources

Subelements

The following table describes subelements for the resource-adapter-config element.

resource-adapter-config Subelements
Element
Required
Description
zero or more
Specifies a property or a variable.
Attributes

The following table describes attributes for the resource-adapter-config element.

resource-adapter-config Attributes
Attribute
Default
Description
name
none
(optional) Not used. See resource-adapter-name.
thread-pool-ids
none
(optional) Specifies a comma-separated list of the name attributes of thread-pool elements.
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.

resource-adapter-name
none
Specifies the name attribute of a deployed connector application element. If the resource adapter is embedded in an application, then it is app_name#rar_name.
Properties

Properties of the resource-adapter-config element are the names of setter methods of the class referenced by the resourceadapter-class element in the ra.xml file, which defines the class name of the resource adapter JavaBean. Any properties defined here override the default values present in ra.xml.

resource-ref

References a resource deployed to the server.

Superelements

server

Subelements

none

Attributes

The following table describes attributes for the resource-ref element.

resource-ref Attributes
Attribute
Default
Description
enabled
true
(optional) Determines whether the resource is enabled.
ref
none

resources

Contains configured resources, such as database connections, JavaMail sessions, and so on.


Note - You must specify a Java Naming and Directory Interface (JNDI) name for each resource. To avoid collisions with names of other enterprise resources in JNDI, and to avoid portability problems, all names in an Enterprise Server application should begin with the string java:comp/env.


Superelements

domain

Subelements

The following table describes subelements for the resources element.

resources Subelements
Element
Required
Description
zero or more
Defines a custom resource.
zero or more
Defines a resource that resides in an external JNDI repository.
zero or more
Defines a JDBC (Java Database Connectivity) resource.
zero or more
Defines a JavaMail resource.
zero or more
Defines an administered object for an inbound resource adapter.
zero or more
Defines a connector (resource adapter) resource.
zero or more
Defines a resource adapter configuration.
zero or more
Defines the properties that are required for creating a JDBC connection pool.
zero or more
Defines the properties that are required for creating a connector connection pool.
zero or more
Defines a work security map.

Note - Subelements of a resources element can occur in any order.


response-policy

Defines the authentication policy requirements of the authentication provider’s response processing.

Superelements

provider-config

Subelements

none

Attributes

The following table describes attributes for the response-policy element.

response-policy Attributes
Attribute
Default
Description
auth-source
none
Specifies the type of required authentication, either sender (user name and password) or content (digital signature).
auth-recipient
none
Specifies whether recipient authentication occurs before or after content authentication. Allowed values are before-content and after-content.