C Elements of the GlassFish Server Deployment Descriptors

description

zero or one

Specifies a text description of the activation configuration.

activation-config-property

one or more

Specifies an activation configuration property.

activation-config-property-name

only one

Specifies the name of an activation configuration property.

activation-config-property-value

only one

Specifies the value of an activation configuration property.

description

zero or one

Contains a text description of this element.

property (with attributes)

zero or more

Specifies a property or a variable.

jndi-name

none

Specifies the JNDI name for the resource.

res-type

none

Specifies the fully qualified type of the resource.

res-adapter

none

Specifies the name of the inbound resource adapter.

object-type

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.

auth-method

only one

Specifies the authentication method. The only supported value is USERNAME_PASSWORD.

realm

only one

Specifies the realm in which the user is authenticated.

required

only one

Specifies whether the authentication method specified in the auth-method element must be used for client authentication.

property (with attributes)

zero or more

Specifies a property, which has a name and a value.

name

none

Defines the name of this realm.

classname

none

Defines the Java class which implements this realm.

user-name

none

Specifies the user name required by the EIS.

password

none

(optional) Specifies the password required by the EIS, if any.

max-cache-size

zero or one

Specifies the maximum number of beans allowable in cache.

is-cache-overflow-allowed

zero or one

Deprecated.

cache-idle-timeout-in-seconds

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).

removal-timeout-in-seconds

zero or one

Specifies the amount of time a bean remains before being removed. If removal-timeout-in-seconds is less than idle-timeout, the bean is removed without being passivated.

resize-quantity

zero or one

Specifies the number of beans to be created if the pool is empty (subject to the max-pool-size limit). Values are from 0 to MAX_INTEGER.

victim-selection-policy

zero or one

Specifies the algorithm that must be used by the container to pick victims. Applies only to stateful session beans.

steady-pool-size

zero or one

Specifies the initial and minimum number of beans maintained in the pool. Default is 32.

resize-quantity

zero or one

Specifies the number of beans to be created if the pool is empty (subject to the max-pool-size limit). Values are from 0 to MAX_INTEGER.

max-pool-size

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.

max-wait-time-in-millis

zero or one

Deprecated.

pool-idle-timeout-in-seconds

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).

cache-helper

zero or more

Specifies a custom class that implements the CacheHelper interface.

default-helper

zero or one

Allows you to change the properties of the default, built-in cache-helper class.

property (with attributes)

zero or more

Specifies a cache property, which has a name and a value.

cache-mapping

zero or more

Maps a URL pattern or a servlet name to its cacheability constraints.

max-entries

4096

(optional) Specifies the maximum number of entries the cache can contain. Must be a positive integer.

timeout-in-seconds

30

