Sun GlassFish Enterprise Server v3 Domain File Format Reference

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.

Table 1–120 port-unification Subelements


Element	Required	Description
protocol-finder	zero or one	Configures the protocol finder.

Attributes

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

Table 1–121 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.

Table 1–122 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.

Table 1–123 profiler Subelements


Element	Required	Description
jvm-options	zero or more	Contains profiler-specific JVM command line options.
property	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.

Table 1–124 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:

Optional with respect to the Enterprise Server
Needed by a system or object that the Enterprise Server doesn’t have knowledge of, such as an LDAP server or a Java class

For example, an auth-realm element can include property subelements:
```
<auth-realm name="file"
     classname="com.sun.enterprise.security.auth.realm.file.FileRealm">
     <property name="file" value="domain-dir/config/keyfile"/>
     <property name="jaas-context" value="fileRealm"/>
 </auth-realm>
```
Which properties an auth-realm element uses depends on the value of the auth-realm element’s name attribute. The file realm uses file and jaas-context properties. Other realms use different properties.

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.

Table 1–125 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:

http — Defines HTTP or HTTPS protocol.
protocol-chain-instance-handler — Defines a custom protocol as a chain of protocol-filter links.
port-unification — Defines a composite protocol, which can consist of several protocol definitions. Port unification makes it possible for a single network-listener to host several protocols at the same time. For example, HTTP and IIOP can work simultaneously on port 8080.

Superelements

protocols

Subelements

The following table describes subelements for the protocol element.

Table 1–126 protocol Subelements


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

Attributes

The following table describes attributes for the protocol element.

Table 1–127 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.

Table 1–128 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.

Table 1–129 protocol-chain-instance-handler Subelements


Element	Required	Description
protocol-chain	one or more	Configures a protocol chain.

Attributes

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

Table 1–130 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.

Table 1–131 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.

Table 1–132 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.

Table 1–133 protocols Subelements


Element	Required	Description
protocol	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.

Table 1–134 provider-config Subelements


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

Attributes

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

Table 1–135 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.

Table 1–136 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.