E
ejb-container
Configures the EJB container. Stateless session beans are maintained in pools. Stateful session
beans have session affinity and are cached. Entity beans associated with a database
primary key are also cached. Entity beans not yet associated with a primary
key are maintained in pools. Pooled entity beans are used to run
ejbCreate() and finder methods.
Superelements
config
Subelements
The following table describes subelements for the ejb-container element.
ejb-container Subelements
|
|
|
|---|
|
zero or one |
Configures the
EJB timer service. |
|
zero or more |
Specifies a property or a variable. |
|
Attributes
The following table describes attributes for the ejb-container element.
ejb-container Attributes
|
|
|
|---|
|
32 |
(optional) Specifies the
initial and minimum number of beans maintained in the pool. Must be 0
or greater and less than max-pool-size . Bean instances are removed from the pool
and returned after use. The pool is replenished or cleaned up periodically to
maintain this size. Applies to stateless session beans and entity beans. |
|
16 |
(optional) Specifies the
number of beans to be removed when the pool-idle-timeout-in-seconds timer expires. A
cleaner thread removes any unused instances. Must be 0 or greater and less
than max-pool-size . The pool is not resized below the steady-pool-size. Applies to
stateless session beans and entity beans. |
|
64 |
(optional) Specifies the maximum number of beans
that can be created to satisfy client requests. A value of 0 indicates an
unbounded pool. Applies to stateless session beans and entity beans. |
|
32 |
(optional) Specifies the
number of beans to be:
created if a request arrives when the pool has no available beans (subject to the max-cache-size limit) passivated when the cache-idle-timeout-in-seconds timer expires and a cleaner thread removes any unused instances, or when the cache size exceeds max-cache-size. Must be greater than 1 and less than max-cache-size. Applies to stateful session beans and entity beans.
|
|
512 |
(optional) Specifies the maximum number of beans
in the cache. A value of 0 indicates an unbounded cache. Applies to
stateful session beans and entity beans. |
pool-idle-timeout-in-seconds |
600 |
(optional) Specifies the maximum time that
a bean can remain idle in the pool. After this amount of time,
the pool can remove this bean. A value of 0 specifies that idle
beans can remain in the pool indefinitely. Applies to stateless session beans and entity
beans. |
cache-idle-timeout-in-seconds |
600 |
(optional) Specifies 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. Applies
to stateful session beans and entity beans. |
removal-timeout-in-seconds |
5400 |
(optional) Specifies the amount of
time that a bean can remain passivated before it is removed from the
session store. A value of 0 specifies that the container does not
remove inactive beans automatically. If removal-timeout-in-seconds is less than or equal to cache-idle-timeout-in-seconds, beans
are removed immediately without being passivated. The session-store attribute of the server
element determines the location of the session store. Applies to stateful session beans. |
|
nru |
(optional)
Specifies how stateful session beans are selected for passivation. Allowed values are fifo,
lru, and nru :
fifo - Selects the oldest instance. lru - Selects the least recently accessed instance. nru - Selects a not recently used instance.
|
|
B |
(optional) Determines which commit option is used for entity beans.
Legal values are B or C. |
|
domain-dir/session-store |
(optional) Specifies the directory where passivated stateful session
beans and persisted HTTP sessions are stored in the file system. |
|
ejb-module
This element is deprecated. Use an application element instead.
Specifies a deployed EJB module.
Superelements
applications
Subelements
The following table describes subelements for the ejb-module element.
ejb-module Subelements
|
|
|
|---|
|
zero or one |
Contains a
text description of this element. |
|
zero or more |
Configures a web service endpoint. |
|
zero or
more |
Specifies a property or a variable. |
|
Attributes
The following table describes attributes for the ejb-module element.
ejb-module Attributes
|
|
|
|---|
|
none |
The name of the
EJB module. |
|
none |
A fully qualified or relative path to the directory to which the
contents of the EJB .jar file have been extracted. If relative, it is relative
to the following directory: domain-dir/applications/ |
|
user |
(optional) Defines the type of the resource. For an
EJB module, the only allowed value is user. |
enabled |
true |
(optional) Determines whether the EJB module
is enabled. |
|
none |
(optional) Specifies an absolute or relative path to libraries specific to this
module or application. A relative path is relative to domain-dir/lib/applibs. If the path
is absolute, the path must be accessible to the domain administration server (DAS), which
means it must be under domain-dir. To include more than one path, use
a system-specific separator, such as a colon for Solaris or a semicolon for
Windows. The libraries are made available to the application in the order in
which they are specified. |
|
false |
(optional) Specifies whether the application has been deployed as
a directory. |
|
ejb-timer-service
Configures the EJB timer service.
Superelements
ejb-container
Subelements
The following table describes subelements for the ejb-timer-service element.
ejb-timer-service Subelements
|
|
|
|---|
|
zero or more |
Specifies
a property or a variable. |
|
Attributes
The following table describes attributes for the ejb-timer-service element.
ejb-timer-service Attributes
|
|
|
|---|
minimum-delivery-interval-in-millis |
1000 |
(optional) Specifies the
minimum time before an expiration for a particular timer can occur. This guards
against extremely small timer increments that can overload the server. |
|
1 |
(optional) Specifies the
maximum number of times the EJB timer service attempts to redeliver a timer
expiration due for exception or rollback. |
|
jdbc/__TimerPool |
(optional) Overrides, for the server instance, the cmp-resource
value specified in sun-ejb-jar.xml for the timer service system application (__ejb_container_timer_app ). |
redelivery-interval-internal-in-millis |
5000 |
(optional)
Specifies how long the EJB timer service waits after a failed ejbTimeout
delivery before attempting a redelivery. |
|
engine
Specifies an engine for an application or module. An engine runs a
sniffer during deployment, which is responsible for identifying a type of deployment artifact (such
as a WAR file) and setting up the associated container (such as the
web container). Multiple engines, each with its own sniffer, can be associated with
a given application or module.
Superelements
application, module
Subelements
The following table describes subelements for the engine element.
engine Subelements
|
|
|
|---|
|
zero or one |
Configures the parent web
module. Applicable only if this engine element has a sniffer value of web. |
|
zero
or more |
Specifies a property or a variable. |
|
Attributes
The following table describes attributes for the engine element.
engine Attributes
|
|
|
|---|
|
none |
Specifies the type of
sniffer. Allowed values include the following:
web — Specifies that the parent module is a web application. security — Specifies that security is enabled for the parent module. jpa — Specifies that the parent module uses the Java Persistence API. connector — Specifies that the parent module is a connector. ejb — Specifies that the parent module is an EJB module. The EJB container add-on component must be installed in the Enterprise Server. webservices — Specifies that the parent module is a web service endpoint. The Metro add-on component must be installed in the Enterprise Server. appclient — Specifies that the parent module is an application client. This value is valid only in the full platform distribution of the Enterprise Server. ear — Specifies that the parent application is a Java EE application (EAR file). This value is valid only in the full platform distribution of the Enterprise Server. webbeans — Specifies that the parent module is a Web Bean. The Web Beans add-on component must be installed in the Enterprise Server. jruby — Specifies that the parent module is a JRuby application. The JRuby add-on component must be installed in the Enterprise Server. osgi — Specifies that the parent module is an OSGi add-on component. grizzly — Specifies that the parent module is a Grizzly add-on component.
|
description |
none |
(optional) Specifies a text description for this element. |
|
env-entry
Configures an environment entry for a web module at deployment time. This is
an alternative to setting an env-entry in the web.xml file. To override an
env-entry in the web.xml file, set the ignore-descriptor-item attribute to true.
Superelements
web-module-config
Subelements
The following table describes subelements for the env-entry element.
env-entry Subelements
|
|
|
|---|
|
only one |
Contains an environment
entry name. |
|
only one |
Contains an environment entry type. |
|
only one |
Contains an environment entry value. |
|
zero
or one |
Contains a text description of this element. |
|
Attributes
The following table describes attributes for the env-entry element.
env-entry Attributes
|
|
|
|---|
|
false |
(optional) If
true, specifies that if the same environment entry occurs in the deployment descriptor
it is ignored. |
|
env-entry-name
Contains an environment entry name.
Superelements
env-entry
Subelements
none - contains data
env-entry-type
Contains an environment entry type.
Superelements
env-entry
Subelements
none - contains data
env-entry-value
Contains an environment entry value.
Superelements
env-entry
Subelements
none - contains data
extension-module
This element is deprecated. Use an application element instead.
Specifies a deployed extension module.
Superelements
applications
Subelements
The following table describes subelements for the extension-module element.
extension-module Subelements
|
|
|
|---|
|
zero or one |
Contains a
text description of this element. |
|
zero or more |
Specifies a property or a variable. |
|
Attributes
The following table describes attributes for the extension-module element.
extension-module Attributes
|
|
|
|---|
|
none |
The name of the
extension module. |
|
none |
A fully qualified or relative path to the directory to which the
contents of the .jar or .war file have been extracted. If relative, it is
relative to the following directory: domain-dir/applications/ |
|
none |
Specifies a String that identifies the extension module type,
which the runtime uses to find the appropriate add-on container. When an extension
module is registered with the Enterprise Server, the Enterprise Server specifies the module
type automatically. |
|
user |
(optional) Defines the type of the resource. For an extension module, the
only allowed value is user. |
enabled |
true |
(optional) Determines whether the extension module is enabled. |
|
none |
(optional)
Specifies an absolute or relative path to libraries specific to this module or
application. A relative path is relative to domain-dir/lib/applibs. If the path is absolute, the
path must be accessible to the domain administration server (DAS), which means it
must be under domain-dir. To include more than one path, use a system-specific
separator, such as a colon for Solaris or a semicolon for Windows. The
libraries are made available to the application in the order in which they
are specified. |
|
false |
(optional) Specifies whether the application has been deployed as a directory. |
|
external-jndi-resource
Defines 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.
Superelements
resources
Subelements
The following table describes subelements for the external-jndi-resource element.
external-jndi-resource Subelements
|
|
|
|---|
|
zero or one |
Contains
a text description of this element. |
|
zero or more |
Specifies a property or a
variable. |
|
Attributes
The following table describes attributes for the external-jndi-resource element.
external-jndi-resource Attributes
|
|
|
|---|
|
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 |
|
|
user |
(optional) Defines the type of the resource. Allowed values are:
system-all - A system resource for all server instances and the domain application server. system-admin - A system resource only for the domain application server. system-instance - A system resource for all server instances only. user - A user resource.
|
enabled |
true |
(optional) Determines whether this
resource is enabled at runtime. |
|
