Sun GlassFish Enterprise Server v3 Prelude Administration Reference

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.

Note –

For GlassFish v3 Prelude, EJB modules are not supported unless the optional EJB container add-on component is downloaded from the Update Tool. Only stateless session beans with local interfaces and entity beans that use the Java Persistence API are supported. Stateful, message-driven, and EJB 2.0 and 2.1 entity beans are not supported. Remote interfaces and remote business interfaces for any of the bean types are not supported.

Superelements

config

Subelements

The following table describes subelements for the ejb-container element.

Table 1–21 ejb-container Subelements


Element	Required	Description
ejb-timer-service	zero or one	Configures the EJB timer service.
property	zero or more	Specifies a property or a variable.

Attributes

The following table describes attributes for the ejb-container element.

Table 1–22 ejb-container Attributes


Attribute	Default	Description
`steady-pool-size`	`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.
`pool-resize-quantity`	`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.
`max-pool-size`	`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.
`cache-resize-quantity`	`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 entity beans.
`max-cache-size`	`512`	(optional) Specifies the maximum number of beans in the cache. A value of `0` indicates an unbounded cache. Applies to 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 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. Note – This attribute is not implemented for GlassFish v3 Prelude.
`victim-selection-policy`	`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. Note – This attribute is not implemented for GlassFish v3 Prelude.
`commit-option`	`B`	(optional) Determines which commit option is used for entity beans. Legal values are `B` or `C`. Note – This attribute is not implemented for GlassFish v3 Prelude.
`session-store`	`domain-dir/session-store`	(optional) Specifies the directory where passivated stateful session beans and persisted HTTP sessions are stored in the file system. Note – This attribute is not implemented for GlassFish v3 Prelude.

ejb-timer-service

Configures the EJB timer service.

Superelements

ejb-container

Subelements

The following table describes subelements for the ejb-timer-service element.

Table 1–23 ejb-timer-service Subelements


Element	Required	Description
property	zero or more	Specifies a property or a variable.

Attributes

The following table describes attributes for the ejb-timer-service element.

Table 1–24 ejb-timer-service Attributes


Attribute	Default	Description
`minimum-delivery-interval-in-millis`	`7000`	(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.
`max-redeliveries`	`1`	(optional) Specifies the maximum number of times the EJB timer service attempts to redeliver a timer expiration due for exception or rollback.
`timer-datasource`	`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` ). Note – This attribute is not implemented for GlassFish v3 Prelude.
`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. 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.

Note –

Web services are not supported unless the optional Metro (JSR 109) add-on component is downloaded from the Update Tool. Without the Metro component, a servlet or EJB module cannot be a web service endpoint.

JRuby applications are not supported unless the optional JRuby add-on component is downloaded from the Update Tool.

For information about the Update Tool, see the Sun GlassFish Enterprise Server v3 Prelude Installation Guide.

Superelements

application

Subelements

The following table describes subelements for the engine element.

Table 1–25 engine Subelements


Element	Required	Description
property	zero or more	Specifies a property or a variable.

Attributes

The following table describes attributes for the engine element.

Table 1–26 engine Attributes


Attribute	Default	Description
`sniffer`	none	Specifies the type of sniffer. Allowed values are as follows: `web` — Specifies that the parent application is a web application. `security` — Specifies that security is enabled for the parent application. `jpa` — Specifies that the parent application uses the Java Persistence API. `ejb` — Specifies that the parent application includes an EJB module. The EJB container add-on component must be installed in the Enterprise Server. `webservices` — Specifies that the parent application is a web service endpoint. The Metro add-on component must be installed in the Enterprise Server. `jruby` — Specifies that the parent application is a JRuby application. The JRuby add-on component must be installed in the Enterprise Server.