|
Elements of the GlassFish Server Deployment Descriptors |
| Previous | Contents |
This appendix describes the elements of the GlassFish Server Open Source Editiondeployment descriptors.
activation-configSpecifies an activation configuration, which includes the runtime
configuration properties of the message-driven bean in its operational
environment. For example, this can include information about the name of
a physical JMS destination. Matches and overrides the
activation-config element in the ejb-jar.xml file.
The following table describes subelements for the activation-config
element.
Table C-1 activation-config subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Specifies a text description of the activation configuration. |
|
one or more |
Specifies an activation configuration property. |
activation-config-propertySpecifies the name and value of an activation configuration property.
The following table describes subelements for the
activation-config-property element.
Table C-2 activation-config-property subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the name of an activation configuration property. |
|
only one |
Specifies the value of an activation configuration property. |
activation-config-property-nameSpecifies the name of an activation configuration property.
activation-config-property-valueSpecifies the value of an activation configuration property.
admin-object-resourceDefines an administered object for an inbound resource adapter.
The following table describes subelements for the
admin-object-resource element.
Table C-3 admin-object-resource Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Contains a text description of this element. |
|
zero or more |
Specifies a property or a variable. |
The following table describes attributes for the admin-object-resource
element.
Table C-4 admin-object-resource Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the JNDI name for the resource. |
|
none |
Specifies the fully qualified type of the resource. |
|
none |
Specifies the name of the inbound resource adapter. |
|
|
(optional) Defines the type of the resource. Allowed values are:
|
|
|
(optional) Determines whether this resource is enabled at runtime. |
as-contextSpecifies the authentication mechanism used to authenticate the client.
The following table describes subelements for the as-context element.
Table C-5 as-context Subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the authentication method. The only supported
value is |
|
only one |
Specifies the realm in which the user is authenticated. |
|
only one |
Specifies whether the authentication method specified in the
|
archive-nameSpecifies the name of the archive file. The value of the archive-name
element is used to derive the default application name when
display-name is not present in the application.xml file. The default
application name is the archive-name value minus the file extension.
For example, if archive-name is foo.ear, the default application
name is foo.
auth-methodSpecifies the authentication method.
If the parent element is as-context, the only supported
value is USERNAME_PASSWORD.
If the parent element is login-config, specifies the
authentication mechanism for the web service endpoint. As a prerequisite
to gaining access to any web resources protected by an authorization
constraint, a user must be authenticated using the configured mechanism.
auth-realmJAAS is available on the ACC. Defines the optional configuration for a JAAS authentication realm. Authentication realms require provider-specific properties, which vary depending on what a particular implementation needs. For more information about how to define realms, see "Realm Configuration" in GlassFish Server Open Source Edition Application Development Guide.
The following table describes subelements for the auth-realm element.
Table C-6 auth-realm subelement
| Element | Required | Description |
|---|---|---|
zero or more |
Specifies a property, which has a name and a value. |
AttributesThe following table describes attributes for the auth-realm element.
Table C-7 auth-realm attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Defines the name of this realm. |
|
none |
Defines the Java class which implements this realm. |
Here is an example of the default file realm:
<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.
See "Realm Configuration" in GlassFish Server Open
Source Edition Application Development Guide.
backend-principalSpecifies the user name and password required by the Enterprise Information System (EIS).
bean-cacheSpecifies the entity bean cache properties. Used for entity beans and stateful session beans.
The following table describes subelements for the bean-cache element.
Table C-9 bean-cache Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Specifies the maximum number of beans allowable in cache. |
|
zero or one |
Deprecated. |
|
zero or one |
Specifies the maximum time that a stateful session bean or entity bean is allowed to be idle in cache before being passivated. Default value is 10 minutes (600 seconds). |
|
zero or one |
Specifies the amount of time a bean remains before being
removed. If |
|
zero or one |
Specifies the number of beans to be created if the pool
is empty (subject to the |
|
zero or one |
Specifies the algorithm that must be used by the container to pick victims. Applies only to stateful session beans. |
<bean-cache>
<max-cache-size>100</max-cache-size>
<cache-resize-quantity>10</cache-resize-quantity>
<removal-timeout-in-seconds>3600</removal-timeout-in-seconds>
<victim-selection-policy>LRU</victim-selection-policy>
<cache-idle-timeout-in-seconds>600</cache-idle-timeout-in-seconds>
<removal-timeout-in-seconds>5400</removal-timeout-in-seconds>
</bean-cache>bean-poolSpecifies the pool properties of stateless session beans, entity beans, and message-driven bean.
The following table describes subelements for the bean-pool element.
Table C-10 bean-pool Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Specifies the initial and minimum number of beans maintained in the pool. Default is 32. |
|
zero or one |
Specifies the number of beans to be created if the pool
is empty (subject to the |
|
zero or one |
Specifies the maximum number of beans in the pool. Values are from 0 to MAX_INTEGER. Default is to the EJB container value or 60. |
|
zero or one |
Deprecated. |
|
zero or one |
Specifies the maximum time that a bean is allowed to be idle in the pool. After this time, the bean is removed. This is a hint to the server. Default time is 600 seconds (10 minutes). |
cacheConfigures caching for web application components.
The following table describes subelements for the cache element.
Table C-11 cache Subelements
| Element | Required | Description |
|---|---|---|
zero or more |
Specifies a custom class that implements the CacheHelper interface. |
|
zero or one |
Allows you to change the properties of the default,
built-in |
|
zero or more |
Specifies a cache property, which has a name and a value. |
|
zero or more |
Maps a URL pattern or a servlet name to its cacheability constraints. |
The following table describes attributes for the cache element.
Table C-12 cache Attributes
| Attribute | Default | Description |
|---|---|---|
|
|
(optional) Specifies the maximum number of entries the cache can contain. Must be a positive integer. |
|
|
(optional) Specifies the maximum amount of
time in seconds that an entry can remain in the cache after it is
created or refreshed. Can be overridden by a |
|
|
(optional) Determines whether servlet and JSP caching is enabled. |
The following table describes properties for the cache element.
Table C-13 cache Properties
| Property | Default | Description |
|---|---|---|
|
|
Specifies the fully qualified name of the class that implements the cache functionality. See Cache Class Names for possible values. |
|
|
Specifies the number of entries in a
segment of the cache table that should have its own LRU (least recently
used) list. Applicable only if |
|
unlimited; |
Specifies an upper bound on the
cache memory size in bytes (KB or MB units). Example values are |
The following table lists possible values of the cacheClassName
property.
Table C-14 cacheClassName Values
| Value | Description |
|---|---|
|
A bounded cache with an LRU (least recently used) cache replacement policy. |
|
An unbounded cache suitable if the maximum number of entries is known. |
|
A cache suitable for a large
number of entries (>4096). Uses the |
|
A cache suitable for
limiting the cache size by memory rather than number of entries. Uses
the |
cache-helperSpecifies a class that implements the com.sun.appserv.web.cache.CacheHelper interface.
The following table describes subelements for the cache-helper
element.
Table C-15 cache-helper Subelements
| Element | Required | Description |
|---|---|---|
zero or more |
Specifies a property, which has a name and a value. |
The following table describes attributes for the cache-helper element.
Table C-16 cache-helper Attributes
| Attribute | Default | Description |
|---|---|---|
|
|
Specifies a unique name for the helper class, which
is referenced in the |
|
none |
Specifies the fully qualified class name of the cache helper, which must implement the com.sun.appserv.web.CacheHelper interface. |
cache-helper-refSpecifies the name of the cache-helper used by the
parent cache-mapping element.
cache-idle-timeout-in-secondsSpecifies the maximum time that a bean can remain idle in the cache.
After this amount of time, the container can passivate this bean. A
value of 0 specifies that beans never become candidates for
passivation. Default is 600.
Applies to stateful session beans and entity beans.
cache-mappingMaps a URL pattern or a servlet name to its cacheability constraints.
The following table describes subelements for the cache-mapping
element.
Table C-17 cache-mapping Subelements
| Element | Required | Description |
|---|---|---|
requires one |
Contains the name of a servlet. |
|
requires one |
Contains a servlet URL pattern for which caching is enabled. |
|
required if |
Contains the |
|
zero or one if |
Contains a
comma-separated list of |
|
zero or one if |
Contains the
|
|
zero or one if |
Specifies a field that gives the application component a programmatic way to refresh a cached entry. |
|
zero or more if |
Contains an HTTP method that is eligible for caching. |
|
zero or more if |
Specifies a component of the key used to look up and extract cache entries. |
|
zero or more if |
Specifies a
cacheability constraint for the given |
call-propertySpecifies JAX-RPC property values that can be set on a
javax.xml.rpc.Call object before it is returned to the web service
client. The property names can be any properties supported by the
JAX-RPC Call implementation.
port-info, service-ref
(glassfish-web.xml, glassfish-ejb-jar.xml,
glassfish-application-client.xml)
caller-propagationSpecifies whether the target accepts propagated caller identities. The
values are NONE, SUPPORTED, or REQUIRED.
cert-dbNot implemented. Included for backward compatibility only. Attribute values are ignored.
check-all-at-commitThis element is not implemented. Do not use.
check-modified-at-commitChecks concurrent modification of fields in modified beans at commit time.
check-version-of-accessed-instancesChecks the version column of the modified beans.
Version consistency allows the bean state to be cached between transactions instead of read from a database. The bean state is verified by primary key and version column values. This occurs during a custom query (for dirty instances only) or commit (for both clean and dirty instances).
The version column must be a numeric type, and must be in the primary table. You must provide appropriate update triggers for this column.
The following table describes subelements for the
check-version-of-accessed-instances element.
Table C-20 check-version-of-accessed-instances Subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the name of the version column. |
checkpoint-at-end-of-methodSpecifies that the stateful session bean state is checkpointed, or
persisted, after the specified methods are executed. The
availability-enabled attribute of the parent ejb
element must be set to true.
The following table describes subelements for the
checkpoint-at-end-of-method element.
Table C-21 checkpoint-at-end-of-method Subelements
| Element | Required | Description |
|---|---|---|
one or more |
Specifies a bean method. |
checkpointed-methodsDeprecated. Supported for backward compatibility. Use
checkpoint-at-end-of-method instead.
class-loaderConfigures the class loader for the web module.
The following table describes subelements for the class-loader
element.
Table C-22 class-loader Subelements
| Element | Required | Description |
|---|---|---|
zero or more |
Specifies a property, which has a name and a value. |
The following table describes attributes for the class-loader element.
Table C-23 class-loader Attributes
| Attribute | Default | Description |
|---|---|---|
|
null |
(optional) Specifies a colon or semicolon separated list of additional classpaths for this web module. Paths can be absolute or relative to the web module’s root, for example: |
|
|
(optional) If If For a number of packages, including |
|
+ |
(optional) Not implemented. Included for backward compatibility with previous Oracle Web Server versions. |
|
Note
|
If the Portable programs that use this element should not be packaged with any classes or interfaces that are a part of the Java EE specification. The behavior of a program that includes such classes or interfaces in its WAR file is undefined. |
The following table describes properties for the class-loader element.
Table C-24 class-loader Properties
| Property | Default | Description |
|---|---|---|
|
|
If |
client-containerDefines the GlassFish Server specific configuration for the application
client container. This is the root element; there can only be one
client-container element in a sun-acc.xml file. See
The sun-acc.xml File.
The following table describes subelements for the client-container
element.
Table C-25 client-container Subelements
| Element | Required | Description |
|---|---|---|
one or more |
Specifies the IIOP listener for the target server. Also specifies IIOP endpoints used for load balancing. If the GlassFish Server instance on which the application client is deployed participates in a cluster, GlassFish Server finds all currently active IIOP endpoints in the cluster automatically. However, a client should have at least two endpoints specified for bootstrapping purposes, in case one of the endpoints has failed. A listener or endpoint is in the form host`:`port, where the host is an IP address or host name, and the port specifies the port number. |
|
zero or one |
Specifies the optional configuration for JAAS authentication realm. |
|
zero or one |
Specifies the default client credential that is sent to the server. |
|
zero or one |
Specifies the default log file and the severity level of the message. |
|
zero or more |
Specifies configurations for message security providers. |
|
zero or more |
Specifies a property, which has a name and a value. |
The following table describes attributes for the client-container
element.
Table C-26 client-container Attributes
| Attribute | Default | Description |
|---|---|---|
|
|
If |
The following table describes properties for the client-container
element.
Table C-27 client-container Properties
| Property | Default | Description |
|---|---|---|
|
none |
Specifies a comma-separated
list of one or more IIOP endpoints used for load balancing. An IIOP
endpoint is in the form host`: |
client-credentialDefault client credentials that are sent to the server. If this element is present, the credentials are automatically sent to the server, without prompting the user for the user name and password on the client side.
The following table describes subelements for the client-credential
element.
Table C-28 client-credential subelement
| Element | Required | Description |
|---|---|---|
zero or more |
Specifies a property, which has a name and a value. |
The following table describes attributes for the client-credential
element.
Table C-29 client-credential attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
The user name used to authenticate the Application client container. |
|
none |
The password used to authenticate the Application client container. |
|
default realm for the domain |
(optional) The realm (specified by name) where credentials are to be resolved. |
cmpDescribes runtime information for a CMP entity bean object for EJB 1.1 and EJB 2.1 beans.
The following table describes subelements for the cmp element.
Table C-30 cmp Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
This element is not implemented. |
|
zero or one |
This element is not implemented. |
|
zero or one |
Describes the finders for CMP 1.1 beans. |
|
zero or one |
Disables prefetching of entity bean states for the specified query methods. |
cmp-field-mappingThe cmp-field-mapping element associates a field with one or more
columns to which it maps. The column can be from a bean’s primary table
or any defined secondary table. If a field is mapped to multiple
columns, the column listed first in this element is used as a source for
getting the value from the database. The columns are updated in the
order they appear. There is one cmp-field-mapping element for each
cmp-field element defined in the ejb-jar.xml file.
The following table describes subelements for the cmp-field-mapping
element.
Table C-31 cmp-field-mapping Subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the Java identifier of a field. This identifier
must match the value of the |
|
one or more |
Specifies the name of a column from the primary table, or the qualified table name (TABLE.COLUMN) of a column from a secondary or related table. |
|
zero or one |
Specifies that a field is read-only. |
|
zero or one |
Specifies the fetch group for this CMP field’s mapping. |
cmp-resourceSpecifies the database to be used for storing CMP beans. For more information about this element, see "Configuring the CMP Resource" in GlassFish Server Open Source Edition Application Development Guide.
The following table describes subelements for the cmp-resource
element.
Table C-32 cmp-resource Subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the absolute |
|
zero or one |
Specifies the default runtime bindings of a resource reference. |
|
zero or more |
Specifies a property name and value. Used to configure
|
|
zero or one |
If |
|
zero or one |
If |
|
zero or one |
Specifies the name of the database vendor for which tables can be created. |
|
zero or one |
Specifies field-specific type mappings and allows you to
set the |
cmr-field-mappingA container-managed relationship field has a name and one or more column
pairs that define the relationship. There is one cmr-field-mapping
element for each cmr-field element in the ejb-jar.xml file. A
relationship can also participate in a fetch group.
The following table describes subelements for the cmr-field-mapping
element.
Table C-33 cmr-field-mapping Subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the Java identifier of a field. Must match the
value of the |
|
one or more |
Specifies the pair of columns that determine the relationship between two database tables. |
|
zero or one |
Specifies the fetch group for this CMR field’s relationship. |
cmr-field-nameSpecifies the Java identifier of a field. Must match the value of the
cmr-field-name subelement of the cmr-field element in the
ejb-jar.xml file.
cmt-timeout-in-secondsOverrides the Transaction Timeout setting of the Transaction Service for
an individual bean. The default value, 0, specifies that the default
Transaction Service timeout is used. If positive, this value is used for
all methods in the bean that start a new container-managed transaction.
This value is not used if the bean joins a client transaction.
column-nameSpecifies the name of a column from the primary table, or the qualified table name (TABLE.COLUMN) of a column from a secondary or related table.
check-version-of-accessed-instances,
cmp-field-mapping, column-pair
(sun-cmp-mappings.xml)
column-pairSpecifies the pair of columns that determine the relationship between
two database tables. Each column-pair must contain exactly two
column-name subelements, which specify the column’s names. The first
column-name element names the table that this bean is mapped to, and
the second column-name names the column in the related table.
The following table describes subelements for the column-pair element.
Table C-34 column-pair Subelements
| Element | Required | Description |
|---|---|---|
two |
Specifies the name of a column from the primary table, or the qualified table name (TABLE.COLUMN) of a column from a secondary or related table. |
commit-optionSpecifies the commit option used on transaction completion. Valid values
for GlassFish Server are B or C. Default value is B. Applies to
entity beans.
|
Note
|
Commit option A is not supported for this GlassFish Server release. |
compatibilitySpecifies the GlassFish Server release with which to be backward
compatible in terms of JAR visibility requirements for applications. The
current allowed value is v2, which refers to GlassFish Server version
2 or GlassFish Server version 9.1 or 9.1.1. Starting in Java EE 6, the
Java EE specification imposes stricter requirements than Java EE 5 did
on which JAR files can be visible to various modules within an EAR file.
Setting this element to v2 removes these Java EE 6 and later
restrictions.
glassfish-application (glassfish-application.xml),
glassfish-ejb-jar (glassfish-ejb-jar.xml)
confidentialitySpecifies if the target supports privacy-protected messages. The values
are NONE, SUPPORTED, or REQUIRED.
connector-connection-poolDefines a connector connection pool.
The following table describes subelements for the
connector-connection-pool element.
Table C-35 connector-connection-pool Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Contains a text description of this element. |
|
zero or more |
Maps the principal received during servlet or EJB authentication to the credentials accepted by the EIS. |
|
zero or more |
Specifies a property or a variable. |
The following table describes attributes for the
connector-connection-pool element. Changing the following attributes
requires a server restart or the redeployment or disabling and
re-enabling of applications that refer to the resource:
resource-adapter-name, connection-definition-name,
transaction-support, associate-with-thread,
lazy-connection-association, and lazy-connection-enlistment.
Table C-36 connector-connection-pool Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the name of the connection pool. A
|
|
none |
Specifies the name of the deployed
connector module or application. If no name is specified during
deployment, the name of the |
|
none |
Specifies a unique name,
identifying a resource adapter’s |
|
|
(optional) Specifies the initial and minimum number of connections maintained in the pool. |
|
|
(optional) Specifies the maximum number of connections that can be created to satisfy client requests. |
|
|
(optional) Specifies the amount
of time, in milliseconds, that the caller is willing to wait for a
connection. If |
|
|
(optional) Specifies the number of idle connections to be destroyed if
the existing number of connections is above the This is enforced periodically at the |
|
|
(optional) Specifies the maximum time that a connection can remain idle in the pool. After this amount of time, the pool can close this connection. |
|
|
(optional) If |
|
none |
(optional) Specifies the transaction support for this connection pool. Overrides the transaction support defined in the resource adapter in a downward compatible way: supports a transaction level lower than or equal to the resource adapter’s, but not higher. Allowed values in descending order are:
|
|
|
(optional) Specifies whether connections have to be validated before being given to the application. If a resource’s validation fails, it is destroyed, and a new resource is created and returned. |
|
|
Specifies the time interval within which a connection is validated at most once. Minimizes the number of validation calls. A value of zero allows unlimited validation calls. |
|
|
Detects potential connection leaks by the application. A connection that is not returned back to the pool by the application within the specified period is assumed to be potentially leaking, and a stack trace of the caller is logged. A zero value disables leak detection. A nonzero value enables leak tracing. |
|
|
If |
|
|
Specifies the number of attempts to create a new connection. |
|
|
Specifies
the time interval between attempts to create a connection when
|
|
|
If |
|
|
If |
|
|
If This attribute associates connections with a thread such that when the
same thread is in need of connections, it can reuse the connections
already associated with that thread. In this case, the overhead of
getting connections from the pool is avoided. However, when this value
is set to |
|
|
If |
|
|
Specifies the number of times a connections is reused by the pool, after which it is closed. A zero value disables this feature. |
|
|
(optional) Specifies whether to ping the pool during pool creation or reconfiguration to identify and warn of any erroneous attribute values. |
|
|
(optional) If |
Most properties of the connector-connection-pool element are the names
of setter methods of the managedconnectionfactory-class element in the
ra.xml file. Properties of the connector-connection-pool element
override the ManagedConnectionFactory JavaBean configuration settings.
All but the last four properties in the following table are
connector-connection-pool properties of jmsra, the resource adapter
used to communicate with the Open Message Queue software. For a complete
list of the available properties (called administered object attributes
in the Message Queue software), see the Open Message Queue
Administration Guide.
Changes to connector-connection-pool properties require a server
restart.
Table C-37 connector-connection-pool Properties
| Property | Default | Description |
|---|---|---|
|
none |
Specifies a list of host/port combinations of the
Message Queue software. For JMS resources of the Type
|
|
none |
Specifies the JMS Client Identifier to be associated with a Durable subscription names are unique and only valid within the scope of a client identifier. To create or reactivate a durable subscriber, the connection must have a valid client identifier. The JMS specification ensures that client identifiers are unique and that a given client identifier is allowed to be used by only one active connection at a time. |
|
|
Specifies the user name for connecting to the
Message Queue software. For JMS resources of the Type
|
|
|
Specifies the password for connecting to the
Message Queue software. For JMS resources of the Type
|
|
|
Specifies the number of attempts to connect
(or reconnect) for each address in the |
|
|
Specifies the interval between reconnect
attempts in milliseconds. This applies to attempts on each address in
the |
|
|
If |
|
|
Specifies whether connection
attempts are in the order of addresses in the |
|
|
Specifies the number of times the client
runtime iterates through the |
|
Note
|
All JMS administered object resource properties that worked with version 7 of the GlassFish Server are supported for backward compatibility. |
connector-resourceDefines the connection factory object of a specific connection definition in a connector (resource adapter).
The following table describes subelements for the connector-resource
element.
Table C-38 connector-resource Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Contains a text description of this element. |
|
zero or more |
Specifies a property or a variable. |
The following table describes attributes for the connector-resource
element.
Table C-39 connector-resource Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the JNDI name for the resource. |
|
none |
Specifies the |
|
|
(optional) Defines the type of the resource. Allowed values are:
|
|
|
(optional) Determines whether this resource is enabled at runtime. |
consistencySpecifies container behavior in guaranteeing transactional consistency of the data in the bean.
The following table describes subelements for the consistency element.
Table C-40 consistency Subelements
| Element | Required | Description |
|---|---|---|
exactly one subelement is required |
No consistency checking occurs. |
|
exactly one subelement is required |
Checks concurrent modification of fields in modified beans at commit time. |
|
exactly one subelement is required |
Obtains an exclusive lock when the data is loaded. |
|
+ |
This element is not implemented. Do not use. |
|
+ |
This element is not implemented. Do not use. |
|
exactly one subelement is required |
Checks the version column of the modified beans. |
constraint-fieldSpecifies a cacheability constraint for the given
url-pattern or servlet-name.
All constraint-field constraints must pass for a response to be
cached. If there are value constraints, at least one of them must
pass.
The following table describes subelements for the constraint-field
element.
Table C-41 constraint-field Subelements
| Element | Required | Description |
|---|---|---|
zero or more |
Contains a value to be matched to the input parameter value. |
The following table describes attributes for the constraint-field
element.
Table C-42 constraint-field Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the input parameter name. |
|
|
(optional) Specifies the scope from which
the input parameter is retrieved. Allowed values are
|
|
|
(optional) If |
|
|
(optional) If |
constraint-field-valueSpecifies a value to be matched to the input parameter value. The matching is case sensitive. For example:
<value match-expr="in-range">1-60</value>The following table describes attributes for the
constraint-field-value element.
Table C-43 constraint-field-value Attributes
| Attribute | Default | Description |
|---|---|---|
|
|
(optional) Specifies the type of comparison performed with the value.
Allowed values are If |
|
|
(optional) If |
|
|
(optional) If |
context-rootContains the web context root for the application or web application
that was packaged as a WAR file. Overrides the corresponding element in
the application.xml or web.xml file.
If the parent element is java-web-start-access, this element contains
the context root for the Java Web Start enabled application client
module. If none is specified, a default is generated; see
java-web-start-access.
If you are setting up load balancing, web module context roots must be unique within a server instance. See the GlassFish Server Open Source Edition High Availability Administration Guide for more information about load balancing.
web (glassfish-application.xml),
glassfish-web-app (glassfish-web.xml),
java-web-start-access
(glassfish-application-client.xml)
cookie-propertiesSpecifies session cookie properties.
|
Note
|
If cookie settings are defined declaratively in the |
The following table describes subelements for the cookie-properties
element.
Table C-44 cookie-properties Subelements
| Element | Required | Description |
|---|---|---|
zero or more |
Specifies a property, which has a name and a value. |
The following table describes properties for the cookie-properties
element.
Table C-45 cookie-properties Properties
| Property | Default | Description |
|---|---|---|
|
none |
Specifies the cookie name. |
|
Context path at which the web module is installed. |
Specifies the pathname that is set when the cookie is created. The
browser sends the cookie if the pathname for the request contains this
pathname. If set to |
|
none |
Specifies the expiration time (in seconds) after which the browser expires the cookie. If this is unset, the cookie doesn’t expire. |
|
(unset) |
Specifies the domain for which the cookie is valid. |
|
none |
Specifies the comment that identifies the session tracking cookie in the cookie file. |
|
|
Sets the
To set the |
|
none |
Specifies that the cookie is marked HTTP only.
Allowed values are |
create-tables-at-deploySpecifies whether database tables are created for beans that are
automatically mapped by the EJB container. If true, creates tables in
the database. If false (the default if this element is not present),
does not create tables.
This element can be overridden during deployment. See "Generation Options for CMP" in GlassFish Server Open Source Edition Application Development Guide.
custom-resourceDefines a custom resource, which specifies a custom server-wide resource object factory. Such object factories implement the javax.naming.spi.ObjectFactory interface.
The following table describes subelements for the custom-resource
element.
Table C-46 custom-resource Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Contains a text description of this element. |
|
zero or more |
Specifies a property or a variable. |
The following table describes attributes for the custom-resource
element.
Table C-47 custom-resource Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the JNDI name for the resource. |
|
none |
Specifies the fully qualified type of the resource. |
|
none |
Specifies the fully qualified name of the user-written factory class, which implements javax.naming.spi.ObjectFactory. |
|
|
(optional) Defines the type of the resource. Allowed values are:
|
|
|
(optional) Determines whether this resource is enabled at runtime. |
database-vendor-nameSpecifies the name of the database vendor for which tables can be
created. Allowed values are javadb, db2, mssql, mysql, oracle,
postgresql, pointbase, derby (also for CloudScape), and sybase,
case-insensitive.
If no value is specified, a connection is made to the resource specified
by the jndi-name subelement of the
cmp-resource element, and the database vendor name is
read. If the connection cannot be established, or if the value is not
recognized, SQL-92 compliance is presumed.
This element can be overridden during deployment. See "Generation Options for CMP" in GlassFish Server Open Source Edition Application Development Guide.
debugging-enabledSpecifies whether the debugging servlet is enabled for this web service
endpoint. Allowed values are true (the default) and false.
defaultSpecifies that a field belongs to the default hierarchical fetch group,
and enables prefetching for a CMR field. To disable prefetching for
specific query methods, use a prefetch-disabled element
in the glassfish-ejb-jar.xml file.
default-helperPasses property values to the built-in default
cache-helper class.
The following table describes subelements for the default-helper
element.
Table C-48 default-helper Subelements
| Element | Required | Description |
|---|---|---|
zero or more |
Specifies a property, which has a name and a value. |
The following table describes properties for the default-helper
element.
Table C-49 default-helper Properties
| Property | Default | Description |
|---|---|---|
|
Uses the built-in |
The caching
engine looks in the |
default-resource-principalSpecifies the default principal (user) for the resource.
If this element is used in conjunction with a JMS Connection Factory
resource, the name and password subelements must be valid entries in
the Open Message Queue broker user repository. See
"Configuring and Managing Security Services" in Open
Message Queue Administration Guide for details.
resource-ref (glassfish-web.xml,
glassfish-ejb-jar.xml, glassfish-application-client.xml);
cmp-resource, mdb-connection-factory
(glassfish-ejb-jar.xml)
The following table describes subelements for the
default-resource-principal element.
Table C-50 default-resource-principal Subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the default resource principal name used to sign on to a resource manager. |
|
only one |
Specifies password of the default resource principal. |
descriptionSpecifies a text description of the containing element.
property (with attributes), valve
(glassfish-web.xml); activation-config,
method (glassfish-ejb-jar.xml);
target-server (sun-acc.xml);
admin-object-resource,
connector-connection-pool,
connector-resource, custom-resource,
external-jndi-resource,
jdbc-connection-pool, jdbc-resource,
mail-resource, property (with attributes),
resource-adapter-config (glassfish-resources.xml)
disable-nonportable-jndi-namesBecause the EJB 3.1 specification defines portable EJB JNDI names, there
is less need for GlassFish Server specific JNDI names. By default,
GlassFish Server specific default JNDI names are applied automatically
for backward compatibility. To disable GlassFish Server specific JNDI
names for an EJB module, set the value of this element to true. The
default is false.
dispatcherSpecifies a comma-separated list of RequestDispatcher methods for
which caching is enabled on the target resource. Valid values are
REQUEST, FORWARD, INCLUDE, and ERROR . If this element is not
specified, the default is REQUEST. See SRV.6.2.5 of the Servlet 2.4
specification for more information.
drop-tables-at-undeploySpecifies whether database tables that were automatically created when
the bean(s) were last deployed are dropped when the bean(s) are
undeployed. If true, drops tables from the database. If false (the
default if this element is not present), does not drop tables.
This element can be overridden during deployment. See "Generation Options for CMP" in GlassFish Server Open Source Edition Application Development Guide.
ejbDefines runtime properties for a single enterprise bean within the application. The subelements listed below apply to particular enterprise beans as follows:
All types of beans: ejb-name, ejb-ref, resource-ref,
resource-env-ref, ior-security-config, gen-classes, jndi-name,
use-thread-pool-id, message-destination-ref, pass-by-reference,
service-ref
Stateless session beans: bean-pool, webservice-endpoint
Stateful session beans: bean-cache, webservice-endpoint,
checkpoint-at-end-of-method
Entity beans: commit-option, bean-cache, bean-pool, cmp,
is-read-only-bean, refresh-period-in-seconds,
flush-at-end-of-method
Message-driven beans: mdb-resource-adapter,
mdb-connection-factory, jms-durable-subscription-name,
jms-max-messages-load, bean-pool
The following table describes subelements for the ejb element.
Table C-51 ejb Subelements
| Element | Required | Description |
|---|---|---|
only one |
Matches the |
|
zero or more |
Specifies the absolute |
|
zero or more |
Maps the absolute JNDI name to the |
|
zero or more |
Maps the absolute JNDI name to the |
|
zero or more |
Maps the absolute JNDI name to the |
|
zero or more |
Specifies runtime settings for a web service reference. |
|
zero or more |
Specifies the name of a physical message destination. |
|
zero or one |
Specifies the passing method used by an enterprise bean calling a remote interface method in another bean that is colocated within the same process. |
|
zero or one |
Specifies runtime information for a container-managed persistence (CMP) entity bean for EJB 1.1 and EJB 2.1 beans. |
|
zero or one |
Specifies the principal (user) name in an enterprise bean
that has the |
|
zero or one |
Specifies the connection factory associated with a message-driven bean. |
|
zero or one |
Specifies the durable subscription associated with a message-driven bean. |
|
zero or one |
Specifies the maximum number of messages to load into a Java Message Service session at one time for a message-driven bean to serve. The default is 1. |
|
zero or one |
Specifies the security information for the IOR. |
|
zero or one |
Specifies that this entity bean is read-only. |
|
zero or one |
Specifies the rate at which a read-only-bean must be refreshed from the data source. |
|
zero or one |
Has valid values of B or C. Default value is B. |
|
zero or one |
Overrides the Transaction Timeout setting of the Transaction Service for an individual bean. |
|
zero or one |
Specifies the thread pool from which threads are selected for remote invocations of this bean. |
|
zero or one |
Specifies all the generated class names for a bean. |
|
zero or one |
Specifies the bean pool properties. Used for stateless session beans, entity beans, and message-driven beans. |
|
zero or one |
Specifies the bean cache properties. Used only for stateful session beans and entity beans. |
|
zero or one |
Specifies runtime configuration information for a message-driven bean. |
|
zero or more |
Specifies information about a web service endpoint. |
|
zero or one |
Specifies the methods that force a database flush after execution. Used for entity beans. |
|
zero or one |
Deprecated. Supported for backward compatibility. Use
|
|
zero or one |
Specifies that the stateful session bean state is
checkpointed, or persisted, after the specified methods are executed.
The |
|
zero or one |
Specifies the per-request load balancing behavior of EJB 2.x and 3.x remote client invocations on a stateless session bean. |
The following table describes attributes for the ejb element.
Table C-52 ejb Attributes
| Attribute | Default | Description |
|---|---|---|
|
|
(optional) If set to |
<ejb>
<ejb-name>CustomerEJB</ejb-name>
<jndi-name>customer</jndi-name>
<resource-ref>
<res-ref-name>jdbc/SimpleBank</res-ref-name>
<jndi-name>jdbc/__default</jndi-name>
</resource-ref>
<is-read-only-bean>false</is-read-only-bean>
<commit-option>B</commit-option>
<bean-pool>
<steady-pool-size>10</steady-pool-size>
<resize-quantity>10</resize-quantity>
<max-pool-size>100</max-pool-size>
<pool-idle-timeout-in-seconds>600</pool-idle-timeout-in-seconds>
</bean-pool>
<bean-cache>
<max-cache-size>100</max-cache-size>
<resize-quantity>10</resize-quantity>
<removal-timeout-in-seconds>3600</removal-timeout-in-seconds>
<victim-selection-policy>LRU</victim-selection-policy>
</bean-cache>
</ejb>ejb-nameIn the glassfish-ejb-jar.xml file, matches the ejb-name in the
corresponding ejb-jar.xml file. The name must be unique among the
names of the enterprise beans in the same EJB JAR file.
There is no architected relationship between the ejb-name in the
deployment descriptor and the JNDI name that the deployer assigns to the
EJB component’s home.
In the sun-cmp-mappings.xml file, specifies the ejb-name of the
entity bean in the ejb-jar.xml file to which the container-managed
persistence (CMP) bean corresponds.
ejb-refMaps the ejb-ref-name in the corresponding Java EE deployment
descriptor file ejb-ref entry to the absolute jndi-name of a
resource.
The ejb-ref element is used for the declaration of a reference to an
EJB’s home. Applies to session beans or entity beans.
glassfish-web-app (glassfish-web.xml),
ejb (glassfish-ejb-jar.xml),
glassfish-application-client
(glassfish-application-client.xml)
The following table describes subelements for the ejb-ref element.
Table C-53 ejb-ref Subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the |
|
only one |
Specifies the absolute |
ejb-ref-nameSpecifies the ejb-ref-name in the corresponding Java EE deployment
descriptor file ejb-ref entry.
eligibleSpecifies whether the application client module is eligible to be Java
Web Start enabled. Allowed values are true (the default) and false.
endpoint-address-uriSpecifies the relative path combined with the web server root to form the fully qualified endpoint address for a web service endpoint. This is a required element for EJB endpoints and an optional element for servlet endpoints.
For servlet endpoints, this value is relative to the web application context root. For EJB endpoints, the URI is relative to root of the web server (the first portion of the URI is a context root). The context root portion must not conflict with the context root of any web application deployed to the same web server.
In all cases, this value must be a fixed pattern (no "*' allowed).
If the web service endpoint is a servlet that implements only a single
endpoint and has only one url-pattern, it is not necessary to set this
value, because the web container derives it from the web.xml file.
enterprise-beansSpecifies all the runtime properties for an EJB JAR file in the application.
The following table describes subelements for the enterprise-beans
element.
Table C-54 enterprise-beans Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Specifies the name string. |
|
zero or one |
Specifies a unique system identifier. This data is automatically generated and updated at deployment/redeployment. Do not specify or edit this value. |
|
zero or more |
Defines runtime properties for a single enterprise bean within the application. |
|
zero or one |
Deprecated. |
|
zero or one |
Specifies the database to be used for storing container-managed persistence (CMP) beans in an EJB JAR file. |
|
zero or more |
Specifies the name of a logical message destination. |
|
zero or more |
Specifies a name and optional publish location for a web service. |
|
zero or more |
Specifies a property or a variable. |
<enterprise-beans>
<ejb>
<ejb-name>CustomerEJB</ejb-name>
<jndi-name>customer</jndi-name>
<resource-ref>
<res-ref-name>jdbc/SimpleBank</res-ref-name>
<jndi-name>jdbc/__default</jndi-name>
</resource-ref>
<is-read-only-bean>false</is-read-only-bean>
<commit-option>B</commit-option>
<bean-pool>
<steady-pool-size>10</steady-pool-size>
<resize-quantity>10</resize-quantity>
<max-pool-size>100</max-pool-size>
<pool-idle-timeout-in-seconds>600</pool-idle-timeout-in-seconds>
</bean-pool>
<bean-cache>
<max-cache-size>100</max-cache-size>
<resize-quantity>10</resize-quantity>
<removal-timeout-in-seconds>3600</removal-timeout-in-seconds>
<victim-selection-policy>LRU</victim-selection-policy>
</bean-cache>
</ejb>
</enterprise-beans>entity-mappingSpecifies the mapping a bean to database columns.
The following table describes subelements for the entity-mapping
element.
Table C-55 entity-mapping Subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the name of the entity bean in the |
|
only one |
Specifies the name of a database table. The table must be present in the database schema file. |
|
one or more |
Associates a field with one or more columns to which it maps. |
|
zero or more |
A container-managed relationship field has a name and one or more column pairs that define the relationship. |
|
zero or more |
Describes the relationship between a bean’s primary and secondary table. |
|
zero or one |
Specifies container behavior in guaranteeing transactional consistency of the data in the bean. |
establish-trust-in-clientSpecifies if the target is capable of authenticating a client. The
values are NONE, SUPPORTED, or REQUIRED.
establish-trust-in-targetSpecifies if the target is capable of authenticating to a client. The
values are NONE, SUPPORTED, or REQUIRED.
external-jndi-resourceDefines a resource that resides in an external JNDI repository. For example, a generic Java object could be stored in an LDAP server. An external JNDI factory must implement the javax.naming.spi.InitialContextFactory interface.
The following table describes subelements for the
external-jndi-resource element.
Table C-56 external-jndi-resource Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Contains a text description of this element. |
|
zero or more |
Specifies a property or a variable. |
The following table describes attributes for the
external-jndi-resource element.
Table C-57 external-jndi-resource Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the JNDI name for the resource. |
|
none |
Specifies the JNDI lookup name for the resource. |
|
none |
Specifies the fully qualified type of the resource. |
|
none |
Specifies the fully qualified name of the factory class, which implements javax.naming.spi.InitialContextFactory . For more information about JNDI, see the GlassFish Server Open Source Edition Application Development Guide. |
|
|
(optional) Defines the type of the resource. Allowed values are:
|
|
|
(optional) Determines whether this resource is enabled at runtime. |
fetched-withSpecifies the fetch group configuration for fields and relationships.
The fetched-with element has different allowed and default subelements
based on its parent element and the data types of the fields.
If there is no fetched-with subelement of a
cmp-field-mapping, and the data type is not BLOB, CLOB,
VARBINARY, LONGVARBINARY, or OTHER, fetched-with can have any valid
subelement. The default subelement is as follows:
<fetched-with><default/></fetched-with>
If there is no fetched-with subelement of a
cmp-field-mapping, and the data type is BLOB, CLOB,
VARBINARY, LONGVARBINARY, or OTHER, fetched-with can have any valid
subelement except <default/>. The default subelement is as follows:
<fetched-with><none/></fetched-with>
If there is no fetched-with subelement of a
cmr-field-mapping, fetched-with can have any valid
subelement. The default subelement is as follows:
<fetched-with><none/></fetched-with>
Managed fields are multiple CMP or CMR fields that are mapped to the
same column. A managed field can have any fetched-with subelement
except <default/>. For additional information, see
"Managed Fields" in GlassFish Server Open Source
Edition Application Development Guide.
The following table describes subelements for the fetched-with
element.
Table C-58 fetched-with Subelements
| Element | Required | Description |
|---|---|---|
exactly one subelement is required |
Specifies that a CMP field belongs to the default hierarchical fetch group, which means it is fetched any time the bean is loaded from a database. Enables prefetching of a CMR field. |
|
exactly one subelement is required |
Specifies the level number of a hierarchical fetch group. |
|
exactly one subelement is required |
Specifies the name of an independent fetch group. |
|
exactly one subelement is required |
Specifies that this field or relationship is placed into its own individual fetch group, which means it is loaded from a database the first time it is accessed in this transaction. |
field-nameSpecifies the Java identifier of a field. This identifier must match the
value of the field-name subelement of the cmp-field element in the
ejb-jar.xml file.
finderDescribes the finders for CMP 1.1 with a method name and query.
The following table describes subelements for the finder element.
Table C-59 finder Subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the method name for the finder. |
|
zero or one |
Specifies the query parameters for the CMP 1.1 finder. |
|
zero or one |
Specifies the query filter for the CMP 1.1 finder. |
|
zero or one |
Specifies variables in query expression for the CMP 1.1 finder. |
|
zero or one |
Specifies the query ordering for the CMP 1.1 finder. |
flush-at-end-of-methodSpecifies the methods that force a database flush after execution. Applicable to entity beans.
The following table describes subelements for the
flush-at-end-of-method element.
Table C-60 flush-at-end-of-method Subelements
| Element | Required | Description |
|---|---|---|
one or more |
Specifies a bean method. |
gen-classesSpecifies all the generated class names for a bean.
|
Note
|
This value is automatically generated by the server at deployment or redeployment time. Do not specify it or change it after deployment. |
The following table describes subelements for the gen-classes element.
Table C-61 gen-classes Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Specifies the fully-qualified class name of the generated
|
|
zero or one |
Specifies the fully-qualified class name of the generated
|
|
zero or one |
Specifies the fully-qualified class name of the generated
|
|
zero or one |
Specifies the fully-qualified class name of the generated
|
glassfish-applicationDefines the GlassFish Server specific configuration for an application.
This is the root element; there can only be one glassfish-application
element in a glassfish-application.xml file. See
The glassfish-application.xml File.
The following table describes subelements for the
glassfish-application element.
Table C-62 glassfish-application Subelements
| Element | Required | Description |
|---|---|---|
zero or more |
Specifies the application’s web tier configuration. |
|
zero or one |
Determines whether EJB modules use pass-by-value or pass-by-reference semantics. |
|
zero or one |
Contains the unique ID for the application. |
|
zero or more |
Maps a role in the corresponding Java EE XML file to a user or group. |
|
zero or one |
Specifies an authentication realm. |
|
zero or more |
Maps the absolute JNDI name to the |
|
zero or more |
Maps the absolute JNDI name to the |
|
zero or more |
Maps the absolute JNDI name to the |
|
zero or more |
Specifies runtime settings for a web service reference. |
|
zero or more |
Specifies the name of a physical message destination. |
|
zero or more |
Specifies the name of a logical message destination. |
|
zero or one |
Specifies the name of the archive file. |
|
zero or one |
Specifies the GlassFish Server release with which to be backward compatible in terms of JAR visibility requirements for applications. |
|
zero or one |
Retains web sessions, stateful session bean instances, and persistently created EJB timers across redeployments. |
|
zero or one |
Contains version information for an application. |
glassfish-application-clientDefines the GlassFish Server specific configuration for an application
client. This is the root element; there can only be one
glassfish-application-client element in a
glassfish-application-client.xml file. See The
glassfish-application-client.xml file.
The following table describes subelements for the
glassfish-application-client element.
Table C-63 glassfish-application-client subelements
| Element | Required | Description |
|---|---|---|
zero or more |
Maps the absolute JNDI name to the |
|
zero or more |
Maps the absolute JNDI name to the |
|
zero or more |
Maps the absolute JNDI name to the |
|
zero or more |
Specifies runtime settings for a web service reference. |
|
zero or more |
Specifies the name of a physical message destination. |
|
zero or more |
Specifies the name of a logical message destination. |
|
zero or one |
Specifies changes to default Java Web Start parameters. |
|
zero or one |
Contains version information for an application client. |
glassfish-ejb-jarDefines the GlassFish Server specific configuration for an EJB JAR file.
This is the root element; there can only be one glassfish-ejb-jar
element in a glassfish-ejb-jar.xml file. See
The glassfish-ejb-jar.xml File.
The following table describes subelements for the glassfish-ejb-jar
element.
Table C-64 glassfish-ejb-jar Subelements
| Element | Required | Description |
|---|---|---|
zero or more |
Maps a role in the corresponding Java EE XML file to a user or group. |
|
only one |
Describes all the runtime properties for an EJB JAR file in the application. |
|
zero or one |
Specifies the GlassFish Server release with which to be backward compatible in terms of JAR visibility requirements for applications. |
|
zero or one |
Disables GlassFish Server specific JNDI names. |
|
zero or one |
Retains stateful session bean instances and persistently created EJB timers across redeployments. |
|
zero or one |
Contains version information for an EJB module. |
glassfish-web-appDefines GlassFish Server specific configuration for a web module. This
is the root element; there can only be one glassfish-web-app element
in a glassfish-web.xml file. See The
glassfish-web.xml File.
The following table describes subelements for the glassfish-web-app
element.
Table C-65 glassfish-web-app Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Contains the web context root for the web module. |
|
zero or more |
Maps roles to users or groups in the currently active realm. |
|
zero or more |
Specifies a principal name for a servlet, which is used
for the |
|
zero or more |
Specifies a URL pattern for idempotent requests. |
|
zero or one |
Specifies session manager, session cookie, and other session-related information. |
|
zero or more |
Maps the absolute JNDI name to the |
|
zero or more |
Maps the absolute JNDI name to the |
|
zero or more |
Maps the absolute JNDI name to the |
|
zero or more |
Specifies runtime settings for a web service reference. |
|
zero or more |
Specifies the name of a physical message destination. |
|
zero or one |
Configures caching for web application components. |
|
zero or one |
Specifies class loader configuration information. |
|
zero or one |
Specifies JSP configuration information. |
|
zero or one |
Deprecated. Use the |
|
zero or one |
Determines the default request character encoding and how the web container decodes parameters from forms according to a hidden field value. |
|
zero or more |
Specifies a property, which has a name and a value. |
|
zero or more |
Specifies a custom valve. |
|
zero or more |
Specifies the name of a logical message destination. |
|
zero or more |
Specifies a name and optional publish location for a web service. |
|
zero or one |
Retains web sessions across redeployments. |
|
zero or one |
Contains version information for a web application. |
The following table describes attributes for the glassfish-web-app
element.
Table C-66 glassfish-web-app Attributes
| Attribute | Default | Description |
|---|---|---|
|
(blank) |
(optional) Not implemented. Do not use. |
|
none |
(optional) Specifies the
|
The following table describes properties for the glassfish-web-app
element.
Table C-67 glassfish-web-app Properties
| Property | Default | Description |
|---|---|---|
|
|
If Caution: Setting this property to |
|
none |
Specifies an alternate document root (docroot), where n is a positive integer that allows specification of more than one. Alternate docroots allow web applications to serve requests for certain resources from outside their own docroot, based on whether those requests match one (or more) of the URI patterns of the web application’s alternate docroots. If a request matches an alternate docroot’s URI pattern, it is mapped to the alternate docroot by appending the request URI (minus the web application’s context root) to the alternate docroot’s physical location (directory). If a request matches multiple URI patterns, the alternate docroot is determined according to the following precedence order:
For example, the following properties specify three alternate docroots. The URI pattern of the first alternate docroot uses an exact match, whereas the URI patterns of the second and third alternate docroots use extension and longest path prefix matches, respectively. The You can set this property for all the web applications on a specific
virtual server. For details, see
|
|
none |
This property is deprecated. Use the Specifies a fully qualified class name of a custom valve, where n is a positive integer that allows specification of more than one. The valve class must implement the org.apache.catalina.Valve interface from Tomcat or previous GlassFish Server releases, or the org.glassfish.web.valve.GlassFishValve interface from the current GlassFish Server release. For example: You can set this property for all the web applications on a specific
virtual server. For details, see
|
|
none |
Specifies a fully qualified class name of a custom Catalina listener, where n is a positive integer that allows specification of more than one. The listener class must implement the org.apache.catalina.ContainerListener, org.apache.catalina.LifecycleListener, or org.apache.catalina.InstanceListener interface. For example: You can set this property for all the web applications on a specific
virtual server. For details, see
|
|
|
If |
|
|
If |
|
|
If |
|
|
Set this property to You can set this property for all the web applications on a specific
virtual server. For details, see
|
|
|
Specifies the maximum number of
servlet instances allocated for each |
|
domain-dir`/generated/`app-name or domain-dir`/generated/`module-name |
Specifies a temporary directory for use by this web module. This value
is used to construct the value of the |
|
|
If |
group-mapMaps an EIS group to a group defined in the GlassFish Server domain.
group-nameSpecifies a group name in the current realm.
security-role-mapping (glassfish-application.xml,
glassfish-web.xml, glassfish-ejb-jar.xml)
http-methodSpecifies an HTTP method that is eligible for caching. The default is
GET.
idempotent-url-patternSpecifies a URL pattern for idempotent requests.
The following table describes attributes for the
idempotent-url-pattern element.
Table C-69 idempotent-url-pattern Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies a URL pattern, which can contain wildcards. The URL pattern must conform to the mappings specified in section SRV 11.2 of the Servlet 2.4 specification. |
|
|
(optional) Specifies the number of times the
load balancer retries an idempotent request. A value of |
integritySpecifies if the target supports integrity-protected messages. The
values are NONE, SUPPORTED, or REQUIRED.
ior-security-configSpecifies the security information for the interoperable object reference (IOR).
The following table describes subelements for the ior-security-config
element.
Table C-70 ior-security-config Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Specifies the security information for transport. |
|
zero or one |
Specifies the authentication mechanism used to
authenticate the client. If specified, it is |
|
zero or one |
Describes the sas-context fields. |
is-cache-overflow-allowedThis element is deprecated. Do not use.
is-read-only-beanSpecifies that this entity bean is a read-only bean if true. If this
element is absent, the default value of false is used.
java-methodSpecifies a method.
The following table describes subelements for the java-method element.
Table C-71 java-method Subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies a method name. |
|
zero or one |
Specifies fully qualified Java type names of method parameters. |
java-web-start-accessSpecifies changes to default Java Web Start parameters for an embedded or stand-alone application client module.
The following table describes subelements for the
java-web-start-access element.
Table C-72 java-web-start-access subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Contains the context root for the Java Web Start enabled application client module. If none is specified, a default is generated. The default for a web module is as follows: The default for a stand-alone application client module is as follows: If the |
|
zero or one |
Specifies whether the application client module is
eligible to be Java Web Start enabled. Allowed values are |
|
zero or one |
Specifies the name of the vendor as it appears in Java
Web Start download and launch screens. The default value is
|
|
zero or one |
Specifies the name of a custom JNLP file. If none is specified, a default JNLP file is generated. |
jdbc-connection-poolDefines the attributes and properties that are required for creating a JDBC connection pool.
The following table describes subelements for the jdbc-connection-pool
element.
Table C-73 jdbc-connection-pool Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Contains a text description of this element. |
|
zero or more |
Specifies a property or a variable. |
The following table describes attributes for the jdbc-connection-pool
element. Changing the following attributes requires a server restart or
the redeployment or disabling and re-enabling of applications that refer
to the resource: datasource-classname, associate-with-thread,
lazy-connection-association, and lazy-connection-enlistment.
Table C-74 jdbc-connection-pool Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the name of the connection pool. A
|
|
none |
(optional) Specifies the class name of the associated vendor-supplied data source. This class must implement javax.sql.DataSource, javax.sql.XADataSource , javax.sql.ConnectionPoolDatasource , or a combination. |
|
none |
(optional) Specifies the interface the data source
class implements. The value of this attribute can be
javax.sql.DataSource, javax.sql.XADataSource ,
javax.sql.ConnectionPoolDatasource , or java.sql.Driver. To support
configuration of JDBC drivers and applications that use java.sql.Driver
implementations, set this attribute to java.sql.Driver . This attribute
must be specified to avoid ambiguity when a data source class implements
two or more of these interfaces or when a |
|
none |
(optional) Specifies the vendor-supplied JDBC driver class name. This driver must implement the java.sql.Driver interface. |
|
|
(optional) Specifies whether to ping the pool during pool creation or reconfiguration to identify and warn of any erroneous attribute values. |
|
|
(optional) Specifies the initial and minimum number of connections maintained in the pool. |
|
|
(optional) Specifies the maximum number of connections that can be created to satisfy client requests. |
|
|
(optional) Specifies the amount
of time, in milliseconds, that the caller is willing to wait for a
connection. If |
|
|
(optional) Specifies the number of idle connections to be destroyed if
the existing number of connections is above the This is enforced periodically at the |
|
|
(optional) Specifies the maximum time that a connection can remain idle in the pool. After this amount of time, the pool can close this connection. This timeout value must be kept shorter than the server side (database) timeout value to prevent the accumulation of unusable connections in the application. |
|
default JDBC driver isolation level |
(optional) Specifies the transaction isolation level on the pooled
database connections. Allowed values are Applications that change the isolation level on a pooled connection
programmatically risk polluting the pool, which can lead to errors. See
|
|
|
(optional) Applicable only
when |
|
|
(optional) Specifies whether connections have to be validated before being given to the application. If a resource’s validation fails, it is destroyed, and a new resource is created and returned. |
|
|
(optional) Legal values are as follows:
Because many JDBC drivers cache the results of The |
|
none |
(optional) Specifies the table name
to be used to perform a query to validate a connection. This parameter
is mandatory if and only if |
|
none |
(optional) Specifies the custom validation implementation class name.
This parameter is mandatory if GlassFish Server provides the following custom validation class templates for MSSQL, DB2, and Sybase databases. All of them implement the org.glassfish.api.jdbc.ConnectionValidation interface.
|
|
none |
(optional) Specifies an SQL string to be executed whenever a connection is created (not reused) in the pool. This initializes the state of the connection. |
|
|
(optional) If |
|
|
(optional) If |
|
|
(optional) If |
|
|
(optional) Specifies the time interval within which a connection is validated at most once. Minimizes the number of validation calls. A value of zero implies that GlassFish Server does not attempt to minimize the number of validation requests by a connection. That is, a value of zero disables this attribute. As a result, the same connection is validated every time the application acquires the connection. |
|
|
(optional) Detects potential connection leaks by the application. A connection that is not returned back to the pool by the application within the specified period is assumed to be potentially leaking, and a stack trace of the caller is logged. A zero value disables leak detection. A nonzero value enables leak tracing. Use this attribute along with |
|
|
(optional) If |
|
|
(optional) Specifies the number of attempts to create a new connection in case of a failure. |
|
|
(optional)
Specifies the time interval between attempts to create a connection when
|
|
|
(optional) Detects potential statement leaks by the application. A statement that is not closed by the application within the specified period is assumed to be potentially leaking, and a stack trace of the caller is logged. A zero value disables leak detection. A nonzero value enables leak tracing. Use this attribute along with |
|
|
(optional) If |
|
|
(optional) Sets the query timeout property of a statement to enable
termination of abnormally long running queries. The default value of
An abnormally long running JDBC query executed by an application may
leave it in a hanging state unless a timeout is explicitly set on the
statement. This attribute guarantees that all queries automatically time
out if not completed within the specified period. When statements are
created, the |
|
|
(optional) If |
|
|
(optional) If |
|
|
(optional) Specifies whether connections are associated with the thread
to enable the thread to reuse the connections. If This attribute associates connections with a thread such that when the
same thread is in need of connections, it can reuse the connections
already associated with that thread. In this case, the overhead of
getting connections from the pool is avoided. However, when this value
is set to |
|
|
(optional) Specifies whether a connection that is selected from the pool
should be matched with the connections with certain credentials. If
If the connection pool is used by applications that have multiple user
credentials, |
|
|
(optional) Specifies the number of times a connections is reused by the pool, after which it is closed. A zero value disables this feature. By limiting the maximum number of times a connection can be reused, you can avoid statement leaks if the application does not close statements. |
|
none |
(optional) Specifies that SQL statements executed by applications need to be traced. Helps administrators analyze the statements. Expects as a value a comma-separated list of listener implementation class names. Enables easy filtering of log messages for the SQL statements. SQL trace listeners must implement the org.glassfish.api.jdbc.SQLTraceListener interface. |
|
|
(optional) Specifies the number of
statements to be cached using the |
|
|
(optional) If |
|
|
(optional) If This option ensures that |
The following table describes properties for the jdbc-connection-pool
element that are specific to GlassFish Server.
Table C-75 jdbc-connection-pool Database Properties
| Property | Default | Description |
|---|---|---|
|
none |
Specifies the timeout for dynamic reconfiguration of the pool. In-progress connection requests must complete before this timeout expires or they must be retried. New connection requests wait for this timeout to expire before acquiring connections to the reconfigured pool. If this property exists and has a positive value, it is enabled. If this property is not set and pool reconfiguration results in pool recreation, in-progress connection requests must be retried. |
|
|
Specifies the number of most frequently used queries to display. For
example, the default value of This property is disabled when |
|
|
Specifies the time to retain queries in a cache before they are purged. This property is disabled when |
Most JDBC drivers allow use of standard property lists to specify the user, password, and other resource configuration information. Although properties are optional with respect to the GlassFish Server, some properties might be necessary for most databases. For details, see the JDBC 4.0 Standard Extension API.
When properties are specified, they are passed to the vendor’s data
source class (specified by the datasource-classname attribute) as is
using setName(value) methods.
The user and password properties are used as the default principal
if container managed authentication is specified and a
default-resource-principal is not found in the application deployment
descriptors.
The following table describes some common properties for the
jdbc-connection-pool element.
Changing JDBC driver properties requires a server restart.
Table C-76 jdbc-connection-pool Database Properties
| Property | Description |
|---|---|
|
Specifies the user name for connecting to the database. |
|
Specifies the password for connecting to the database. |
|
Specifies the database for this connection pool. |
|
Specifies the database server for this connection pool. |
|
Specifies the port on which the database server listens for requests. |
|
Specifies the communication protocol. |
|
Specifies the initial SQL role name. |
|
Specifies an underlying XADataSource, or a ConnectionPoolDataSource if connection pooling is done. |
|
Specifies a text description. |
|
Specifies the URL for this connection pool. Although this is not a standard property, it is commonly used. |
jdbc-resourceDefines a JDBC (javax.sql.DataSource) resource.
The following table describes subelements for the jdbc-resource
element.
Table C-77 jdbc-resource Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Contains a text description of this element. |
|
zero or more |
Specifies a property or a variable. |
The following table describes attributes for the jdbc-resource
element.
Table C-78 jdbc-resource Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the JNDI name for the resource. |
|
none |
(optional) Specifies a text description of this element. |
|
none |
Specifies the |
|
|
(optional) Defines the type of the resource. Allowed values are:
|
|
|
(optional) Determines whether this resource is enabled at runtime. |
jms-durable-subscription-nameSpecifies the durable subscription associated with a message-driven bean class. Only applies to the Java Message Service Topic Destination type, and only when the message-driven bean deployment descriptor subscription durability is Durable.
jms-max-messages-loadSpecifies the maximum number of messages to load into a Java Message Service session at one time for a message-driven bean to serve. The default is 1.
jndi-nameSpecifies the absolute jndi-name of a URL resource or a resource.
For entity beans and session beans, this value specifies the global JNDI
name of the EJBHome object. It is only needed if the entity or session
bean exposes a remote view.
For JMS message-driven beans, this is the JNDI name of the JMS resource
from which the message-driven bean consumes JMS messages. This
information is alternatively specified within the
activation-config subelement of the
mdb-resource-adapter element. For more information about
JMS resources, see "Using the Java Message Service" in
GlassFish Server Open Source Edition Application Development Guide.
ejb-ref, message-destination,
resource-env-ref, resource-ref
(glassfish-web.xml, glassfish-ejb-jar.xml,
glassfish-application-client.xml); cmp-resource,
ejb, mdb-connection-factory
(glassfish-ejb-jar.xml)
jnlp-docContains the name of a custom JNLP file, which modifies the behavior of a Java Web Start enabled application client module. If none is specified, a default JNLP file is generated.
The value of this element is a relative path with the following format:
[path-to-JAR-in-EAR!]path-to-JNLP-in-JARThe default path-to-JAR-in-EAR is the current application client JAR
file. For example, if the JNLP file is in the application client JAR
file at custom/myInfo.jnlp, the element value would look like this:
<java-web-start-access>
<jnlp-doc>custom/myInfo.jnlp</jnlp-doc>
</java-web-start-access>If the application client is inside an EAR file, you can place the
custom JNLP file inside another JAR file in the EAR. For example, if the
JNLP file is in a JAR file at other/myLib.jar, the element value would
look like this, with an exclamation point (!) separating the path to
the JAR from the path in the JAR:
<java-web-start-access>
<jnlp-doc>other/myLib.jar!custom/myInfo.jnlp</jnlp-doc>
</java-web-start-access>For information about the allowed contents of a custom JNLP file, see "Developing Java Clients" in GlassFish Server Open Source Edition Application Development Guide.
jsp-configSpecifies JSP configuration information.
The following table describes subelements for the jsp-config element.
Table C-79 jsp-config Subelements
| Element | Required | Description |
|---|---|---|
zero or more |
Specifies a property, which has a name and a value. |
The default property values are tuned for development of JSP files at
the cost of performance. To maximize performance, set jsp-config
properties to these non-default values:
development - false (as an alternative, set to true and give
modificationTestInterval a large value)
mappedfile - false
trimSpaces - true
suppressSmap - true
fork - false (on Solaris)
classdebuginfo - false
The following table describes properties for the jsp-config element.
Table C-80 jsp-config Properties
| Property | Default | Description |
|---|---|---|
|
|
If |
|
|
Specifies whether the generated Java servlets
are compiled with the debug option set ( |
|
created dynamically based on the current web application |
Specifies the classpath to use when compiling generated servlets. |
|
|
Specifies the compiler Ant uses to compile JSP files. See the Ant documentation for more information: |
|
Depends on GlassFish Server’s Java runtime |
Specifies the JDK release with which source compatibility of the
generated servlets is provided. Same as the For more information, see
|
|
Depends on GlassFish Server’s Java runtime |
Specifies the Virtual Machine for the Java platform (JVM software)
version for which the servlet class files are generated. Same as the
For more information, see
|
|
|
If |
|
|
If set to |
|
|
If set to |
|
|
If set to |
|
|
If set to |
|
|
If set to |
|
|
Specifies that Ant forks the compiling of JSP files, using a JVM machine separate from the one in which Tomcat is running. |
|
|
If |
|
|
If set to |
|
|
Specifies a comma separated list of
HTTP methods supported by the |
|
|
Specifies the Java plug-in COM class ID for Internet Explorer. Used by
the |
|
|
If set to |
|
|
Specifies the initial capacity of the
|
|
|
Specifies the encoding for the generated Java servlet. This encoding is
passed to the Java compiler that is used to compile the servlet as well.
By default, the web container tries to use For encodings, see: |
|
|
If set to |
|
|
If set to |
|
|
Specifies the frequency in seconds at
which JSPs are checked for modification. A value of |
|
|
Specifies the frequency in seconds at which JSP
files are checked for modifications. Setting this value to |
|
|
If |
|
The default work directory for the web application |
Specifies the working directory created for storing all the generated code. |
|
|
If set to |
|
|
If set to |
|
|
If set to It is assumed that JSP files have been precompiled, and their
corresponding servlet classes have been bundled in the web application’s
|
|
|
If set to |
keep-stateIf set to true, retains web sessions, stateful session bean instances,
and persistently created EJB timers across redeployments. The
--keepstate option of the redeploy subcommand
takes precedence. The default for both is false.
Some changes to an application between redeployments prevent this feature from working properly. For example, do not change the set of instance variables in the SFSB bean class.
For web applications, this feature is applicable only if in the
glassfish-web-app.xml file the persistence-type attribute of the
session-manager element is file.
For stateful session bean instances, the persistence type without high
availability is set in the server (the sfsb-persistence-type
attribute) and must be set to file, which is the default and
recommended value.
If any active web session, SFSB instance, or EJB timer fails to be preserved or restored, none of these will be available when the redeployment is complete. However, the redeployment continues and a warning is logged.
To preserve active state data, GlassFish Server serializes the data and saves it in memory. To restore the data, the class loader of the newly redeployed application deserializes the data that was previously saved.
glassfish-application (glassfish-application.xml),
glassfish-web-app (glassfish-web-app.xml),
glassfish-ejb-jar (glassfish-ejb-jar.xml)
key-fieldSpecifies a component of the key used to look up and extract cache entries. The web container looks for the named parameter, or field, in the specified scope.
If this element is not present, the web container uses the Servlet Path (the path section that corresponds to the servlet mapping that activated the current request). See the Servlet 2.4 specification, section SRV 4.4, for details on the Servlet Path.
The following table describes attributes for the key-field element.
Table C-81 key-field Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the input parameter name. |
|
|
(optional) Specifies the scope from which
the input parameter is retrieved. Allowed values are
|
levelSpecifies the name of a hierarchical fetch group. The name must be an integer. Fields and relationships that belong to a hierarchical fetch group of equal (or lesser) value are fetched at the same time. The value of level must be greater than zero. Only one is allowed.
local-home-implSpecifies the fully-qualified class name of the generated EJBLocalHome
impl class.
|
Note
|
This value is automatically generated by the server at deployment or redeployment time. Do not specify it or change it after deployment. |
local-implSpecifies the fully-qualified class name of the generated
EJBLocalObject impl class.
|
Note
|
This value is automatically generated by the server at deployment or redeployment time. Do not specify it or change it after deployment. |
locale-charset-infoDeprecated. For backward compatibility only. Use the
parameter-encoding subelement of
glassfish-web-app instead. Specifies information about
the application’s internationalization settings.
The following table describes subelements for the locale-charset-info
element.
Table C-82 locale-charset-info Subelements
| Element | Required | Description |
|---|---|---|
one or more |
Maps a locale and an agent to a character encoding.
Provided for backward compatibility. Used only for request processing,
and only if no |
|
zero or one |
Determines the default request character encoding and how the web container decodes parameters from forms according to a hidden field value. |
The following table describes attributes for the locale-charset-info
element.
Table C-83 locale-charset-info Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Although a value is required, the value is
ignored. Use the |
locale-charset-mapMaps locales and agents to character encodings. Provided for backward
compatibility. Used only for request processing. Used only if the
character encoding is not specified in the request and cannot be derived
from the optional parameter-encoding element. For
encodings, see
http://docs.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html.
The following table describes subelements for the locale-charset-map
element.
Table C-84 locale-charset-map Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Specifies an optional text description of a mapping. |
The following table describes attributes for the locale-charset-map
element.
Table C-85 locale-charset-map Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the locale name. |
|
none |
(optional) Specifies the type of client that interacts
with the GlassFish Server. For a given locale, different agents can have
different preferred character encodings. The value of this attribute
must exactly match the value of the |
|
none |
Specifies the character encoding to which the locale maps. |
The following table specifies example agent attribute values.
Table C-86 Example agent Attribute Values
| Agent | user-agent Header and agent Attribute Value |
|---|---|
Internet Explorer 5.00 for Windows 2000 |
|
Netscape 4.7.7 for Windows 2000 |
|
Netscape 4.7 for Solaris |
|
localpartSpecifies the local part of a QNAME.
service-qname, wsdl-port
(glassfish-web.xml, glassfish-ejb-jar.xml,
glassfish-application-client.xml)
lock-when-loadedPlaces a database update lock on the rows corresponding to the bean whenever the bean is loaded. How the lock is placed is database-dependent. The lock is released when the transaction finishes (commit or rollback). While the lock is in place, other database users have read access to the bean.
lock-when-modifiedThis element is not implemented. Do not use.
log-serviceSpecifies configuration settings for the log file.
The following table describes subelements for the log-service element.
Table C-87 log-service subelement
| Element | Required | Description |
|---|---|---|
zero or more |
Specifies a property, which has a name and a value. |
The following table describes attributes for the log-service element.
Table C-88 log-service attributes
| Attribute | Default | Description |
|---|---|---|
|
your-ACC-dir`/logs/client.log` |
(optional) Specifies the file where the application client container logging information is stored. |
|
|
(optional) Sets the base level of severity. Messages at or above this setting get logged to the log file. |
login-configSpecifies the authentication configuration for an EJB web service
endpoint. Not needed for servlet web service endpoints. A servlet’s
security configuration is contained in the web.xml file.
The following table describes subelements for the login-config
element.
Table C-89 login-config subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the authentication method. |
|
zero or one |
Specifies the name of the realm used to process all authentication requests. |
mail-resourceDefines a JavaMail (javax.mail.Session) resource.
The following table describes subelements for the mail-resource
element.
Table C-90 mail-resource Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Contains a text description of this element. |
|
zero or more |
Specifies a property or a variable. |
The following table describes attributes for the mail-resource
element.
Table C-91 mail-resource Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the JNDI name for the resource. |
|
|
(optional) Specifies the storage protocol
service, which connects to a mail server, retrieves messages, and saves
messages in folder(s). Allowed values are |
|
|
(optional) Specifies the service provider implementation class for storage. Allowed values are:
|
|
|
(optional) Specifies the transport
protocol service, which sends messages. Allowed values are |
|
|
(optional) Specifies the service provider implementation class for transport. Allowed values are:
|
|
none |
The mail server host name. |
|
none |
The mail server user name. |
|
none |
The email address the mail server uses to indicate the message sender. |
|
|
(optional) Determines whether debugging for this resource is enabled. |
|
|
(optional) Defines the type of the resource. Allowed values are:
|
|
|
(optional) Determines whether this resource is enabled at runtime. |
You can set properties for the mail-resource element and then get
these properties in a JavaMail Session object later. Every property
name must start with a mail- prefix. The GlassFish Server changes the
dash (-) character to a period (.) in the name of the property, then
saves the property to the MailConfiguration and JavaMail Session
objects. If the name of the property doesn’t start with mail-, the
property is ignored.
For example, to define the property mail.password in a JavaMail
Session object, first edit glassfish-resources.xml as follows:
...
<mail-resource jndi-name="mail/Session" ...>
<property name="mail-password" value="adminadmin"/>
</mail-resource>
...After getting the JavaMail Session object, get the mail.password
property to retrieve the value adminadmin, as follows:
String password = session.getProperty("mail.password");For more information about JavaMail properties, see
JavaMail API
Documentation (http://javamail.kenai.com/nonav/javadocs/index.html).
manager-propertiesSpecifies session manager properties.
The following table describes subelements for the manager-properties
element.
Table C-92 manager-properties Subelements
| Element | Required | Description |
|---|---|---|
zero or more |
Specifies a property, which has a name and a value. |
The following table describes properties for the manager-properties
element.
Table C-93 manager-properties Properties
| Property | Default | Description |
|---|---|---|
|
|
Specifies the number of seconds between checks for expired sessions.
This is also the interval at which sessions are passivated if
If To prevent data inconsistency, set this value lower than the frequency
at which session data changes. For example, this value should be as low
as possible ( Applicable only if the |
|
|
Specifies the maximum number of sessions that are permitted in the
cache, or If the |
|
empty string |
Specifies the absolute or relative path to the directory in which the session state is preserved between application restarts, if preserving the state is possible. A relative path is relative to the temporary directory for this web module, one of the following: domain-dir`/generated/jsp/`module-name domain-dir`/generated/jsp/ By default, this property’s value is set to an empty string, which disables this property and does not preserve the session state. Applicable only if the |
|
|
Specifies how often the session state is stored. Allowed values are as follows:
Applicable only if the |
max-cache-sizeSpecifies the maximum number of beans allowable in cache. A value of zero indicates an unbounded cache. In reality, there is no hard limit. The max-cache-size limit is just a hint to the cache implementation. Default is 512.
Applies to stateful session beans and entity beans.
max-pool-sizeSpecifies the maximum number of bean instances in the pool. Values are from 0 (1 for message-driven bean) to MAX_INTEGER. A value of 0 means the pool is unbounded. Default is 64.
Applies to all beans.
max-wait-time-in-millisThis element is deprecated. Do not use.
mdb-connection-factorySpecifies the connection factory associated with a message-driven bean. Queue or Topic type must be consistent with the Java Message Service Destination type associated with the message-driven bean class.
The following table describes subelements for the
mdb-connection-factory element.
Table C-94 mdb-connection-factory Subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the absolute |
|
zero or one |
Specifies the default sign-on (name/password) to the resource manager. |
mdb-resource-adapterSpecifies runtime configuration information for a message-driven bean.
The following table describes subelements for the mdb-resource-adapter
element.
Table C-95 mdb-resource-adapter subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Specifies a resource adapter module ID. |
|
one or more |
Specifies an activation configuration. |
messageSpecifies the methods or operations to which message security requirements apply.
message-security (glassfish-web.xml,
glassfish-ejb-jar.xml, glassfish-application-client.xml)
The following table describes subelements for the message element.
Table C-96 message Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Specifies the methods or operations to which message security requirements apply. |
|
zero or one |
Specifies the WSDL name of an operation of a web service. |
message-destinationSpecifies the name of a logical message-destination defined within an
application. The message-destination-name matches the corresponding
message-destination-name in the corresponding Java EE deployment
descriptor file. Use when the message destination reference in the
corresponding Java EE deployment descriptor file specifies a
message-destination-link to a logical message-destination.
glassfish-web-app (glassfish-web.xml),
enterprise-beans (glassfish-ejb-jar.xml),
glassfish-application-client
(glassfish-application-client.xml)
The following table describes subelements for the message-destination
element.
Table C-97 message-destination subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the name of a logical message destination defined within the corresponding Java EE deployment descriptor file. |
|
only one |
Specifies the |
message-destination-nameSpecifies the name of a logical message destination defined within the corresponding Java EE deployment descriptor file.
message-destination (glassfish-web.xml,
glassfish-ejb-jar.xml, glassfish-application-client.xml)
message-destination-refDirectly binds a message destination reference to the JNDI name of a
Queue, Topic, or other physical destination. Use only when the
message destination reference in the corresponding Java EE deployment
descriptor file does not specify a message-destination-link to a
logical message-destination.
glassfish-web-app (glassfish-web.xml),
ejb (glassfish-ejb-jar.xml),
glassfish-application-client
(glassfish-application-client.xml)
The following table describes subelements for the
message-destination-ref element.
Table C-98 message-destination-ref subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the name of a physical message destination defined within the corresponding Java EE deployment descriptor file. |
|
only one |
Specifies the |
message-destination-ref-nameSpecifies the name of a physical message destination defined within the corresponding Java EE deployment descriptor file.
message-destination-ref (glassfish-web.xml,
glassfish-ejb-jar.xml, glassfish-application-client.xml)
message-securitySpecifies message security requirements.
If the grandparent element is webservice-endpoint,
these requirements pertain to request and response messages of the
endpoint.
If the grandparent element is port-info, these
requirements pertain to the port of the referenced service.
message-security-binding (glassfish-web.xml,
glassfish-ejb-jar.xml, glassfish-application-client.xml)
The following table describes subelements for the message-security
element.
Table C-99 message-security Subelements
| Element | Required | Description |
|---|---|---|
one or more |
Specifies the methods or operations to which message security requirements apply. |
|
zero or one |
Defines the authentication policy requirements of the application’s request processing. |
|
zero or one |
Defines the authentication policy requirements of the application’s response processing. |
message-security-bindingSpecifies a custom authentication provider binding for a parent
webservice-endpoint or port-info element
in one or both of these ways:
By binding to a specific provider
By specifying the message security requirements enforced by the provider
webservice-endpoint, port-info
(glassfish-web.xml, glassfish-ejb-jar.xml,
glassfish-application-client.xml)
The following table describes subelements for the
message-security-binding element.
Table C-100 message-security-binding Subelements
| Element | Required | Description |
|---|---|---|
zero or more |
Specifies message security requirements. |
The following table describes attributes for the
message-security-binding element.
Table C-101 message-security-binding Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the message layer at which authentication
is performed. The value must be |
|
none |
(optional) Specifies the authentication provider used to satisfy application-specific message security requirements. If this attribute is not specified, a default provider is used, if it is defined for the message layer. if no default provider is defined, authentication requirements defined
in the |
message-security-configSpecifies configurations for message security providers.
The following table describes subelements for the
message-security-config element.
Table C-102 message-security-config Subelements
| Element | Required | Description |
|---|---|---|
one or more |
Specifies a configuration for one message security provider. |
The following table describes attributes for the
message-security-config element.
Table C-103 message-security-config Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the message layer at which authentication
is performed. The value must be |
|
none |
(optional) Specifies the server provider that is invoked for any application not bound to a specific server provider. |
|
none |
(optional) Specifies the client provider that is invoked for any application not bound to a specific client provider. |
methodSpecifies a bean method.
The following table describes subelements for the method element.
Table C-104 method Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Specifies an optional text description. |
|
zero or one |
Matches the |
|
only one |
Specifies a method name. |
|
zero or one |
Specifies the method interface to distinguish between methods with the same name in different interfaces. |
|
zero or one |
Specifies fully qualified Java type names of method parameters. |
method-intfSpecifies the method interface to distinguish between methods with the
same name in different interfaces. Allowed values are Home, Remote,
LocalHome, and Local.
method-nameSpecifies a method name or * (an asterisk) for all methods. If a
method is overloaded, specifies all methods with the same name.
java-method (glassfish-web.xml,
glassfish-ejb-jar.xml, glassfish-application-client.xml);
finder, query-method ,
method (glassfish-ejb-jar.xml)
method-paramSpecifies the fully qualified Java type name of a method parameter.
method-params (glassfish-web.xml,
glassfish-ejb-jar.xml, glassfish-application-client.xml)
method-paramsSpecifies fully qualified Java type names of method parameters.
java-method (glassfish-web.xml,
glassfish-ejb-jar.xml, glassfish-application-client.xml);
query-method, method
(glassfish-ejb-jar.xml)
The following table describes subelements for the method-params
element.
Table C-105 method-params Subelements
| Element | Required | Description |
|---|---|---|
zero or more |
Specifies the fully qualified Java type name of a method parameter. |
nameSpecifies the name of the entity.
call-property, default-resource-principal,
stub-property (glassfish-web.xml,
glassfish-ejb-jar.xml, glassfish-application-client.xml);
enterprise-beans, principal,
property (with subelements) (glassfish-ejb-jar.xml)
named-groupSpecifies the name of one independent fetch group. All the fields and relationships that are part of a named group are fetched at the same time. A field belongs to only one fetch group, regardless of what type of fetch group is used.
namespaceURISpecifies the namespace URI.
service-qname, wsdl-port
(glassfish-web.xml, glassfish-ejb-jar.xml,
glassfish-application-client.xml)
noneSpecifies that this field or relationship is fetched by itself, with no other fields or relationships.
one-one-findersDescribes the finders for CMP 1.1 beans.
The following table describes subelements for the one-one-finders
element.
Table C-106 one-one-finders Subelements
| Element | Required | Description |
|---|---|---|
one or more |
Describes the finders for CMP 1.1 with a method name and query. |
operation-nameSpecifies the WSDL name of an operation of a web service.
parameter-encodingSpecifies the default request character encoding and how the web container decodes parameters from forms according to a hidden field value.
If both the glassfish-web-app and
locale-charset-info elements have parameter-encoding
subelements, the subelement of glassfish-web-app takes precedence. For
encodings, see
http://docs.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html.
The following table describes attributes for the parameter-encoding
element.
Table C-107 parameter-encoding Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
(optional) The name of the hidden field in the
form. This field specifies the character encoding the web container uses
for |
|
|
(optional) The default request character encoding. |
pass-by-referenceSpecifies the passing method used by a servlet or enterprise bean calling a remote interface method in another bean that is colocated within the same process.
If false (the default if this element is not present), this
application uses pass-by-value semantics.
If true, this application uses pass-by-reference semantics.
|
Note
|
The If the Portable programs cannot assume that a copy of the object is made during
such a call, and thus that it’s safe to modify the original. Nor can
they assume that a copy is not made, and thus that changes to the object
are visible to both caller and callee. When this element is set to
|
When a servlet or enterprise bean calls a remote interface method in another bean that is colocated within the same process, by default GlassFish Server makes copies of all the call parameters in order to preserve the pass-by-value semantics. This increases the call overhead and decreases performance.
However, if the calling method does not change the object being passed
as a parameter, it is safe to pass the object itself without making a
copy of it. To do this, set the pass-by-reference value to true.
The setting of this element in the glassfish-application.xml file
applies to all EJB modules in the application. For an individually
deployed EJB module, you can set the same element in the
glassfish-ejb-jar.xml file. If pass-by-reference is used at both the
bean and application level, the bean level takes precedence.
passwordSpecifies the password for the principal.
default-resource-principal (glassfish-web.xml,
glassfish-ejb-jar.xml, glassfish-application-client.xml)
per-request-load-balancingSpecifies the per-request load balancing behavior of EJB 2.x and 3.x
remote client invocations on a stateless session bean. If set to true,
per-request load balancing is enabled for the associated stateless
session bean. If set to false or not set, per-request load balancing
is not enabled. The default is false.
pm-descriptorsThis element and its subelements are deprecated. Do not use.
pool-idle-timeout-in-secondsSpecifies the maximum time, in seconds, that a bean instance is allowed to remain idle in the pool. When this timeout expires, the bean instance in a pool becomes a candidate for passivation or deletion. This is a hint to the server. A value of 0 specifies that idle beans remain in the pool indefinitely. Default value is 600.
Applies to stateless session beans, entity beans, and message-driven beans.
|
Note
|
For a stateless session bean or a message-driven bean, the bean is removed (garbage collected) when the timeout expires. |
port-component-nameSpecifies a unique name for a port component within a web or EJB module.
port-infoSpecifies information for a port within a web service reference.
Either a service-endpoint-interface or a wsdl-port or both must be
specified. If both are specified, wsdl-port specifies the port that
the container chooses for container-managed port selection.
The same wsdl-port value must not appear in more than one port-info
element within the same service-ref.
If a service-endpoint-interface is using container-managed port
selection, its value must not appear in more than one port-info
element within the same service-ref.
service-ref (glassfish-web.xml,
glassfish-ejb-jar.xml, glassfish-application-client.xml)
The following table describes subelements for the port-info element.
Table C-108 port-info subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Specifies the web service reference name relative to
|
|
zero or one |
Specifies the WSDL port. |
|
zero or more |
Specifies JAX-RPC property values that are set on a
|
|
zero or more |
Specifies JAX-RPC property values that are set on a
|
|
zero or one |
Specifies a custom authentication provider binding. |
prefetch-disabledDisables prefetching of entity bean states for the specified query
methods. Container-managed relationship fields are prefetched if their
fetched-with element is set to default.
The following table describes subelements for the prefetch-disabled
element.
Table C-109 prefetch-disabled Subelements
| Element | Required | Description |
|---|---|---|
one or more |
Specifies a query method. |
principalDefines a user name on the platform.
The following table describes subelements for the principal element.
Table C-110 principal Subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the name of the user. |
principal-mapMaps an EIS principal to a principal defined in the GlassFish Server domain.
principal-nameContains the principal (user) name.
In an enterprise bean, specifies the principal (user) name that has the
run-as role specified.
security-role-mapping (glassfish-application.xml,
glassfish-web.xml, glassfish-ejb-jar.xml), servlet
(glassfish-web.xml)
The following table describes attributes for the principal-name
element.
Table C-112 principal-name Attributes
| Attribute | Default | Description |
|---|---|---|
|
|
(optional) Specifies the custom principal implementation class corresponding to the named principal. |
property (with attributes)Specifies the name and value of a property. A property adds configuration information to its parent element that is one or both of the following:
Optional with respect to GlassFish Server
Needed by a system or object that GlassFish Server doesn’t have knowledge of, such as an LDAP server or a Java class
cache, cache-helper,
class-loader, cookie-properties,
default-helper, manager-properties,
session-properties, store-properties,
glassfish-web-app, valve,
webservice-endpoint (glassfish-web.xml);
auth-realm, client-container,
client-credential, log-service,
provider-config (sun-acc.xml);
admin-object-resource,
connector-connection-pool,
connector-resource, custom-resource,
external-jndi-resource,
jdbc-connection-pool, jdbc-resource,
mail-resource, resource-adapter-config
(glassfish-resources.xml)
The following table describes subelements for the property element.
Table C-113 property Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Specifies an optional text description of a property. |
|
Note
|
The |
The following table describes attributes for the property element.
Table C-114 property Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the name of the property. |
|
none |
Specifies the value of the property. |
property (with subelements)Specifies the name and value of a property. A property adds configuration information to its parent element that is one or both of the following:
Optional with respect to GlassFish Server
Needed by a system or object that GlassFish Server doesn’t have knowledge of, such as an LDAP server or a Java class
enterprise-beans, cmp-resource,
schema-generator-properties,
webservice-endpoint (glassfish-ejb-jar.xml)
The following table describes subelements for the property element.
Table C-115 property subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the name of the property. |
|
only one |
Specifies the value of the property. |
provider-configSpecifies 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.
The following table describes subelements for the provider-config
element.
Table C-116 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, which has a name and a value. |
The following table describes attributes for the provider-config
element.
Table C-117 provider-config Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the provider ID. |
|
none |
Specifies whether the provider is a |
|
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. |
query-filterSpecifies the query filter for the CMP 1.1 finder.
query-methodSpecifies a query method.
The following table describes subelements for the query-method
element.
Table C-118 query-method Subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies a method name. |
|
only one |
Specifies the fully qualified Java type names of method parameters. |
query-orderingSpecifies the query ordering for the CMP 1.1 finder.
query-paramsSpecifies the query parameters for the CMP 1.1 finder.
query-variablesSpecifies variables in the query expression for the CMP 1.1 finder.
read-onlySpecifies that a field is read-only if true. If this element is
absent, the default value is false .
realmSpecifies the name of the realm used to process all authentication requests associated with this application. If this element is not specified or does not match the name of a configured realm, the default realm is used. For more information about realms, see "Realm Configuration" in GlassFish Server Open Source Edition Application Development Guide.
glassfish-application (glassfish-application.xml),
as-context, login-config
(glassfish-ejb-jar.xml)
refresh-fieldSpecifies a field that gives the application component a programmatic way to refresh a cached entry.
The following table describes attributes for the refresh-field
element.
Table C-119 refresh-field Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the input parameter name. |
|
|
(optional) Specifies the scope from which
the input parameter is retrieved. Allowed values are
|
refresh-period-in-secondsSpecifies the rate at which a read-only-bean must be refreshed from the data source. If the value is less than or equal to zero, the bean is never refreshed; if the value is greater than zero, the bean instances are refreshed at the specified interval. This rate is just a hint to the container. Default is 0 (no refresh).
removal-timeout-in-secondsSpecifies the amount of time a bean instance can remain idle in the container before it is removed (timeout). A value of 0 specifies that the container does not remove inactive beans automatically. The default value is 5400.
If removal-timeout-in-seconds is less than or equal to
cache-idle-timeout-in-seconds, beans are removed immediately without
being passivated.
Applies to stateful session beans.
For related information, see
cache-idle-timeout-in-seconds.
remote-home-implSpecifies the fully-qualified class name of the generated EJBHome
impl class.
|
Note
|
This value is automatically generated by the server at deployment or redeployment time. Do not specify it or change it after deployment. |
remote-implSpecifies the fully-qualified class name of the generated EJBObject
impl class.
|
Note
|
This value is automatically generated by the server at deployment or redeployment time. Do not specify it or change it after deployment. |
request-policyDefines the authentication policy requirements of the authentication provider’s request processing.
The following table describes attributes for the request-policy
element.
Table C-120 request-policy Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the type of required authentication,
either |
|
none |
Specifies whether recipient authentication
occurs before or after content authentication. Allowed values are
|
request-protectionDefines the authentication policy requirements of the application’s request processing.
message-security (glassfish-web.xml,
glassfish-ejb-jar.xml, glassfish-application-client.xml)
The following table describes attributes for the request-protection
element.
Table C-121 request-protection Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the type of required authentication,
either |
|
none |
Specifies whether recipient authentication
occurs before or after content authentication. Allowed values are
|
requiredSpecifies whether the authentication method specified in the
auth-method element must be used for client
authentication. The value is true or false (the default).
res-ref-nameSpecifies the res-ref-name in the corresponding Java EE deployment
descriptor file resource-ref entry. The res-ref-name element
specifies the name of a resource manager connection factory reference.
The name must be unique within an enterprise bean.
resource-ref (glassfish-web.xml,
glassfish-ejb-jar.xml, glassfish-application-client.xml)
resize-quantitySpecifies the number of bean instances to be:
Created, if a request arrives when the pool has less than
steady-pool-size quantity of beans (applies to pools only
for creation). If the pool has more than steady-pool-size minus
resize-quantity of beans, then resize-quantity is still
created.
Removed, when the pool-idle-timeout-in-seconds timer
expires and a cleaner thread removes any unused instances.
For caches, when max-cache-size is reached,
resize-quantity beans are selected for passivation using the
victim-selection-policy. In addition, the
cache-idle-timeout-in-seconds or
removal-timeout-in-seconds timers passivate beans from
the cache.
For pools, when the max-pool-size is reached,
resize-quantity beans are selected for removal. In addition, the
pool-idle-timeout-in-seconds timer removes beans until
steady-pool-size is reached.
Values are from 0 to MAX_INTEGER. The pool is not resized below the
steady-pool-size. Default is 16.
Applies to stateless session beans, entity beans, and message-driven beans.
For EJB pools, the value can be defined in the EJB container. Default is 16.
For EJB caches, the value can be defined in the EJB container. Default is 32.
For message-driven beans, the value can be defined in the EJB container. Default is 2.
resource-adapter-configDefines a connector (resource adapter) configuration. Stores
configuration information for the resource adapter JavaBean in
property subelements.
The following table describes subelements for the
resource-adapter-config element.
Table C-122 resource-adapter-config Subelements
| Element | Required | Description |
|---|---|---|
zero or more |
Specifies a property or a variable. |
The following table describes attributes for the
resource-adapter-config element.
Table C-123 resource-adapter-config Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
(optional) Not used. See |
|
none |
(optional) Specifies a comma-separated list of the names of thread pools. |
|
|
(optional) Defines the type of the resource. Allowed values are:
|
|
none |
Specifies the name of a deployed connector module or application. If the resource adapter is embedded in an application, then it is app_name`#`rar_name. |
resource-adapter-midSpecifies the module ID of the resource adapter that is responsible for delivering messages to the message-driven bean.
resource-env-refMaps the res-ref-name in the corresponding Java EE deployment
descriptor file resource-env-ref entry to the absolute jndi-name of
a resource.
glassfish-web-app (glassfish-web.xml),
ejb (glassfish-ejb-jar.xml),
glassfish-application-client
(glassfish-application-client.xml)
The following table describes subelements for the resource-env-ref
element.
Table C-124 resource-env-ref Subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the |
|
only one |
Specifies the absolute |
resource-env-ref-nameSpecifies the res-ref-name in the corresponding Java EE deployment
descriptor file resource-env-ref entry.
resource-env-ref (glassfish-web.xml,
glassfish-ejb-jar.xml, glassfish-application-client.xml)
resource-refMaps the res-ref-name in the corresponding Java EE deployment
descriptor file resource-ref entry to the absolute jndi-name of a
resource.
|
Note
|
Connections acquired from JMS connection factories are not shareable in
the current release of GlassFish Server. The When |
glassfish-web-app (glassfish-web.xml),
ejb (glassfish-ejb-jar.xml),
glassfish-application-client
(glassfish-application-client.xml)
The following table describes subelements for the resource-ref
element.
Table C-125 resource-ref Subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the |
|
only one |
Specifies the absolute |
|
zero or one |
Specifies the default principal (user) for the resource. |
resourcesDefines application-scoped resources for an enterprise application, web
module, EJB module, connector module, or application client module. This
is the root element; there can only be one resources element in a
glassfish-resources.xml file. See The
glassfish-resources.xml File.
|
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 a
GlassFish Server application should begin with the string |
The following table describes subelements for the resources element.
Table C-126 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 |
response-policyDefines the authentication policy requirements of the authentication provider’s response processing.
The following table describes attributes for the response-policy
element.
Table C-127 response-policy Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the type of required authentication,
either |
|
none |
Specifies whether recipient authentication
occurs before or after content authentication. Allowed values are
|
response-protectionDefines the authentication policy requirements of the application’s response processing.
message-security (glassfish-web.xml,
glassfish-ejb-jar.xml, glassfish-application-client.xml)
The following table describes attributes for the response-protection
element.
Table C-128 response-protection Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the type of required authentication,
either |
|
none |
Specifies whether recipient authentication
occurs before or after content authentication. Allowed values are
|
role-nameContains the role-name in the security-role element of the
corresponding Java EE deployment descriptor file.
security-role-mapping (glassfish-application.xml,
glassfish-web.xml, glassfish-ejb-jar.xml)
sas-contextDescribes the sas-context fields.
The following table describes subelements for the sas-context element.
Table C-129 sas-context Subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies whether the target accepts propagated caller identities. The values are NONE, SUPPORTED, or REQUIRED. |
schemaSpecifies the file that contains a description of the database schema to
which the beans in this sun-cmp-mappings.xml file are mapped. If this
element is empty, the database schema file is automatically generated at
deployment time. Otherwise, the schema element names a .dbschema
file with a pathname relative to the directory containing the
sun-cmp-mappings.xml file, but without the .dbschema extension. See
"Automatic Database Schema Capture" in GlassFish
Server Open Source Edition Application Development Guide.
schema-generator-propertiesSpecifies field-specific column attributes in property subelements.
The following table describes subelements for the
schema-generator-properties element.
Table C-130 schema-generator-properties Subelements
| Element | Required | Description |
|---|---|---|
zero or more |
Specifies a property name and value. |
The following table describes properties for the
schema-generator-properties element.
Table C-131 schema-generator-properties Properties
| Property | Default | Description |
|---|---|---|
|
|
Specifies that generated table names are unique within each GlassFish Server domain. This property can be overridden during deployment. See "Generation Options for CMP" in GlassFish Server Open Source Edition Application Development Guide. |
bean-name`. |
none |
Defines a column attribute. For attribute descriptions, see Table C-132. |
The following table lists the column attributes for properties defined
in the schema-generator-properties element.
Table C-132 schema-generator-properties Column Attributes
| Attribute | Description |
|---|---|
|
Specifies the JDBC type of the column created for the CMP field. The actual SQL type generated is based on this JDBC type but is database vendor specific. |
|
Specifies the maximum number of characters stored in the column corresponding to the CMP field. Applies only when the actual SQL that is generated for the column requires a length. For example, a |
|
Specifies the maximum number of digits stored in a column which represents a numeric type. |
|
Specifies the number of digits stored to the right of the decimal point in a column that represents a floating point number. |
|
Specifies whether the column generated for the CMP field allows null values. |
<schema-generator-properties>
<property>
<name>Employee.firstName.jdbc-type</name>
<value>char</value>
</property>
<property>
<name>Employee.firstName.jdbc-maximum-length</name>
<value>25</value>
</property>
<property>
<name>use-unique-table-names</name>
<value>true</value>
</property>
</schema-generator-properties>secondary-tableSpecifies a bean’s secondary table(s).
The following table describes subelements for the secondary-table
element.
Table C-133 secondary table Subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the name of a database table. |
|
one or more |
Specifies the pair of columns that determine the relationship between two database tables. |
securityDefines the SSL security configuration for IIOP/SSL communication with the target server.
security-mapMaps the principal received during servlet or EJB authentication to the credentials accepted by the EIS. This mapping is optional. It is possible to map multiple GlassFish Server principals to the same back-end principal.
This is different from a work-security-map, which maps a
principal associated with an incoming work instance to a principal in
the GlassFish Server’s security domain.
The following table describes subelements for the security-map
element.
Table C-135 security-map Subelements
| Element | Required | Description |
|---|---|---|
one or more |
Contains the principal of the servlet or EJB client. |
|
one or more |
Contains the group to which the principal belongs. |
|
only one |
Specifies the user name and password required by the EIS. |
security-role-mappingMaps roles to users or groups in the currently active realm. See "Realm Configuration" in GlassFish Server Open Source Edition Application Development Guide.
The role mapping element maps a role, as specified in the EJB JAR
role-name entries, to a environment-specific user or group. If it maps
to a user, it must be a concrete user which exists in the current realm,
who can log into the server using the current authentication method. If
it maps to a group, the realm must support groups and the group must be
a concrete group which exists in the current realm. To be useful, there
must be at least one user in that realm who belongs to that group.
glassfish-application (glassfish-application.xml),
glassfish-web-app (glassfish-web.xml),
glassfish-ejb-jar (glassfish-ejb-jar.xml)
The following table describes subelements for the
security-role-mapping element.
Table C-137 security-role-mapping Subelements
| Element | Required | Description |
|---|---|---|
only one |
Contains the |
|
one or more if no |
Contains a principal (user) name in the current realm. In an enterprise bean, the principal must have the run-as role specified. |
|
one or more if no |
Contains a group name in the current realm. |
service-endpoint-interfaceSpecifies the web service reference name relative to java:comp/env.
port-info (glassfish-web.xml, glassfish-ejb-jar.xml,
glassfish-application-client.xml)
service-impl-classSpecifies the name of the generated service implementation class.
service-ref (glassfish-web.xml,
glassfish-ejb-jar.xml, glassfish-application-client.xml)
service-qnameSpecifies the WSDL service element that is being referred to.
service-ref (glassfish-web.xml,
glassfish-ejb-jar.xml, glassfish-application-client.xml);
webservice-endpoint (glassfish-web.xml,
glassfish-ejb-jar.xml)
The following table describes subelements for the service-qname
element.
Table C-138 service-qname subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the namespace URI. |
|
only one |
Specifies the local part of a QNAME. |
service-refSpecifies runtime settings for a web service reference. Runtime information is only needed in the following cases:
To define the port used to resolve a container-managed port
To define the default Stub/Call property settings for Stub objects
To define the URL of a final WSDL document to be used instead of the
one associated with the service-ref in the standard Java EE deployment
descriptor
glassfish-web-app (glassfish-web.xml),
ejb (glassfish-ejb-jar.xml),
glassfish-application-client
(glassfish-application-client.xml)
The following table describes subelements for the service-ref element.
Table C-139 service-ref subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the web service reference name relative to
|
|
zero or more |
Specifies information for a port within a web service reference. |
|
zero or more |
Specifies JAX-RPC property values that can be set on a
|
|
zero or one |
Specifies a valid URL pointing to a final WSDL document. |
|
zero or one |
Specifies the name of the generated service implementation class. |
|
zero or one |
Specifies the WSDL service element that is being referenced. |
service-ref-nameSpecifies the web service reference name relative to java:comp/env.
service-ref (glassfish-web.xml,
glassfish-ejb-jar.xml, glassfish-application-client.xml)
servletSpecifies a principal name for a servlet. Used for the run-as role
defined in web.xml.
The following table describes subelements for the servlet element.
Table C-140 servlet Subelements
| Element | Required | Description |
|---|---|---|
only one |
Contains the name of a servlet, which is matched to a
|
|
zero or one |
Contains a principal (user) name in the current realm. |
|
zero or more |
Specifies information about a web service endpoint. |
servlet-impl-classSpecifies the automatically generated name of the servlet implementation class.
servlet-nameSpecifies the name of a servlet, which is matched to a servlet-name in
web.xml. This name must be present in web.xml.
session-configSpecifies session configuration information. Overrides the web container settings for an individual web module.
The following table describes subelements for the session-config
element.
Table C-141 session-config Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Specifies session manager configuration information. |
|
zero or one |
Specifies session properties. |
|
zero or one |
Specifies session cookie properties. |
session-managerSpecifies session manager information.
The following table describes subelements for the session-manager
element.
Table C-142 session-manager Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Specifies session manager properties. |
|
zero or one |
Specifies session persistence (storage) properties. |
The following table describes attributes for the session-manager
element.
Table C-143 session-manager Attributes
| Attribute | Default | Description |
|---|---|---|
|
|
(optional) Specifies the session persistence mechanism. Allowed values
are If you have installed and configured Coherence*Web, the |
session-propertiesSpecifies session properties.
The following table describes subelements for the session-properties
element.
Table C-144 session-properties Subelements
| Element | Required | Description |
|---|---|---|
zero or more |
Specifies a property, which has a name and a value. |
The following table describes properties for the session-properties
element.
Table C-145 session-properties Properties
| Property | Default | Description |
|---|---|---|
|
|
Specifies the default maximum inactive interval (in seconds) for all
sessions created in this web module. If set to If a Note that the |
|
|
Uses cookies for session tracking if set to
|
|
|
Enables URL rewriting. This provides
session tracking via URL rewriting when the browser does not accept
cookies. You must also use an |
sslDefines SSL processing parameters.
The following table describes attributes for the SSL element.
Table C-146 ssl attributes
| Attribute | Default | Description |
|---|---|---|
|
|
(optional) The nickname of the server
certificate in the certificate database or the PKCS#11 token. In the
certificate, the name format is tokenname`: |
|
|
(optional) Determines whether SSL2 is enabled. |
|
none |
(optional) A comma-separated list of the SSL2
ciphers to be used. Ciphers not explicitly listed will be disabled for
the target, even if those ciphers are available in the particular cipher
suite you are using. If this option is not used, all supported ciphers
are assumed to be enabled. Allowed values are |
|
|
(optional) Determines whether SSL3 is enabled. |
|
none |
(optional) A comma-separated list of the
SSL3 and/or TLS ciphers to be used. Ciphers not explicitly listed will
be disabled for the target, even if those ciphers are available in the
particular cipher suite you are using. If this option is not used, all
supported ciphers are assumed to be enabled. Allowed values are
|
|
|
(optional) Determines whether TLS is enabled. |
|
|
(optional) Determines whether TLS rollback is enabled. Enable TLS rollback for Microsoft Internet Explorer 5.0 and 5.5. |
steady-pool-sizeSpecifies the initial and minimum number of bean instances that are maintained in the pool. Default is 32. Applies to stateless session beans and message-driven beans.
store-propertiesSpecifies session persistence (storage) properties.
The following table describes subelements for the store-properties
element.
Table C-147 store-properties Subelements
| Element | Required | Description |
|---|---|---|
zero or more |
Specifies a property, which has a name and a value. |
The following table describes properties for the store-properties
element.
Table C-148 store-properties Properties
| Property | Default | Description |
|---|---|---|
|
domain-dir`/generated/jsp/ |
Specifies the absolute or relative pathname of the directory into which individual session files are written. A relative path is relative to the temporary work directory for this web module. Applicable only if the |
|
|
Specifies how much of the session state is stored. Allowed values are as follows:
Applicable only if the |
If the persistenceScope store property is set to modified-attribute,
a web module must follow these guidelines:
Call setAttribute every time the session state is modified.
Make sure there are no cross-references between attributes. The object graph under each distinct attribute key is serialized and stored separately. If there are any object cross references between the objects under each separate key, they are not serialized and deserialized correctly.
Distribute the session state across multiple attributes, or at least between a read-only attribute and a modifiable attribute.
stub-propertySpecifies JAX-RPC property values that are set on a javax.xml.rpc.Stub
object before it is returned to the web service client. The property
names can be any properties supported by the JAX-RPC Stub
implementation.
port-info (glassfish-web.xml, glassfish-ejb-jar.xml,
glassfish-application-client.xml)
The following table describes subelements for the stub-property
element.
Table C-149 stub-property subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the name of the entity. |
|
only one |
Specifies the value of the entity. |
The following table describes properties for the stub-property
element.
Table C-150 stub-property properties
| Property | Default | Description |
|---|---|---|
|
|
Determines whether the visibility of this endpoint as a Java Business Integration service is enabled or disabled. |
<service-ref>
<service-ref-name>service/FooProxy</service-ref-name>
<port-info>
<service-endpoint-interface>a.FooPort</service-endpoint-interface>
<wsdl-port>
<namespaceURI>urn:Foo</namespaceURI>
<localpart>FooPort</localpart>
</wsdl-port>
<stub-property>
<name>javax.xml.rpc.service.endpoint.address</name>
<value>http://localhost:8080/a/Foo</value>
</stub-property>
</port-info>
</service-ref>sun-cmp-mappingSpecifies beans mapped to a particular database schema.
|
Note
|
A bean cannot be related to a bean that maps to a different database schema, even if the beans are deployed in the same EJB JAR file. |
The following table describes subelements for the sun-cmp-mapping
element.
Table C-151 sun-cmp-mapping Subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the file that contains a description of the database schema. |
|
one or more |
Specifies the mapping of a bean to database columns. |
sun-cmp-mappingsDefines the GlassFish Server specific CMP mapping configuration for an
EJB JAR file. This is the root element; there can only be one
sun-cmp-mappings element in a sun-cmp-mappings.xml file. See
The sun-cmp-mappings.xml File.
The following table describes subelements for the sun-cmp-mappings
element.
Table C-152 sun-cmp-mappings Subelements
| Element | Required | Description |
|---|---|---|
one or more |
Specifies beans mapped to a particular database schema. |
table-nameSpecifies the name of a database table. The table must be present in the database schema file. See "Automatic Database Schema Capture" in GlassFish Server Open Source Edition Application Development Guide.
target-serverSpecifies the IIOP listener for the target server. Also specifies IIOP endpoints used for load balancing. If the GlassFish Server instance on which the application client is deployed participates in a cluster, GlassFish Server finds all currently active IIOP endpoints in the cluster automatically. However, a client should have at least two endpoints specified for bootstrapping purposes, in case one of the endpoints has failed.
A listener or endpoint is in the form host`:`port, where the host is an IP address or host name, and the port specifies the port number.
Not used if the deprecated endpoints property is defined for load
balancing. For more information, see client-container.
The following table describes subelements for the target-server
element.
Table C-153 target-server subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Specifies the description of the target server. |
|
zero or one |
Specifies the security configuration for the IIOP/SSL communication with the target server. |
The following table describes attributes for the target-server
element.
Table C-154 target-server attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the name of the server instance accessed by the client container. |
|
none |
Specifies the host name or IP address (resolvable by DNS) of the server to which this client attaches. |
|
none |
Specifies the naming service port number of the server to which this client attaches. For a new server instance, assign a port number other than 3700. You can change the port number in the Administration Console. Click the Help button in the Administration Console for more information. |
tie-classSpecifies the automatically generated name of a tie implementation class for a port component.
timeoutSpecifies the cache-mapping specific maximum amount of
time in seconds that an entry can remain in the cache after it is
created or refreshed. If not specified, the default is the value of the
timeout attribute of the cache element.
The following table describes attributes for the timeout element.
Table C-155 timeout Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies the timeout input parameter, whose value is
interpreted in seconds. The field’s type must be |
|
|
(optional) Specifies the scope from which
the input parameter is retrieved. Allowed values are
|
transport-configSpecifies the security transport information.
The following table describes subelements for the transport-config
element.
Table C-156 transport-config Subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies if the target supports integrity-protected messages. The values are NONE, SUPPORTED, or REQUIRED. |
|
only one |
Specifies if the target supports privacy-protected messages. The values are NONE, SUPPORTED, or REQUIRED. |
|
only one |
Specifies if the target is capable of authenticating to a client. The values are NONE, SUPPORTED, or REQUIRED. |
|
only one |
Specifies if the target is capable of authenticating a client. The values are NONE, SUPPORTED, or REQUIRED. |
transport-guaranteeSpecifies that the communication between client and server is NONE,
INTEGRAL, or CONFIDENTIAL.
NONE means the application does not require any transport
guarantees.
INTEGRAL means the application requires that the data sent between
client and server be sent in such a way that it can’t be changed in
transit.
CONFIDENTIAL means the application requires that the data be
transmitted in a fashion that prevents other entities from observing the
contents of the transmission.
In most cases, a value of INTEGRAL or CONFIDENTIAL indicates that
the use of SSL is required.
unique-idContains the unique ID for the application. This value is automatically updated each time the application is deployed or redeployed. Do not edit this value.
glassfish-application (glassfish-application.xml),
enterprise-beans (glassfish-ejb-jar.xml)
url-patternSpecifies a servlet URL pattern for which caching is enabled. See the Servlet 2.4 specification section SRV. 11.2 for applicable patterns.
user-groupContains the group to which the principal belongs.
use-thread-pool-idSpecifies the thread pool from which threads are selected for remote invocations of this bean.
valueSpecifies the value of the entity.
call-property, stub-property
(glassfish-web.xml, glassfish-ejb-jar.xml,
glassfish-application-client.xml); property (with
subelements) (glassfish-ejb-jar.xml)
valveSpecifies a custom valve for this web application. You can define a
valve for all the web applications on a specific virtual server. For
details, see create-virtual-server(1).
The following table describes subelements for the valve element.
Table C-157 valve Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Specifies a text description of this element. |
|
zero or more |
Specifies a property, which has a name and a value. |
The following table describes attributes for the valve element.
Table C-158 valve Attributes
| Attribute | Default | Description |
|---|---|---|
|
none |
Specifies a unique name for the valve. |
|
none |
Specifies the fully qualified class name of the valve. The valve class must implement the org.apache.catalina.Valve interface from Tomcat or previous GlassFish Server releases, or the org.glassfish.web.valve.GlassFishValve interface from the current GlassFish Server release. |
vendorSpecifies a vendor-specific icon, splash screen, text string, or a combination of these for Java Web Start download and launch screens. The complete format of this element’s data is as follows:
<vendor>icon-image-URI::splash-screen-image-URI::vendor-text</vendor>The following example vendor element contains an icon, a splash screen, and a text string:
<vendor>images/icon.jpg::otherDir/splash.jpg::MyCorp, Inc.</vendor>The following example vendor element contains an icon and a text string:
<vendor>images/icon.jpg::MyCorp, Inc.</vendor>The following example vendor element contains a splash screen and a text string; note the initial double colon:
<vendor>::otherDir/splash.jpg::MyCorp, Inc.</vendor>The following example vendor element contains only a text string:
<vendor>MyCorp, Inc.</vendor>The default value is the text string Application Client.
version-identifierContains version information for an application or module. For more information about application versioning, see Module and Application Versions.
glassfish-application (glassfish-application.xml),
glassfish-web-app (glassfish-web-app.xml),
glassfish-ejb-jar (glassfish-ejb-jar.xml),
glassfish-application-client
(glassfish-application-client.xml)
victim-selection-policySpecifies how stateful session beans are selected for passivation.
Possible values are First In, First Out (FIFO), Least Recently Used
(LRU), Not Recently Used (NRU). The default value is NRU, which is
actually pseudo-LRU.
|
Note
|
You cannot plug in your own victim selection algorithm. |
The victims are generally passivated into a backup store (typically a
file system or database). This store is cleaned during startup, and also
by a periodic background process that removes idle entries as specified
by removal-timeout-in-seconds. The backup store is monitored by a
background thread (or sweeper thread) to remove unwanted entries.
Applies to stateful session beans.
<victim-selection-policy>LRU</victim-selection-policy>If both SSL2 and SSL3 are enabled, the server tries SSL3 encryption first. If that fails, the server tries SSL2 encryption. If both SSL2 and SSL3 are enabled for a virtual server, the server tries SSL3 encryption first. If that fails, the server tries SSL2 encryption.
webSpecifies the application’s web tier configuration.
The following table describes subelements for the web element.
Table C-159 web Subelements
| Element | Required | Description |
|---|---|---|
only one |
Contains the web URI for the application. |
|
only one |
Contains the web context root for the web module. |
web-uriContains the web URI for the application. Must match the corresponding
element in the application.xml file.
webservice-descriptionSpecifies a name and optional publish location for a web service.
The following table describes subelements for the
webservice-description element.
Table C-160 webservice-description subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies a unique name for the web service within a web or EJB module. |
|
zero or one |
Specifies the URL of a directory to which a web service’s WSDL is published during deployment. |
webservice-description-nameSpecifies a unique name for the web service within a web or EJB module.
webservice-endpointSpecifies information about a web service endpoint.
The following table describes subelements for the webservice-endpoint
element.
Table C-161 webservice-endpoint subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies a unique name for a port component within a web or EJB module. |
|
zero or one |
Specifies the automatically generated endpoint address. |
|
zero or one |
Specifies the authentication configuration for an EJB web service endpoint. |
|
zero or one |
Specifies a custom authentication provider binding. |
|
zero or one |
Specifies that the communication between client and
server is |
|
zero or one |
Specifies the WSDL service element that is being referenced. |
|
zero or one |
Specifies the automatically generated name of a tie implementation class for a port component. |
|
zero or one |
Specifies the automatically generated name of the generated servlet implementation class. |
|
zero or one |
Specifies whether the debugging servlet is enabled for
this web service endpoint. Allowed values are |
|
|
zero or more |
Specifies a property, which has a name and a value. |
work-security-mapDefines a work security map, which maps a principal associated with an incoming work instance to a principal in the GlassFish Server’s security domain. It is possible to map multiple EIS group or user principals to the same GlassFish 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.
The following table describes subelements for the work-security-map
element.
Table C-162 work-security-map Subelements
| Element | Required | Description |
|---|---|---|
zero or one |
Contains a text description of this element. |
|
zero or more |
Maps an EIS principal to a principal defined in the GlassFish Server domain. |
|
zero or more |
Maps an EIS group to a group defined in the GlassFish Server domain. |
wsdl-overrideSpecifies a valid URL pointing to a final WSDL document. If not
specified, the WSDL document associated with the service-ref in the
standard Java EE deployment descriptor is used.
service-ref (glassfish-web.xml,
glassfish-ejb-jar.xml, glassfish-application-client.xml)
wsdl-portSpecifies the WSDL port.
port-info (glassfish-web.xml, glassfish-ejb-jar.xml,
glassfish-application-client.xml)
The following table describes subelements for the wsdl-port element.
Table C-164 wsdl-port subelements
| Element | Required | Description |
|---|---|---|
only one |
Specifies the namespace URI. |
|
only one |
Specifies the local part of a QNAME. |
wsdl-publish-locationSpecifies the URL of a directory to which a web service’s WSDL is
published during deployment. Any required files are published to this
directory, preserving their location relative to the module-specific
WSDL directory (META-INF/wsdl or WEB-INF/wsdl).
Suppose you have an ejb.jar file whose webservices.xml file’s
wsdl-file element contains the following reference:
META-INF/wsdl/a/Foo.wsdlSuppose your glassfish-ejb.jar file contains the following element:
<wsdl-publish-location>file:/home/user1/publish</wsdl-publish-location>The final WSDL is stored in /home/user1/publish/a/Foo.wsdl.
| Previous | Contents |
Copyright © 2019, Oracle and/or its affiliates. All rights reserved.