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

P

param-name

Contains a context parameter name.

Superelements

context-param

Subelements

none - contains data

param-value

Contains a context parameter value.

Superelements

context-param

Subelements

none - contains data

port-unification

Configures port unification.

Superelements

protocol

Subelements

The following table describes subelements for the port-unification element.

port-unification Subelements
Element
Required
Description
zero or one
Configures the protocol finder.
Attributes

The following table describes attributes for the port-unification element.

port-unification Attributes
Attribute
Default
Description
name
none
Specifies a unique name for the port-unification.
classname
none
Specifies the class name of the port-unification implementation.

principal

Contains the principal of the servlet or EJB client.

Superelements

security-map

Subelements

none - contains data

principal-map

Maps an EIS principal to a principal defined in the Enterprise Server domain.

Superelements

work-security-map

Subelements

none

Attributes

The following table describes attributes for the principal-map element.

principal-map Attributes
Attribute
Default
Description
eis-principal
none
Specifies an EIS principal.
mapped-principal
none
Specifies a principal defined in the Enterprise Server domain.

profiler

Configures a profiler for use with the Enterprise Server. For more information about profilers, see the Sun GlassFish Enterprise Server v3 Application Development Guide.

Superelements

java-config

Subelements

The following table describes subelements for the profiler element.

profiler Subelements
Element
Required
Description
zero or more
Contains profiler-specific JVM command line options.
zero or more
Specifies a property or a variable.

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


Attributes

The following table describes attributes for the profiler element.

profiler Attributes
Attribute
Default
Description
name
none
Specifies the name of the profiler.
classpath
none
(optional) Specifies the classpath for the profiler.
native-library-path
none
(optional) Specifies the native library path for the profiler.
enabled
true
(optional) Determines whether the profiler is enabled.

property

Specifies a property. A property adds configuration information to its parent element that is one or both of the following:

Superelements

admin-object-resource, admin-service, appclient-module, application, audit-module, auth-realm, config, connector-connection-pool, connector-module, connector-resource, custom-resource, das-config, domain, ejb-container, ejb-module, ejb-timer-service, engine, extension-module, external-jndi-resource, http-service, iiop-listener, j2ee-application, jacc-provider, java-config, jdbc-connection-pool, jdbc-resource, jms-host, jms-service, jmx-connector, lifecycle-module, log-service, mail-resource, manager-properties, mdb-container, module-log-levels, module-monitoring-levels, monitoring-service, orb, profiler, provider-config, resource-adapter-config, security-service, server, session-properties, store-properties, thread-pool, transaction-service, virtual-server, web-container, , web-module

Subelements

none

Attributes

The following table describes attributes for the property element.

property Attributes
Attribute
Default
Description
name
none
Specifies the name of the property or variable.
value
none
Specifies the value of the property or variable.
description
none
(optional) Specifies a text description of this element.

protocol

Configures a network protocol. A protocol can be defined in one of the following ways according to its subelements:

Superelements

protocols

Subelements

The following table describes subelements for the protocol element.

protocol Subelements
Element
Required
Description
zero or one
Configures HTTP parameters.
zero or one
Configures port unification.
zero or one
Configures a protocol chain instance handler.
zero or one
Configures a protocol filter.
zero or one
Defines SSL parameters.
Attributes

The following table describes attributes for the protocol element.

protocol Attributes
Attribute
Default
Description
name
none
Specifies a unique name for the protocol.
security-enabled
false
(optional) Determines whether the network-listener that references this protocol runs SSL. To turn SSL2 or SSL3 on or off and set ciphers, use an ssl subelement.

protocol-chain

Configures a protocol chain.

Superelements

protocol-chain-instance-handler

Subelements

none

Attributes

The following table describes attributes for the protocol-chain element.

protocol-chain Attributes
Attribute
Default
Description
name
none
Specifies a unique name for the protocol chain.
classname
none
Specifies the class name of the protocol chain implementation.
type
STATELESS
Specifies the type of protocol chain.

protocol-chain-instance-handler

Configures a protocol chain instance handler.

Superelements

protocol

Subelements

The following table describes subelements for the protocol-chain-instance-handler element.

protocol-chain-instance-handler Subelements
Element
Required
Description
one or more
Configures a protocol chain.
Attributes

The following table describes attributes for the protocol-chain-instance-handler element.

protocol-chain-instance-handler Attributes
Attribute
Default
Description
name
none
Specifies a unique name for the protocol chain instance handler.
classname
none
Specifies the class name of the protocol chain instance handler implementation.

protocol-filter

Configures a protocol filter.

Superelements

protocol

Subelements

none

Attributes

The following table describes attributes for the protocol-filter element.

protocol-filter Attributes
Attribute
Default
Description
name
none
Specifies a unique name for the protocol filter.
classname
none
Specifies the class name of the protocol filter implementation.

protocol-finder

Configures a protocol finder.

Superelements

port-unification

Subelements

none

Attributes

The following table describes attributes for the protocol-finder element.

protocol-finder Attributes
Attribute
Default
Description
name
none
Specifies a unique name for the protocol finder.
classname
none
Specifies the class name of the protocol finder implementation.
protocol
none
Specifies the name of the protocol associated with this protocol finder.

protocols

Contains protocols.

Superelements

network-config

Subelements

The following table describes subelements for the protocols element.

protocols Subelements
Element
Required
Description
one or more
Configures a protocol.

provider-config

Specifies a configuration for one message security provider.

Although the request-policy and response-policy subelements are optional, the provider-config element does nothing if they are not specified.

Use property subelements to configure provider-specific properties. Property values are passed to the provider when its initialize method is called.

Superelements

message-security-config

Subelements

The following table describes subelements for the provider-config element.

provider-config Subelements
Element
Required
Description
zero or one
Defines the authentication policy requirements of the authentication provider’s request processing.
zero or one
Defines the authentication policy requirements of the authentication provider’s response processing.
zero or more
Specifies a property or a variable.
Attributes

The following table describes attributes for the provider-config element.

provider-config Attributes
Attribute
Default
Description
provider-id
none
Specifies a unique identifier for this provider-config element.
provider-type
none
Specifies whether the provider is a client, server, or client-server authentication provider.
class-name
none
Specifies the Java implementation class of the provider. Client authentication providers must implement the com.sun.enterprise.security.jauth.ClientAuthModule interface. Server authentication providers must implement the com.sun.enterprise.security.jauth.ServerAuthModule interface. Client-server providers must implement both interfaces.
Properties

The following table describes properties for the provider-config element.

provider-config Properties
Property
Default
Description
security.config
domain-dir/config/wss-server-config-1.0.xml
Specifies the location of the message security configuration file. To point to a configuration file in the domain-dir/config directory, use the system property ${com.sun.aas.instanceRoot}/config/, for example:

${com.sun.aas.instanceRoot}/config/wss-server-config-1.0.xml

See system-property.

debug
false
If true, enables dumping of server provider debug messages to the server log.
dynamic.username.password
false
If true, signals the provider runtime to collect the user name and password from the CallbackHandler for each request. If false, the user name and password for wsse:UsernameToken(s) is collected once, during module initialization. This property is only applicable for a ClientAuthModule.
encryption.key.alias
s1as
Specifies the encryption key used by the provider. The key is identified by its keystore alias.
signature.key.alias
s1as
Specifies the signature key used by the provider. The key is identified by its keystore alias.