(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 timeout element.

enabled

true

(optional) Determines whether servlet and JSP caching is enabled.

cacheClassName

com.sun.appserv.web.cache.LruCache

Specifies the fully qualified name of the class that implements the cache functionality. See Cache Class Names for possible values.

MultiLRUSegmentSize

4096

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 cacheClassName is set to com.sun.appserv.web.cache.MultiLruCache.

MaxSize

unlimited; Long.MAX_VALUE

Specifies an upper bound on the cache memory size in bytes (KB or MB units). Example values are 32 KB or 2 MB. Applicable only if cacheClassName is set to com.sun.appserv.web.cache.BoundedMultiLruCache.

com.sun.appserv.web.cache.LruCache

A bounded cache with an LRU (least recently used) cache replacement policy.

com.sun.appserv.web.cache.BaseCache

An unbounded cache suitable if the maximum number of entries is known.

com.sun.appserv.web.cache.MultiLruCache

A cache suitable for a large number of entries (>4096). Uses the MultiLRUSegmentSize property.

com.sun.appserv.web.cache.BoundedMultiLruCache

A cache suitable for limiting the cache size by memory rather than number of entries. Uses the MaxSize property.

property (with attributes)

zero or more

Specifies a property, which has a name and a value.

name

default

Specifies a unique name for the helper class, which is referenced in the cache-mapping element.

class-name

none

Specifies the fully qualified class name of the cache helper, which must implement the com.sun.appserv.web.CacheHelper interface.

servlet-name

requires one servlet-name or url-pattern

Contains the name of a servlet.

url-pattern

requires one servlet-name or url-pattern

Contains a servlet URL pattern for which caching is enabled.

cache-helper-ref

required if dispatcher, timeout, refresh-field, http-method, key-field, and constraint-field are not used

Contains the name of the cache-helper used by the parent cache-mapping element.

dispatcher

zero or one if cache-helper-ref is not used

Contains a comma-separated list of RequestDispatcher methods for which caching is enabled.

timeout

zero or one if cache-helper-ref is not used

Contains the cache-mapping specific maximum amount of time in seconds that an entry can remain in the cache after it is created or refreshed.

refresh-field

zero or one if cache-helper-ref is not used

Specifies a field that gives the application component a programmatic way to refresh a cached entry.

http-method

zero or more if cache-helper-ref is not used

Contains an HTTP method that is eligible for caching.

key-field

zero or more if cache-helper-ref is not used

Specifies a component of the key used to look up and extract cache entries.

constraint-field

zero or more if cache-helper-ref is not used

Specifies a cacheability constraint for the given url-pattern or servlet-name.

name

only one

Specifies the name of the entity.

value

only one

Specifies the value of the entity.

path

none

Specifies the absolute path of the certificate database.

password

none

Specifies the password to access the certificate database.

column-name

only one

Specifies the name of the version column.

method

one or more

Specifies a bean method.

property (with attributes)

zero or more

Specifies a property, which has a name and a value.

extra-class-path

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:

extra-class-path="WEB-INF/lib/extra/extra.jar"

delegate

true

(optional) If true, the web module follows the standard class loader delegation model and delegates to its parent class loader first before looking in the local class loader. You must set this to true for a web module that accesses EJB components or that acts as a web service client or endpoint.

If false, the web module follows the delegation model specified in the Servlet specification and looks in its class loader before looking in the parent class loader. It's safe to set this to false only for a web module that does not interact with any other modules.

For a number of packages, including java.* and javax.*, symbol resolution is always delegated to the parent class loader regardless of the delegate setting. This prevents applications from overriding core Java runtime classes or changing the API versions of specifications that are part of the Java EE platform.

dynamic-reload-interval

(optional) Not implemented. Included for backward compatibility with previous Oracle Web Server versions.

ignoreHiddenJarFiles

false

If true, specifies that all JAR and ZIP files in the WEB-INF/lib directory that start with a period (.) are ignored by the class loader.

target-server

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.

auth-realm

zero or one

Specifies the optional configuration for JAAS authentication realm.

client-credential

zero or one

Specifies the default client credential that is sent to the server.

log-service

zero or one

Specifies the default log file and the severity level of the message.

message-security-config

zero or more

Specifies configurations for message security providers.

property (with attributes)

zero or more

Specifies a property, which has a name and a value.

send-password

true

If true, specifies that client authentication credentials must be sent to the server. Without authentication credentials, all access to protected EJB components results in exceptions.

com.sun.appserv.iiop.endpoints

none

Specifies a comma-separated list of one or more IIOP endpoints used for load balancing. An IIOP endpoint is in the form host:port, where the host is an IP address or host name, and the port specifies the port number. Deprecated. Use target-server elements instead.

property (with attributes)

zero or more

Specifies a property, which has a name and a value.

user-name

none

The user name used to authenticate the Application client container.

password

none

The password used to authenticate the Application client container.

realm

default realm for the domain

(optional) The realm (specified by name) where credentials are to be resolved.

mapping-properties

zero or one

This element is not implemented.

is-one-one-cmp

zero or one

This element is not implemented.

one-one-finders

zero or one

Describes the finders for CMP 1.1 beans.

prefetch-disabled

zero or one

Disables prefetching of entity bean states for the specified query methods.

field-name

only one

Specifies the Java identifier of a field. This identifier must match the value of the field-name subelement of the cmp-field that is being mapped.

column-name

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.

read-only

zero or one

Specifies that a field is read-only.

fetched-with

zero or one

Specifies the fetch group for this CMP field's mapping.

jndi-name

only one

Specifies the absolute jndi-name of a JDBC resource.

default-resource-principal

zero or one

Specifies the default runtime bindings of a resource reference.

property (with subelements)

zero or more

Specifies a property name and value. Used to configure PersistenceManagerFactory properties.

create-tables-at-deploy

zero or one

If true, specifies that database tables are created for beans that are automatically mapped by the EJB container.

drop-tables-at-undeploy

zero or one

If true, specifies that database tables that were automatically created when the bean(s) were last deployed are dropped when the bean(s) are undeployed.

database-vendor-name

zero or one

Specifies the name of the database vendor for which tables can be created.

schema-generator-properties

zero or one

Specifies field-specific type mappings and allows you to set the use-unique-table-names property.

cmr-field-name

only one

Specifies the Java identifier of a field. Must match the value of the cmr-field-name subelement of the cmr-field that is being mapped.

column-pair

one or more

Specifies the pair of columns that determine the relationship between two database tables.

fetched-with

zero or one

Specifies the fetch group for this CMR field's relationship.

column-name

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.

description

zero or one

Contains a text description of this element.

security-map

zero or more

Maps the principal received during servlet or EJB authentication to the credentials accepted by the EIS.

property (with attributes)

zero or more

Specifies a property or a variable.

name

none

Specifies the name of the connection pool. A connector-resource element's pool-name attribute refers to this name.

resource-adapter-name

none

Specifies the name of the deployed connector module or application. If no name is specified during deployment, the name of the .rar file is used. If the resource adapter is embedded in an application, then it is app_name#rar_name.

connection-definition-name

none

Specifies a unique name, identifying a resource adapter's connection-definition element in the ra.xml file. This is usually the connectionfactory-interface of the connection-definition element.

steady-pool-size

8

(optional) Specifies the initial and minimum number of connections maintained in the pool.

max-pool-size

32

(optional) Specifies the maximum number of connections that can be created to satisfy client requests.

max-wait-time-in-millis

60000

(optional) Specifies the amount of time, in milliseconds, that the caller is willing to wait for a connection. If 0, the caller is blocked indefinitely until a resource is available or an error occurs.

pool-resize-quantity

2

(optional) Specifies the number of idle connections to be destroyed if the existing number of connections is above the steady-pool-size (subject to the max-pool-size limit).

This is enforced periodically at the idle-timeout-in-seconds interval. An idle connection is one that has not been used for a period of idle-timeout-in-seconds. When the pool size reaches steady-pool-size, connection removal stops.

idle-timeout-in-seconds

300

(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.

fail-all-connections

false

(optional) If true, closes all connections in the pool if a single validation check fails.

transaction-support

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:

• XATransaction - Supports distributed transactions.

• LocalTransaction - Supports local transactions only.

• NoTransaction - No transaction support.

is-connection-validation-required

false

(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.

validate-atmost-once-period-in-seconds

0

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.

connection-leak-timeout-in-seconds

0

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.

connection-leak-reclaim

false

If true, the pool will reclaim a connection after connection-leak-timeout-in-seconds occurs.

connection-creation-retry-attempts

0

Specifies the number of attempts to create a new connection.

connection-creation-retry-interval-in-seconds

10

Specifies the time interval between attempts to create a connection when connection-creation-retry-attempts is greater than 0.

lazy-connection-enlistment

false

If true, a connection is not enlisted in a transaction until it is used. If false, any connection object available to a transaction is enlisted in the transaction.

lazy-connection-association

false

If true, a physical connection is not associated with a logical connection until it is used. If false, a physical connection is associated with a logical connection even before it is used.

associate-with-thread

false

If true, allows connections to be saved as ThreadLocal in the calling thread. Connections get reclaimed only when the calling thread dies or when the calling thread is not in use and the pool has run out of connections. If false, the thread must obtain a connection from the pool each time the thread requires a connection.

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 true, you should verify that the value of the max-pool-size attribute is comparable to the max-thread-pool-size attribute of the associated thread pool. If the max-thread-pool-size value is much higher than the max-pool-size value, a lot of time is spent associating connections with a new thread after dissociating them from an older one. Use this attribute in cases where the thread pool should reuse connections to avoid this overhead.

match-connections

true

If true, enables connection matching. You can set to false if connections are homogeneous.

max-connection-usage-count

0

Specifies the number of times a connections is reused by the pool, after which it is closed. A zero value disables this feature.

ping

false

(optional) Specifies whether to ping the pool during pool creation or reconfiguration to identify and warn of any erroneous attribute values.

pooling

true

(optional) If false, disables connection pooling.

AddressList

none

Specifies a list of host/port combinations of the Message Queue software. For JMS resources of the Type javax.jms.TopicConnectionFactory or javax.jms.QueueConnectionFactory.

ClientId

none

Specifies the JMS Client Identifier to be associated with a Connection created using the createTopicConnection method of the TopicConnectionFactory class. For JMS resources of the Type javax.jms.TopicConnectionFactory .

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.

UserName

guest

Specifies the user name for connecting to the Message Queue software. For JMS resources of the Type javax.jms.TopicConnectionFactory or javax.jms.QueueConnectionFactory.

Password

guest

Specifies the password for connecting to the Message Queue software. For JMS resources of the Type javax.jms.TopicConnectionFactory or javax.jms.QueueConnectionFactory.

ReconnectAttempts

6

Specifies the number of attempts to connect (or reconnect) for each address in the imqAddressList before the client runtime moves on to try the next address in the list. A value of -1 indicates that the number of reconnect attempts is unlimited (the client runtime attempts to connect to the first address until it succeeds).

ReconnectInterval

30000

Specifies the interval between reconnect attempts in milliseconds. This applies to attempts on each address in the imqAddressList and on successive addresses in the list. If too short, this time interval does not give a broker time to recover. If too long, the reconnect might represent an unacceptable delay.

ReconnectEnabled

false

If true, specifies that the client runtime attempts to reconnect to a message server (or the list of addresses in imqAddressList) when a connection is lost.

AddressListBehavior

priority

Specifies whether connection attempts are in the order of addresses in the imqAddressList attribute (priority) or in a random order (random). If many clients are attempting a connection using the same connection factory, use a random order to prevent them from all being connected to the same address.

AddressListIterations

-1

Specifies the number of times the client runtime iterates through the imqAddressList in an effort to establish (or reestablish) a connection. A value of -1 indicates that the number of attempts is unlimited.

description

zero or one

Contains a text description of this element.

property (with attributes)

zero or more

Specifies a property or a variable.

jndi-name

none

Specifies the JNDI name for the resource.

pool-name

none

Specifies the name of the associated connector-connection-pool.

object-type

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.

none

exactly one subelement is required

No consistency checking occurs.

check-modified-at-commit

exactly one subelement is required

Checks concurrent modification of fields in modified beans at commit time.

lock-when-loaded

exactly one subelement is required

Obtains an exclusive lock when the data is loaded.

check-all-at-commit

This element is not implemented. Do not use.

lock-when-modified

This element is not implemented. Do not use.

check-version-of-accessed-instances

exactly one subelement is required

Checks the version column of the modified beans.

constraint-field-value

zero or more

Contains a value to be matched to the input parameter value.

name

none

Specifies the input parameter name.

scope

request.parameter

(optional) Specifies the scope from which the input parameter is retrieved. Allowed values are context.attribute, request.header, request.parameter, request.cookie, request.attribute, and session.attribute.

cache-on-match

true

(optional) If true, caches the response if matching succeeds. Overrides the same attribute in a constraint-field-value subelement.

cache-on-match-failure

false

(optional) If true, caches the response if matching fails. Overrides the same attribute in a constraint-field-value subelement.

match-expr

equals

(optional) Specifies the type of comparison performed with the value. Allowed values are equals, not-equals, greater, lesser, and in-range.

If match-expr is greater or lesser, the value must be a number. If match-expr is in-range, the value must be of the form n1-n2, where n1 and n2 are numbers.

cache-on-match

true

(optional) If true, caches the response if matching succeeds.

cache-on-match-failure

false

(optional) If true, caches the response if matching fails.

property (with attributes)

zero or more

Specifies a property, which has a name and a value.

cookieName

none

Specifies the cookie name.

cookiePath

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 / (slash), the browser sends cookies to all URLs served by GlassFish Server. You can set the path to a narrower mapping to limit the request URLs to which the browser sends cookies.

cookieMaxAgeSeconds

none

Specifies the expiration time (in seconds) after which the browser expires the cookie. If this is unset, the cookie doesn't expire.

cookieDomain

(unset)

Specifies the domain for which the cookie is valid.

cookieComment

none

Specifies the comment that identifies the session tracking cookie in the cookie file.

cookieSecure

dynamic

Sets the Secure attribute of any JSESSIONID cookies associated with the web application. Allowed values are as follows:

• true — Sets Secure to true.

• false — Sets Secure to false.

• dynamic — The JSESSIONID cookie inherits the Secure setting of the request that initiated the session.

To set the Secure attribute of a JSESSIONIDSSO cookie, use the ssoCookieSecure virtual-server property. For details, see create-virtual-server(1).

cookieHttpOnly

none

Specifies that the cookie is marked HTTP only. Allowed values are true or false.

description

zero or one

Contains a text description of this element.

property (with attributes)

zero or more

Specifies a property or a variable.

jndi-name

none

Specifies the JNDI name for the resource.

res-type

none

Specifies the fully qualified type of the resource.

factory-class

none

Specifies the fully qualified name of the user-written factory class, which implements javax.naming.spi.ObjectFactory.

object-type

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.

property (with attributes)

zero or more

Specifies a property, which has a name and a value.

cacheKeyGeneratorAttrName

Uses the built-in default cache-helper key generation, which concatenates the servlet path with key-field values, if any.

The caching engine looks in the ServletContext for an attribute with a name equal to the value specified for this property to determine whether a customized CacheKeyGenerator implementation is used. An application can provide a customized key generator rather than using the default helper. See "The CacheKeyGenerator Interface" in Oracle GlassFish Server Application Development Guide.

name

only one

Specifies the default resource principal name used to sign on to a resource manager.

password

only one

Specifies password of the default resource principal.

ejb-name

only one

Matches the ejb-name in the corresponding ejb-jar.xml file.

jndi-name

zero or more

Specifies the absolute jndi-name.

ejb-ref

zero or more

Maps the absolute JNDI name to the ejb-ref element in the corresponding Java EE XML file.

resource-ref

zero or more

Maps the absolute JNDI name to the resource-ref in the corresponding Java EE XML file.

resource-env-ref

zero or more

Maps the absolute JNDI name to the resource-env-ref in the corresponding Java EE XML file.

service-ref

zero or more

Specifies runtime settings for a web service reference.

message-destination-ref

zero or more

Specifies the name of a physical message destination.

pass-by-reference

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.

cmp

zero or one

Specifies runtime information for a container-managed persistence (CMP) entity bean for EJB 1.1 and EJB 2.1 beans.

principal

zero or one

Specifies the principal (user) name in an enterprise bean that has the run-as role specified.

mdb-connection-factory

zero or one

Specifies the connection factory associated with a message-driven bean.

jms-durable-subscription-name

zero or one

Specifies the durable subscription associated with a message-driven bean.

jms-max-messages-load

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.

ior-security-config

zero or one

Specifies the security information for the IOR.

is-read-only-bean

zero or one

Specifies that this entity bean is read-only.

refresh-period-in-seconds

zero or one

Specifies the rate at which a read-only-bean must be refreshed from the data source.

commit-option

zero or one

Has valid values of B or C. Default value is B.

cmt-timeout-in-seconds

zero or one

Overrides the Transaction Timeout setting of the Transaction Service for an individual bean.

use-thread-pool-id

zero or one

Specifies the thread pool from which threads are selected for remote invocations of this bean.

gen-classes

zero or one

Specifies all the generated class names for a bean.

bean-pool

zero or one

Specifies the bean pool properties. Used for stateless session beans, entity beans, and message-driven beans.

bean-cache

zero or one

Specifies the bean cache properties. Used only for stateful session beans and entity beans.

mdb-resource-adapter

zero or one

Specifies runtime configuration information for a message-driven bean.

webservice-endpoint

zero or more

Specifies information about a web service endpoint.

flush-at-end-of-method

zero or one

Specifies the methods that force a database flush after execution. Used for entity beans.

checkpointed-methods

zero or one

Deprecated. Supported for backward compatibility. Use checkpoint-at-end-of-method instead.

checkpoint-at-end-of-method

zero or one

Specifies that the stateful session bean state is checkpointed, or persisted, after the specified methods are executed. The availability-enabled attribute must be set to true.

per-request-load-balancing

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.

availability-enabled

false

(optional) If set to true, and if availability is enabled in the EJB container, high-availability features apply to this bean if it is a stateful session bean.

ejb-ref-name

only one

Specifies the ejb-ref-name in the corresponding Java EE deployment descriptor file ejb-ref entry.

jndi-name

only one

Specifies the absolute jndi-name of a resource.

name

zero or one

Specifies the name string.

unique-id

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.

ejb

zero or more

Defines runtime properties for a single enterprise bean within the application.

pm-descriptors

zero or one

Deprecated.

cmp-resource

zero or one

Specifies the database to be used for storing container-managed persistence (CMP) beans in an EJB JAR file.

message-destination

zero or more

Specifies the name of a logical message destination.

webservice-description

zero or more

Specifies a name and optional publish location for a web service.

property (with subelements)

zero or more

Specifies a property or a variable.

ejb-name

only one

Specifies the name of the entity bean in the ejb-jar.xml file to which the CMP bean corresponds.

table-name

only one

Specifies the name of a database table. The table must be present in the database schema file.

cmp-field-mapping

one or more

Associates a field with one or more columns to which it maps.

cmr-field-mapping

zero or more

A container-managed relationship field has a name and one or more column pairs that define the relationship.

secondary-table

zero or more

Describes the relationship between a bean's primary and secondary table.

consistency

zero or one

Specifies container behavior in guaranteeing transactional consistency of the data in the bean.

description

zero or one

Contains a text description of this element.

property (with attributes)

zero or more

Specifies a property or a variable.

jndi-name

none

Specifies the JNDI name for the resource.

jndi-lookup-name

none

Specifies the JNDI lookup name for the resource.

res-type

none

Specifies the fully qualified type of the resource.

factory-class

none

Specifies the fully qualified name of the factory class, which implements javax.naming.spi.InitialContextFactory .

For more information about JNDI, see the Oracle GlassFish Server Application Development Guide.

object-type

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.

default

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.

level

exactly one subelement is required

Specifies the level number of a hierarchical fetch group.

named-group

exactly one subelement is required

Specifies the name of an independent fetch group.

none

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.

method-name

only one

Specifies the method name for the finder.

query-params

zero or one

Specifies the query parameters for the CMP 1.1 finder.

query-filter

zero or one

Specifies the query filter for the CMP 1.1 finder.

query-variables

zero or one

Specifies variables in query expression for the CMP 1.1 finder.

query-ordering

zero or one

Specifies the query ordering for the CMP 1.1 finder.

method

one or more

Specifies a bean method.

remote-impl

zero or one

Specifies the fully-qualified class name of the generated EJBObject impl class.

local-impl

zero or one

Specifies the fully-qualified class name of the generated EJBLocalObject impl class.

remote-home-impl

zero or one

Specifies the fully-qualified class name of the generated EJBHome impl class.

local-home-impl

zero or one

Specifies the fully-qualified class name of the generated EJBLocalHome impl class.

web

zero or more

Specifies the application's web tier configuration.

pass-by-reference

zero or one

Determines whether EJB modules use pass-by-value or pass-by-reference semantics.

unique-id

zero or one

Contains the unique ID for the application.

security-role-mapping

zero or more

Maps a role in the corresponding Java EE XML file to a user or group.

realm

zero or one

Specifies an authentication realm.

ejb-ref

zero or more

Maps the absolute JNDI name to the ejb-ref in the corresponding Java EE XML file.

resource-ref

zero or more

Maps the absolute JNDI name to the resource-ref in the corresponding Java EE XML file.

resource-env-ref

zero or more

Maps the absolute JNDI name to the resource-env-ref in the corresponding Java EE XML file.

service-ref

zero or more

Specifies runtime settings for a web service reference.

message-destination-ref

zero or more

Specifies the name of a physical message destination.

message-destination

zero or more

Specifies the name of a logical message destination.

archive-name

zero or one

Specifies the name of the archive file.

compatibility

zero or one

Specifies the GlassFish Server release with which to be backward compatible in terms of JAR visibility requirements for applications.

keep-state

zero or one

Retains web sessions, stateful session bean instances, and persistently created EJB timers across redeployments.

version-identifier

zero or one

Contains version information for an application.

ejb-ref

zero or more

Maps the absolute JNDI name to the ejb-ref in the corresponding Java EE XML file.

resource-ref

zero or more

Maps the absolute JNDI name to the resource-ref in the corresponding Java EE XML file.

resource-env-ref

zero or more

Maps the absolute JNDI name to the resource-env-ref in the corresponding Java EE XML file.

service-ref

zero or more

Specifies runtime settings for a web service reference.

message-destination-ref

zero or more

Specifies the name of a physical message destination.

message-destination

zero or more

Specifies the name of a logical message destination.

java-web-start-access

zero or one

Specifies changes to default Java Web Start parameters.

version-identifier

zero or one

Contains version information for an application client.

security-role-mapping

zero or more

Maps a role in the corresponding Java EE XML file to a user or group.

enterprise-beans

only one

Describes all the runtime properties for an EJB JAR file in the application.

compatibility

zero or one

Specifies the GlassFish Server release with which to be backward compatible in terms of JAR visibility requirements for applications.

disable-nonportable-jndi-names

zero or one

Disables GlassFish Server specific JNDI names.

keep-state

zero or one

Retains stateful session bean instances and persistently created EJB timers across redeployments.

version-identifier

zero or one

Contains version information for an EJB module.

context-root

zero or one

Contains the web context root for the web module.

security-role-mapping

zero or more

Maps roles to users or groups in the currently active realm.

servlet

zero or more

Specifies a principal name for a servlet, which is used for the run-as role defined in web.xml.

idempotent-url-pattern

zero or more

Specifies a URL pattern for idempotent requests.

session-config

zero or one

Specifies session manager, session cookie, and other session-related information.

ejb-ref

zero or more

Maps the absolute JNDI name to the ejb-ref in the corresponding Java EE XML file.

resource-ref

zero or more

Maps the absolute JNDI name to the resource-ref in the corresponding Java EE XML file.

resource-env-ref

zero or more

Maps the absolute JNDI name to the resource-env-ref in the corresponding Java EE XML file.

service-ref

zero or more

Specifies runtime settings for a web service reference.

message-destination-ref

zero or more

Specifies the name of a physical message destination.

cache

zero or one

Configures caching for web application components.

class-loader

zero or one

Specifies class loader configuration information.

jsp-config

zero or one

Specifies JSP configuration information.

locale-charset-info

zero or one

Deprecated. Use the parameter-encoding subelement of glassfish-web-app instead.

parameter-encoding

zero or one

Determines the default request character encoding and how the web container decodes parameters from forms according to a hidden field value.

property (with attributes)

zero or more

Specifies a property, which has a name and a value.

valve

zero or more

Specifies a custom valve.

message-destination

zero or more

Specifies the name of a logical message destination.

webservice-description

zero or more

Specifies a name and optional publish location for a web service.

keep-state

zero or one

Retains web sessions across redeployments.

version-identifier

zero or one

Contains version information for a web application.

error-url

(blank)

(optional) Not implemented. Do not use.

httpservlet-security-provider

none

(optional) Specifies the HttpServlet message layer provider that the web container's servlet auth-constraint processing calls.

allowLinking

false

If true, resources in this web application that are symbolic links are served. You can also define this property for a virtual server. Web applications on the virtual server that do not define this property use the virtual server's value. For details, see create-virtual-server(1).

Caution: Setting this property to true on Windows systems exposes JSP source code.

alternatedocroot_n

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:

• Exact match

• Longest path match

• Extension match

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.

<property name="alternatedocroot_1" 
   value="from=/my.jpg dir=/srv/images/jpg"/>
<property name="alternatedocroot_2" 
   value="from=*.jpg dir=/srv/images/jpg"/>
<property name="alternatedocroot_3" 
   value="from=/jpg/* dir=/src/images"/>

The value of each alternate docroot has two components: The first component, from, specifies the alternate docroot's URI pattern, and the second component, dir, specifies the alternate docroot's physical location (directory). Spaces are allowed in the dir component.

You can set this property for all the web applications on a specific virtual server. For details, see create-virtual-server(1).

valve_n

none

This property is deprecated. Use the valve subelement instead.

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:

<property name="valve_1" 
   value="org.glassfish.extension.Valve"/>

You can set this property for all the web applications on a specific virtual server. For details, see create-virtual-server(1).

listener_n

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:

<property name="listener_1" 
   value="org.glassfish.extension.MyLifecycleListener"/>

You can set this property for all the web applications on a specific virtual server. For details, see create-virtual-server(1).

crossContextAllowed

true

If true, allows this web application to access the contexts of other web applications using the ServletContext.getContext()method.

relativeRedirectAllowed

false

If true, allows this web application to send a relative URL to the client using HttpServletResponse.sendRedirect(), and instructs the web container not to translate any relative URLs to fully qualified ones.

reuseSessionID

false

If true, sessions generated for this web application use the session ID specified in the request.

securePagesWithPragma

true

Set this property to false to ensure that for this web application file downloads using SSL work properly in Internet Explorer.

You can set this property for all the web applications on a specific virtual server. For details, see create-virtual-server(1).

singleThreadedServletPoolSize

5

Specifies the maximum number of servlet instances allocated for each SingleThreadModel servlet in the web application.

tempdir

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 javax.servlet.context.tempdir context attribute. Compiled JSP files are also placed in this directory.

useResponseCTForHeaders

false

If true, response headers are encoded using the response's charset instead of the default (UTF-8).

eis-group

none

Specifies an EIS group.

mapped-group

none

Specifies a group defined in the GlassFish Server domain.

url-pattern

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.

no-of-retries

-1

(optional) Specifies the number of times the load balancer retries an idempotent request. A value of -1 indicates infinite retries.

transport-config

zero or one

Specifies the security information for transport.

as-context

zero or one

Specifies the authentication mechanism used to authenticate the client. If specified, it is USERNAME_PASSWORD.

sas-context

zero or one

Describes the sas-context fields.

method-name

only one

Specifies a method name.

method-params

zero or one

Specifies fully qualified Java type names of method parameters.

context-root

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:

http://host:port/app-name/relative-URI-to-appclient-jar

The default for a stand-alone application client module is as follows:

http://host:port/module-name

If the module-name is not specified during deployment, the name of the EAR or JAR file without the extension is used. If the web module is not in EAR or JAR file format, a name is generated and written to the server log.

eligible

zero or one

Specifies whether the application client module is eligible to be Java Web Start enabled. Allowed values are true (the default) and false.

vendor

zero or one

Specifies the name of the vendor as it appears in Java Web Start download and launch screens. The default value is Application Client.

jnlp-doc

zero or one

Specifies the name of a custom JNLP file. If none is specified, a default JNLP file is generated.

description

zero or one

Contains a text description of this element.

property (with attributes)

zero or more

Specifies a property or a variable.

name

none

Specifies the name of the connection pool. A jdbc-resource element's pool-name attribute refers to this name.

datasource-classname

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.

res-type

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 driver-classname is specified. An error occurs if this attribute has a legal value and the indicated interface is not implemented by the data source class.

driver-classname

none

(optional) Specifies the vendor-supplied JDBC driver class name. This driver must implement the java.sql.Driver interface.

ping

false

(optional) Specifies whether to ping the pool during pool creation or reconfiguration to identify and warn of any erroneous attribute values.

steady-pool-size

8

(optional) Specifies the initial and minimum number of connections maintained in the pool.

max-pool-size

32

(optional) Specifies the maximum number of connections that can be created to satisfy client requests.

max-wait-time-in-millis

60000

(optional) Specifies the amount of time, in milliseconds, that the caller is willing to wait for a connection. If 0, the caller is blocked indefinitely until a resource is available or an error occurs.

pool-resize-quantity

2

(optional) Specifies the number of idle connections to be destroyed if the existing number of connections is above the steady-pool-size (subject to the max-pool-size limit).

This is enforced periodically at the idle-timeout-in-seconds interval. An idle connection is one that has not been used for a period of idle-timeout-in-seconds. When the pool size reaches steady-pool-size, connection removal stops.

idle-timeout-in-seconds

300

(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.

transaction-isolation-level

default JDBC driver isolation level

(optional) Specifies the transaction isolation level on the pooled database connections. Allowed values are read-uncommitted, read-committed , repeatable-read, or serializable.

Applications that change the isolation level on a pooled connection programmatically risk polluting the pool, which can lead to errors. See is-isolation-level-guaranteed for more details.

is-isolation-level-guaranteed

true

(optional) Applicable only when transaction-isolation-level is explicitly set. If true, every connection obtained from the pool is guaranteed to have the desired isolation level. This might impact performance on some JDBC drivers. Only set this attribute to false if you are certain that the hosted applications do not return connections with altered isolation levels.

is-connection-validation-required

false

(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.

connection-validation-method

table

(optional) Legal values are as follows:

• auto-commit, which uses Connection.setAutoCommit(Connection.getAutoCommit())

• meta-data, which uses Connection.getMetaData()

• table, which performs a query on a table specified in the validation-table-name attribute

• custom-validation, which uses a user-defined validation mechanism specified by the custom implementation class in validation-classname.

Because many JDBC drivers cache the results of auto-commit and meta-data calls, they do not always provide reliable validations. Check with the driver vendor to determine whether these calls are cached or not.

The table must exist and be accessible, but it doesn't require any rows. Do not use an existing table that has a large number of rows or a table that is already frequently accessed.

validation-table-name

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 connection-validation-method is set to table.

validation-classname

none

(optional) Specifies the custom validation implementation class name. This parameter is mandatory if connection-validation-method is set to custom-validation. The classname provided must be accessible to the GlassFish Server. The specified class must implement the org.glassfish.api.jdbc.ConnectionValidation interface.

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.

• org.glassfish.api.jdbc.MSSQLConnectionValidation

• org.glassfish.api.jdbc.DB2ConnectionValidation

• org.glassfish.api.jdbc.SybaseConnectionValidation

init-sql

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.

fail-all-connections

false

(optional) If true, closes all connections in the pool if a single validation check fails. This parameter is mandatory if and only if is-connection-validation-required is set to true.

non-transactional-connections

false

(optional) If true, non-transactional connections can be made to the JDBC connection pool. These connections are not automatically enlisted with the transaction manager.

allow-non-component-callers

false

(optional) If true, non-Java-EE components, such as servlet filters, lifecycle modules, and third party persistence managers, can use this JDBC connection pool. The returned connection is automatically enlisted with the transaction context obtained from the transaction manager. Standard Java EE components can also use such pools. Connections obtained by non-component callers are not automatically closed at the end of a transaction by the container. They must be explicitly closed by the caller.

validate-atmost-once-period-in-seconds

0

(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.

connection-leak-timeout-in-seconds

0

(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 connection-leak-reclaim to avoid potential connection leaks from the application.

connection-leak-reclaim

false

(optional) If true, the pool will reclaim a connection after connection-leak-timeout-in-seconds occurs.

connection-creation-retry-attempts

0

(optional) Specifies the number of attempts to create a new connection in case of a failure.

connection-creation-retry-interval-in-seconds

10

(optional) Specifies the time interval between attempts to create a connection when connection-creation-retry-attempts is greater than 0.

statement-leak-timeout-in-seconds

0

(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 statement-leak-reclaim to avoid potential statement leaks from the application.

statement-leak-reclaim

false

(optional) If true, the reclaim of a statement after statement-leak-timeout-in-seconds occurs.

statement-timeout-in-seconds

-1

(optional) Sets the query timeout property of a statement to enable termination of abnormally long running queries. The default value of -1 disables this feature.

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 queryTimeout is set according to the value specified in this attribute. This works only when the underlying JDBC driver supports queryTimeout for Statement, PreparedStatement, CallableStatement, and ResultSet.

lazy-connection-enlistment

false

(optional) If true, a connection is not enlisted in a transaction until it is used. If false, any connection object available to a transaction is enlisted in the transaction.

lazy-connection-association

false

(optional) If true, a physical connection is not associated with a logical connection until it is used. If false, a physical connection is associated with a logical connection even before it is used.

associate-with-thread

false

(optional) Specifies whether connections are associated with the thread to enable the thread to reuse the connections. If true, allows connections to be saved as ThreadLocal in the calling thread. Connections get reclaimed only when the calling thread dies or when the calling thread is not in use and the pool has run out of connections. If false, the thread must obtain a connection from the pool each time the thread requires a connection.

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 true, you should verify that the value of the max-pool-size attribute is comparable to the max-thread-pool-size attribute of the associated thread pool. If the max-thread-pool-size value is much higher than the max-pool-size value, a lot of time is spent associating connections with a new thread after dissociating them from an older one. Use this attribute in cases where the thread pool should reuse connections to avoid this overhead.

match-connections

false

(optional) Specifies whether a connection that is selected from the pool should be matched with the connections with certain credentials. If true, enables connection matching. You can set to false if connections are homogeneous.

If the connection pool is used by applications that have multiple user credentials, match-connections must be true. The connection pool matches the request's credential with the connections in the pool and returns a matched connection for use. For new requests with different credentials, unmatched free connections are automatically purged to provide new connections to satisfy the new requests. This attribute need not be true if it is known that there is only one credential used by the applications and therefore the pool has homogeneous connections.

max-connection-usage-count

0

(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.

sql-trace-listeners

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.

statement-cache-size

0

(optional) Specifies the number of statements to be cached using the lru (Least Recently Used) caching mechanism. The default value of 0 disables statement caching.

pooling

true

(optional) If false, disables connection pooling.

wrap-jdbc-objects

true

(optional) If true, wrapped JDBC objects are returned for Statement, PreparedStatement, CallableStatement, ResultSet, and DatabaseMetaData.

This option ensures that Statement.getConnection() is the same as DataSource.getConnection(). Therefore, this option should be true when both Statement.getConnection() and DataSource.getConnection() are done. The default is false to avoid breaking existing applications.

dynamic-reconfiguration-wait-timeout-in-seconds

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.

number-of-top-queries-to-report

10

Specifies the number of most frequently used queries to display. For example, the default value of 10 displays the top ten queries.

This property is disabled when jdbc-connection-pool monitoring is set to LOW or OFF. It is enabled when jdbc-connection-pool monitoring is set to HIGH and the sql-trace-listeners attribute is set.

time-to-keep-queries-in-minutes

5

Specifies the time to retain queries in a cache before they are purged.

This property is disabled when jdbc-connection-pool monitoring is set to LOW or OFF. It is enabled when jdbc-connection-pool monitoring is set to HIGH and the sql-trace-listeners attribute is set.

user

Specifies the user name for connecting to the database.

password

Specifies the password for connecting to the database.

databaseName

Specifies the database for this connection pool.

serverName

Specifies the database server for this connection pool.

port

Specifies the port on which the database server listens for requests.

networkProtocol

Specifies the communication protocol.

roleName

Specifies the initial SQL role name.

datasourceName

Specifies an underlying XADataSource, or a ConnectionPoolDataSource if connection pooling is done.

description

Specifies a text description.

url

Specifies the URL for this connection pool. Although this is not a standard property, it is commonly used.

description

zero or one

Contains a text description of this element.

property (with attributes)

zero or more

Specifies a property or a variable.

jndi-name

none

Specifies the JNDI name for the resource.

description

none

(optional) Specifies a text description of this element.

pool-name

none

Specifies the name of the associated jdbc-connection-pool.

object-type

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.

property (with attributes)

zero or more

Specifies a property, which has a name and a value.

checkInterval

0

If development is set to false and checkInterval is greater than zero, background compilations are enabled. The checkInterval is the time in seconds between checks to see if a JSP file needs to be recompiled.

classdebuginfo

true

Specifies whether the generated Java servlets are compiled with the debug option set (-g for javac).

classpath

created dynamically based on the current web application

Specifies the classpath to use when compiling generated servlets.

compiler

javac

Specifies the compiler Ant uses to compile JSP files. See the Ant documentation for more information:

http://antinstaller.sourceforge.net/manual/manual/

compilerSourceVM

Depends on GlassFish Server's Java runtime

Specifies the JDK release with which source compatibility of the generated servlets is provided. Same as the -source release option of javac.

For more information, see http://download.oracle.com/javase/6/docs/technotes/tools/solaris/javac.html#options.

compilerTargetVM

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 -target release option of javac.

For more information, see http://download.oracle.com/javase/6/docs/technotes/tools/solaris/javac.html#options.

defaultBufferNone

false

If true, the default for the buffer attribute of the page directive is none.

development

true

If set to true, enables development mode, which allows JSP files to be checked for modification. Specify the frequency at which JSPs are checked using the modificationTestInterval property.

dumpSmap

false

If set to true, dumps SMAP information for JSR 45 debugging to a file. Set to false if suppressSmap is true.

enablePooling

true

If set to true, tag handler pooling is enabled.

enableTldValidation

false

If set to true, all Tag Library Descriptor (TLD) files referenced by the web application are validated against their underlying schema or DTD file.

errorOnUseBeanInvalidClassAttribute

false

If set to true, issues an error when the value of the class attribute in a useBean action is not a valid bean class.

fork

true

Specifies that Ant forks the compiling of JSP files, using a JVM machine separate from the one in which Tomcat is running.

genStrAsByteArray

true

If true, text strings are generated as bytes (encoded with the page encoding), if the page is not buffered.

genStrAsCharArray

false

If set to true, generates text strings as char arrays, which improves performance in some cases.

httpMethods

* for all methods

Specifies a comma separated list of HTTP methods supported by the JspServlet.

ieClassId

clsid:8AD9C840-044E-11D1-B3E9-00805F499D93

Specifies the Java plug-in COM class ID for Internet Explorer. Used by the <jsp:plugin> tags.

ignoreJspFragmentErrors

false