Appendix A Deployment Descriptor Files

This chapter describes deployment descriptor files specific to the Sun GlassFish Enterprise Server in the following sections:

• Enterprise Server Descriptors

• The sun-web.xml File

• The sun-ejb-jar.xml File

• Alphabetical Listing of All Elements

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. The sun-ejb-jar.xml elements related to these features are ignored.

Web services are not supported unless the optional Metro (JSR 109) add-on component is downloaded from the Update Tool. Without the Metro add-on component, a servlet or EJB module cannot be a web service endpoint, and the sun-web.xml and sun-ejb-jar.xml elements related to web services are ignored.

Global (XA) transactions are not supported unless the optional JTS and Object Management Group (OMG) add-on components are downloaded from the Update Tool. Without the these components, only local transactions are supported. Transaction recovery is not implemented for GlassFish v3 Prelude, even if the JTS and OMG add-on components are installed. Therefore, all transaction service attributes and properties pertaining to transaction recovery or transaction logs are not implemented.

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

GlassFish v3 Prelude does not support clustering or load balancing features, Sun GlassFish Message Queue software, container-managed persistence (CMP), or descriptor-based schema generation. Elements related to these features are ignored.

Sun Java System Application Server Descriptors

Sun GlassFish Enterprise Server uses optional deployment descriptors in addition to the Java EE standard descriptors for configuring features specific to the Enterprise Server.

Settings in the Enterprise Server deployment descriptors override corresponding settings in the Java EE deployment descriptors and in the Enterprise Server's domain.xml file unless otherwise stated. For more information about the domain.xml file, see the Sun GlassFish Enterprise Server v3 Prelude Administration Reference.

Each deployment descriptor (or XML) file has a corresponding DTD file, which defines the elements, data, and attributes that the deployment descriptor file can contain. The DTD files for the Enterprise Server deployment descriptors are located in the as-install/lib/dtds directory.

Do not edit the DTD files; their contents change only with new versions of the Enterprise Server.

For general information about DTD files and XML, see the XML specification at http://www.w3.org/TR/REC-xml.

The following table lists the Enterprise Server deployment descriptors and their DTD files.

The Enterprise Server deployment descriptors must be readable and writable by the file owners.

In each deployment descriptor file, subelements must be defined in the order in which they are listed under each Subelements heading, unless otherwise noted.

The sun-web.xml File

The element hierarchy in the sun-web.xml file is as follows:

sun-web-app
.  context-root
.  security-role-mapping
.  .  role-name
.  .  principal-name
.  .  group-name
.  servlet
.  .  servlet-name
.  .  principal-name
.  .  webservice-endpoint
.  .  .  port-component-name
.  .  .  endpoint-address-uri
.  .  .  login-config
.  .  .  .  auth-method
.  .  .  message-security-binding
.  .  .  .  message-security
.  .  .  .  .  message
.  .  .  .  .  .  java-method
.  .  .  .  .  .  .  method-name
.  .  .  .  .  .  .  method-params
.  .  .  .  .  .  .  .  method-param
.  .  .  .  .  .  operation-name
.  .  .  .  .  request-protection
.  .  .  .  .  response-protection
.  .  .  transport-guarantee
.  .  .  service-qname
.  .  .  tie-class
.  .  .  servlet-impl-class
.  .  .  debugging-enabled
.  .  .  property (with attributes)
.  .  .  .  description
.  idempotent-url-pattern
.  session-config
.  .  session-manager
.  .  .  manager-properties
.  .  .  .  property (with attributes)
.  .  .  .  .  description
.  .  .  store-properties
.  .  .  .  property (with attributes)
.  .  .  .  .  description
.  .  session-properties
.  .  .  property (with attributes)
.  .  .  .  description
.  .  cookie-properties
.  .  .  property (with attributes)
.  .  .  .  description
.  ejb-ref
.  .  ejb-ref-name
.  .  jndi-name
.  resource-ref
.  .  res-ref-name
.  .  jndi-name
.  .  default-resource-principal
.  .  .  name
.  .  .  password
.  resource-env-ref
.  .  resource-env-ref-name
.  .  jndi-name
.  service-ref
.  .  service-ref-name
.  .  port-info
.  .  .  service-endpoint-interface
.  .  .  wsdl-port
.  .  .  .  namespaceURI
.  .  .  .  localpart
.  .  .  stub-property
.  .  .  .  name
.  .  .  .  value
.  .  .  call-property
.  .  .  .  name
.  .  .  .  value
.  .  .  message-security-binding
.  .  .  .  message-security
.  .  .  .  .  message
.  .  .  .  .  .  java-method
.  .  .  .  .  .  .  method-name
.  .  .  .  .  .  .  method-params
.  .  .  .  .  .  .  .  method-param
.  .  .  .  .  .  operation-name
.  .  .  .  .  request-protection
.  .  .  .  .  response-protection
.  .  call-property
.  .  .  name
.  .  .  value
.  .  wsdl-override
.  .  service-impl-class
.  .  service-qname
.  .  .  namespaceURI
.  .  .  localpart
.  message-destination-ref
.  .  message-destination-ref-name
.  .  jndi-name
.  cache
.  .  cache-helper
.  .  .  property (with attributes)
.  .  .  .  description
.  .  default-helper
.  .  .  property (with attributes)
.  .  .  .  description
.  .  property (with attributes)
.  .  .  description
.  .  cache-mapping
.  .  .  servlet-name
.  .  .  url-pattern
.  .  .  cache-helper-ref
.  .  .  dispatcher
.  .  .  timeout
.  .  .  refresh-field
.  .  .  http-method
.  .  .  key-field
.  .  .  constraint-field
.  .  .  .  constraint-field-value
.  class-loader
.  .  property (with attributes)
.  .  .  description
.  jsp-config
.  locale-charset-info
.  .  locale-charset-map
.  .  parameter-encoding
.  parameter-encoding
.  property (with attributes)
.  .  description
.  message-destination
.  .  message-destination-name
.  .  jndi-name
.  webservice-description
.  .  webservice-description-name
.  .  wsdl-publish-location

Here is a sample sun-web.xml file:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sun-web-app PUBLIC '-//Sun Microsystems, Inc.//DTD 
Application Server 9.0 Servlet 2.5//EN' 
'http://www.sun.com/software/appserver/dtds/sun-web-app_2_5-0.dtd'>
<sun-web-app>
   <session-config>
      <session-manager/>
   </session-config>
   <resource-ref>
      <res-ref-name>mail/Session</res-ref-name>
      <jndi-name>mail/Session</jndi-name>
   </resource-ref>
   <jsp-config/>
</sun-web-app>

The sun-ejb-jar.xml File

The element hierarchy in the sun-ejb-jar.xml file is as follows:

sun-ejb-jar
.  security-role-mapping
.  .  role-name
.  .  principal-name
.  .  group-name
.  enterprise-beans
.  .  name
.  .  unique-id
.  .  ejb
.  .  .  ejb-name
.  .  .  jndi-name
.  .  .  ejb-ref
.  .  .  .  ejb-ref-name
.  .  .  .  jndi-name
.  .  .  resource-ref
.  .  .  .  res-ref-name
.  .  .  .  jndi-name
.  .  .  .  default-resource-principal
.  .  .  .  .  name
.  .  .  .  .  password
.  .  .  resource-env-ref
.  .  .  .  resource-env-ref-name
.  .  .  .  jndi-name
.  .  .  service-ref
.  .  .  .  service-ref-name
.  .  .  .  port-info
.  .  .  .  .  service-endpoint-interface
.  .  .  .  .  wsdl-port
.  .  .  .  .  .  namespaceURI
.  .  .  .  .  .  localpart
.  .  .  .  .  stub-property
.  .  .  .  .  .  name
.  .  .  .  .  .  value
.  .  .  .  .  call-property
.  .  .  .  .  .  name
.  .  .  .  .  .  value
.  .  .  .  .  message-security-binding
.  .  .  .  .  .  message-security
.  .  .  .  .  .  .  message
.  .  .  .  .  .  .  .  java-method
.  .  .  .  .  .  .  .  .  method-name
.  .  .  .  .  .  .  .  .  method-params
.  .  .  .  .  .  .  .  .  .  method-param
.  .  .  .  .  .  .  .  operation-name
.  .  .  .  .  .  .  request-protection
.  .  .  .  .  .  .  response-protection
.  .  .  .  call-property
.  .  .  .  .  name
.  .  .  .  .  value
.  .  .  .  wsdl-override
.  .  .  .  service-impl-class
.  .  .  .  service-qname
.  .  .  .  .  namespaceURI
.  .  .  .  .  localpart
.  .  .  message-destination-ref
.  .  .  .  message-destination-ref-name
.  .  .  .  jndi-name
.  .  .  pass-by-reference
.  .  .  cmp
.  .  .  .  mapping-properties
.  .  .  .  is-one-one-cmp
.  .  .  .  one-one-finders
.  .  .  .  .  finder
.  .  .  .  .  .  method-name
.  .  .  .  .  .  query-params
.  .  .  .  .  .  query-filter
.  .  .  .  .  .  query-variables
.  .  .  .  .  .  query-ordering
.  .  .  .  prefetch-disabled
.  .  .  .  .  query-method
.  .  .  .  .  .  method-name
.  .  .  .  .  .  method-params
.  .  .  .  .  .  .  method-param
.  .  .  principal
.  .  .  .  name
.  .  .  mdb-connection-factory
.  .  .  .  jndi-name
.  .  .  .  default-resource-principal
.  .  .  .  .  name
.  .  .  .  .  password
.  .  .  jms-durable-subscription-name
.  .  .  jms-max-messages-load
.  .  .  ior-security-config
.  .  .  .  transport-config
.  .  .  .  .  integrity
.  .  .  .  .  confidentiality
.  .  .  .  .  establish-trust-in-target
.  .  .  .  .  establish-trust-in-client
.  .  .  .  as-context
.  .  .  .  .  auth-method
.  .  .  .  .  realm
.  .  .  .  .  required
.  .  .  .  sas-context
.  .  .  .  .  caller-propagation
.  .  .  is-read-only-bean
.  .  .  refresh-period-in-seconds
.  .  .  commit-option
.  .  .  cmt-timeout-in-seconds
.  .  .  use-thread-pool-id
.  .  .  gen-classes
.  .  .  .  remote-impl
.  .  .  .  local-impl
.  .  .  .  remote-home-impl
.  .  .  .  local-home-impl
.  .  .  bean-pool
.  .  .  .  steady-pool-size
.  .  .  .  resize-quantity
.  .  .  .  max-pool-size
.  .  .  .  pool-idle-timeout-in-seconds
.  .  .  .  max-wait-time-in-millis
.  .  .  bean-cache
.  .  .  .  max-cache-size
.  .  .  .  resize-quantity
.  .  .  .  is-cache-overflow-allowed
.  .  .  .  cache-idle-timeout-in-seconds
.  .  .  .  removal-timeout-in-seconds
.  .  .  .  victim-selection-policy
.  .  .  mdb-resource-adapter
.  .  .  .  resource-adapter-mid
.  .  .  .  activation-config
.  .  .  .  .  description
.  .  .  .  .  activation-config-property
.  .  .  .  .  .  activation-config-property-name
.  .  .  .  .  .  activation-config-property-value
.  .  .  webservice-endpoint
.  .  .  .  port-component-name
.  .  .  .  endpoint-address-uri
.  .  .  .  login-config
.  .  .  .  .  auth-method
.  .  .  .  .  realm
.  .  .  .  message-security-binding
.  .  .  .  .  message-security
.  .  .  .  .  .  message
.  .  .  .  .  .  .  java-method
.  .  .  .  .  .  .  .  method-name
.  .  .  .  .  .  .  .  method-params
.  .  .  .  .  .  .  .  .  method-param
.  .  .  .  .  .  .  operation-name
.  .  .  .  .  .  request-protection
.  .  .  .  .  .  response-protection
.  .  .  .  transport-guarantee
.  .  .  .  service-qname
.  .  .  .  tie-class
.  .  .  .  servlet-impl-class
.  .  .  .  debugging-enabled
.  .  .  .  property (with subelements)
.  .  .  .  .  name
.  .  .  .  .  value
.  .  .  flush-at-end-of-method
.  .  .  .  method
.  .  .  .  .  description
.  .  .  .  .  ejb-name
.  .  .  .  .  method-name
.  .  .  .  .  method-intf
.  .  .  .  .  method-params
.  .  .  .  .  .  method-param
.  .  .  checkpointed-methods
.  .  .  checkpoint-at-end-of-method
.  .  .  .  method
.  .  .  .  .  description
.  .  .  .  .  ejb-name
.  .  .  .  .  method-name
.  .  .  .  .  method-intf
.  .  .  .  .  method-params
.  .  .  .  .  .  method-param
.  .  pm-descriptors
.  .  cmp-resource
.  .  .  jndi-name
.  .  .  default-resource-principal
.  .  .  .  name
.  .  .  .  password
.  .  .  property (with subelements)
.  .  .  .  name
.  .  .  .  value
.  .  .  create-tables-at-deploy
.  .  .  drop-tables-at-undeploy
.  .  .  database-vendor-name
.  .  .  schema-generator-properties
.  .  .  .  property (with subelements)
.  .  .  .  .  name
.  .  .  .  .  value
.  .  message-destination
.  .  .  message-destination-name
.  .  .  jndi-name
.  .  webservice-description
.  .  .  webservice-description-name
.  .  .  wsdl-publish-location

If any configuration information for an enterprise bean is not specified in the sun-ejb-jar.xml file, it defaults to a corresponding setting in the EJB container if an equivalency exists.

Here is a sample sun-ejb-jar.xml file:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sun-ejb-jar PUBLIC '-//Sun Microsystems, Inc.//DTD 
Application Server 9.0 EJB 3.0//EN' 
'http://www.sun.com/software/appserver/dtds/sun-ejb-jar_3_0-0.dtd'>
<sun-ejb-jar>
<display-name>First Module</display-name>
<enterprise-beans>
	<ejb>
		<ejb-name>CustomerEJB</ejb-name>
		<jndi-name>customer</jndi-name>
		<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>
	<cmp-resource>
		<jndi-name>jdbc/__default</jndi-name>
		<create-tables-at-deploy>true</create-tables-at-deploy>
		<drop-tables-at-undeploy>true</drop-tables-at-undeploy>
	</cmp-resource>
</enterprise-beans>
</sun-ejb-jar>

Alphabetical Listing of All Elements

• A

• B

• C

• D

• E

• F

• G

• H

• I

• J

• K

• L

• M

• N

• O

• P

• Q

• R

• S

• T

• U

• V

• W

A

activation-config

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

Superelements

mdb-resource-adapter (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the activation-config element.

activation-config-property

Specifies the name and value of an activation configuration property.

Superelements

activation-config (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the activation-config-property element.

activation-config-property-name

Specifies the name of an activation configuration property.

Superelements

activation-config-property (sun-ejb-jar.xml)

Subelements

none - contains data

activation-config-property-value

Specifies the value of an activation configuration property.

Superelements

activation-config-property (sun-ejb-jar.xml)

Subelements

none - contains data

as-context

Specifies the authentication mechanism used to authenticate the client.

Superelements

ior-security-config (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the as-context element.

auth-method

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

Superelements

login-config (sun-web.xml), as-context (sun-ejb-jar.xml)

Subelements

none - contains data

B

bean-cache

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

This element is not implemented for GlassFish v3 Prelude.

Superelements

ejb (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the bean-cache element.

Example

<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-pool

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

This element is not implemented for GlassFish v3 Prelude.

Superelements

ejb (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the bean-pool element.

Example

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

C

cache

Configures caching for web application components.

Superelements

sun-web-app (sun-web.xml)

Subelements

The following table describes subelements for the cache element.

Attributes

The following table describes attributes for the cache element.

Properties

The following table describes properties for the cache element.

Cache Class Names

The following table lists possible values of the cacheClassName property.

cache-helper

Specifies a class that implements the com.sun.appserv.web.cache.CacheHelper interface.

Superelements

cache (sun-web.xml)

Subelements

The following table describes subelements for the cache-helper element.

Attributes

The following table describes attributes for the cache-helper element.

cache-helper-ref

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

Superelements

cache-mapping (sun-web.xml)

Subelements

none - contains data

cache-idle-timeout-in-seconds

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. Default is 600.

Applies to stateful session beans and entity beans.

This element is not implemented for GlassFish v3 Prelude.

Superelements

bean-cache (sun-ejb-jar.xml)

Subelements

none - contains data

cache-mapping

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

Superelements

cache (sun-web.xml)

Subelements

The following table describes subelements for the cache-mapping element.

call-property

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

Superelements

port-info, service-ref (sun-web.xml, sun-ejb-jar.xml)

Subelements

The following table describes subelements for the call-property element.

caller-propagation

Specifies whether the target accepts propagated caller identities. The values are NONE, SUPPORTED, or REQUIRED.

Superelements

sas-context (sun-ejb-jar.xml)

Subelements

none - contains data

checkpoint-at-end-of-method

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

This element is not implemented for GlassFish v3 Prelude.

Superelements

ejb (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the checkpoint-at-end-of-method element.

checkpointed-methods

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

This element is not implemented for GlassFish v3 Prelude.

Superelements

ejb (sun-ejb-jar.xml)

class-loader

Configures the class loader for the web module.

Superelements

sun-web-app (sun-web.xml)

Subelements

The following table describes subelements for the class-loader element.

Attributes

The following table describes attributes for the class-loader element.

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

If the delegate element is set to false, the class loader delegation behavior complies with the Servlet 2.4 specification, section 9.7.2. If set to its default value of true, classes and resources residing in container-wide library JAR files are loaded in preference to classes and resources packaged within the WAR file.

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.

Properties

The following table describes properties for the class-loader element.

cmp

Describes runtime information for a CMP entity bean object for EJB 1.1 and EJB 2.1 beans.

This element is not implemented for GlassFish v3 Prelude.

Superelements

ejb (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the cmp element.

cmp-resource

Specifies the database to be used for storing CMP beans.

This element is not implemented for GlassFish v3 Prelude.

Superelements

enterprise-beans (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the cmp-resource element.

cmt-timeout-in-seconds

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

Superelements

ejb (sun-ejb-jar.xml)

Subelements

none - contains data

commit-option

Specifies the commit option used on transaction completion. Valid values for the Enterprise Server are B or C. Default value is B. Applies to entity beans.

This element is not implemented for GlassFish v3 Prelude.

Superelements

ejb (sun-ejb-jar.xml)

Subelements

none - contains data

confidentiality

Specifies if the target supports privacy-protected messages. The values are NONE, SUPPORTED, or REQUIRED.

Superelements

transport-config (sun-ejb-jar.xml)

Subelements

none - contains data

constraint-field

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

Superelements

cache-mapping (sun-web.xml)

Subelements

The following table describes subelements for the constraint-field element.

Attributes

The following table describes attributes for the constraint-field element.

constraint-field-value

Specifies 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>

Superelements

constraint-field (sun-web.xml)

Subelements

none - contains data

Attributes

The following table describes attributes for the constraint-field-value element.

context-root

Contains the web context root for the web application. Overrides the corresponding element in the web.xml file.

Superelements

sun-web-app (sun-web.xml)

Subelements

none - contains data

cookie-properties

Specifies session cookie properties.

Superelements

session-config (sun-web.xml)

Subelements

The following table describes subelements for the cookie-properties element.

Properties

The following table describes properties for the cookie-properties element.

create-tables-at-deploy

Specifies 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 is not implemented for GlassFish v3 Prelude.

Superelements

cmp-resource (sun-ejb-jar.xml)

Subelements

none - contains data

D

database-vendor-name

Specifies the name of the database vendor for which tables can be created. Allowed values are javadb, db2, mssql, 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 is not implemented for GlassFish v3 Prelude.

Superelements

cmp-resource (sun-ejb-jar.xml)

Subelements

none - contains data

debugging-enabled

Specifies whether the debugging servlet is enabled for this web service endpoint. Allowed values are true (the default) and false.

Superelements

webservice-endpoint (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

default-helper

Passes property values to the built-in default cache-helper class.

Superelements

cache (sun-web.xml)

Subelements

The following table describes subelements for the default-helper element.

Properties

The following table describes properties for the default-helper element.

default-resource-principal

Specifies 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 Sun Java^TM System Message Queue broker user repository.

Superelements

resource-ref (sun-web.xml, sun-ejb-jar.xml); cmp-resource, mdb-connection-factory (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the default-resource-principal element.

description

Specifies a text description of the containing element.

Superelements

property (with attributes) (sun-web.xml); activation-config, method (sun-ejb-jar.xml)

Subelements

none - contains data

dispatcher

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

Superelements

cache-mapping (sun-web.xml)

Subelements

none - contains data

drop-tables-at-undeploy

Specifies 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 is not implemented for GlassFish v3 Prelude.

Superelements

cmp-resource (sun-ejb-jar.xml)

Subelements

none - contains data

E

ejb

Defines 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

Superelements

enterprise-beans (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the ejb element.

Attributes

The following table describes attributes for the ejb element.

Example

<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-name

In the sun-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.

Superelements

ejb, method (sun-ejb-jar.xml)

Subelements

none - contains data

ejb-ref

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

Superelements

sun-web-app (sun-web.xml), ejb (sun-ejb-jar.xml)

Subelements

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

ejb-ref-name

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

Superelements

ejb-ref (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

endpoint-address-uri

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

Superelements

webservice-endpoint (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

Example

If the web server is listening at http://localhost:8080, the following endpoint-address-uri:

<endpoint-address-uri>StockQuoteService/StockQuotePort</endpoint-address-uri>

results in the following target endpoint address:

http://localhost:8080/StockQuoteService/StockQuotePort

enterprise-beans

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

Superelements

sun-ejb-jar (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the enterprise-beans element.

Example

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

establish-trust-in-client

Specifies if the target is capable of authenticating a client. The values are NONE, SUPPORTED, or REQUIRED.

Superelements

transport-config (sun-ejb-jar.xml)

Subelements

none - contains data

establish-trust-in-target

Specifies if the target is capable of authenticating to a client. The values are NONE, SUPPORTED, or REQUIRED.

Superelements

transport-config (sun-ejb-jar.xml)

Subelements

none - contains data

F

finder

Describes the finders for CMP 1.1 with a method name and query.

This element is not implemented for GlassFish v3 Prelude.

Superelements

one-one-finders (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the finder element.

flush-at-end-of-method

Specifies the methods that force a database flush after execution. Applicable to entity beans.

This element is not implemented for GlassFish v3 Prelude.

Superelements

ejb (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the flush-at-end-of-method element.

G

gen-classes

Specifies all the generated class names for a bean.

This value is automatically generated by the server at deployment or redeployment time. Do not specify it or change it after deployment.

This element is not implemented for GlassFish v3 Prelude.

Superelements

ejb (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the gen-classes element.

group-name

Specifies a group name in the current realm.

Superelements

security-role-mapping (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

H

http-method

Specifies an HTTP method that is eligible for caching. The default is GET.

Superelements

cache-mapping (sun-web.xml)

Subelements

none - contains data

I

idempotent-url-pattern

Specifies a URL pattern for idempotent requests.

Superelements

sun-web-app (sun-web.xml)

Subelements

none

Attributes

The following table describes attributes for the idempotent-url-pattern element.

Example

The following example specifies that all requests for the URI sun-java/* are idempotent.

<idempotent-url-pattern url-pattern="sun_java/*" no-of-retries="10"/>

integrity

Specifies if the target supports integrity-protected messages. The values are NONE, SUPPORTED, or REQUIRED.

Superelements

transport-config (sun-ejb-jar.xml)

Subelements

none - contains data

ior-security-config

Specifies the security information for the input-output redirection (IOR).

Superelements

ejb (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the ior-security-config element.

is-cache-overflow-allowed

This element is deprecated. Do not use.

Superelements

bean-cache (sun-ejb-jar.xml)

is-one-one-cmp

This element is not used.

Superelements

cmp (sun-ejb-jar.xml)

is-read-only-bean

Specifies that this entity bean is a read-only bean if true. If this element is absent, the default value of false is used.

This element is not implemented for GlassFish v3 Prelude.

Superelements

ejb (sun-ejb-jar.xml)

Subelements

none - contains data

J

java-method

Specifies a method.

This element is not implemented for GlassFish v3 Prelude.

Superelements

message (sun-web.xml, sun-ejb-jar.xml)

Subelements

The following table describes subelements for the java-method element.

jms-durable-subscription-name

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

Superelements

ejb (sun-ejb-jar.xml)

Subelements

none - contains data

jms-max-messages-load

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.

Superelements

ejb (sun-ejb-jar.xml)

Subelements

none - contains data

jndi-name

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

Superelements

ejb-ref, message-destination, resource-env-ref, resource-ref (sun-web.xml, sun-ejb-jar.xml); cmp-resource, ejb, mdb-connection-factory (sun-ejb-jar.xml)

Subelements

none - contains data

jsp-config

Specifies JSP configuration information.

Superelements

sun-web-app (sun-web.xml)

Subelements

The following table describes subelements for the jsp-config element.

Properties

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.

K

key-field

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

Superelements

cache-mapping (sun-web.xml)

Subelements

none

Attributes

The following table describes attributes for the key-field element.

L

local-home-impl

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

This value is automatically generated by the server at deployment or redeployment time. Do not specify it or change it after deployment.

This element is not implemented for GlassFish v3 Prelude.

Superelements

gen-classes (sun-ejb-jar.xml)

Subelements

none - contains data

local-impl

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

This value is automatically generated by the server at deployment or redeployment time. Do not specify it or change it after deployment.

This element is not implemented for GlassFish v3 Prelude.

Superelements

gen-classes (sun-ejb-jar.xml)

Subelements

none - contains data

locale-charset-info

Deprecated. For backward compatibility only. Use the parameter-encoding subelement of sun-web-app instead. Specifies information about the application’s internationalization settings.

Superelements

sun-web-app (sun-web.xml)

Subelements

The following table describes subelements for the locale-charset-info element.

Attributes

The following table describes attributes for the locale-charset-info element.

locale-charset-map

Maps 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://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html.

Superelements

locale-charset-info (sun-web.xml)

Subelements

The following table describes subelements for the locale-charset-map element.

Attributes

The following table describes attributes for the locale-charset-map element.

Example Agents

The following table specifies example agent attribute values.

localpart

Specifies the local part of a QNAME.

Superelements

service-qname, wsdl-port (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

login-config

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

Superelements

webservice-endpoint (sun-web.xml, sun-ejb-jar.xml)

Subelements

The following table describes subelements for the login-config element.

M

manager-properties

Specifies session manager properties.

Superelements

session-manager (sun-web.xml)

Subelements

The following table describes subelements for the manager-properties element.

Properties

The following table describes properties for the manager-properties element.

mapping-properties

This element is not implemented.

Superelements

cmp (sun-ejb-jar.xml)

max-cache-size

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

This element is not implemented for GlassFish v3 Prelude.

Superelements

bean-cache (sun-ejb-jar.xml)

Subelements

none - contains data

max-pool-size

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

This element is not implemented for GlassFish v3 Prelude.

Superelements

bean-pool (sun-ejb-jar.xml)

Subelements

none - contains data

max-wait-time-in-millis

This element is deprecated. Do not use.

Superelements

bean-pool (sun-ejb-jar.xml)

mdb-connection-factory

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

Superelements

ejb (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the mdb-connection-factory element.

mdb-resource-adapter

Specifies runtime configuration information for a message-driven bean.

Superelements

ejb (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the mdb-resource-adapter element.

message

Specifies the methods or operations to which message security requirements apply.

This element is not implemented for GlassFish v3 Prelude.

Superelements

message-security (sun-web.xml, sun-ejb-jar.xml)

Subelements

The following table describes subelements for the message element.

message-destination

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

Superelements

sun-web-app (sun-web.xml), enterprise-beans (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the message-destination element.

message-destination-name

Specifies the name of a logical message destination defined within the corresponding Java EE deployment descriptor file.

Superelements

message-destination (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

message-destination-ref

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

Superelements

sun-web-app (sun-web.xml), ejb (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the message-destination-ref element.

message-destination-ref-name

Specifies the name of a physical message destination defined within the corresponding Java EE deployment descriptor file.

Superelements

message-destination-ref (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

message-security

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

This element is not implemented for GlassFish v3 Prelude.

Superelements

message-security-binding (sun-web.xml, sun-ejb-jar.xml)

Subelements

The following table describes subelements for the message-security element.

message-security-binding

Specifies 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

This element is not implemented for GlassFish v3 Prelude.

Superelements

webservice-endpoint, port-info (sun-web.xml, sun-ejb-jar.xml)

Subelements

The following table describes subelements for the message-security-binding element.

Attributes

The following table describes attributes for the message-security-binding element.

method

Specifies a bean method.

This element is not implemented for GlassFish v3 Prelude.

Superelements

checkpoint-at-end-of-method, flush-at-end-of-method (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the method element.

method-intf

Specifies the method interface to distinguish between methods with the same name in different interfaces. Allowed values are Home, Remote, LocalHome, and Local.

This element is not implemented for GlassFish v3 Prelude.

Superelements

method (sun-ejb-jar.xml)

Subelements

none - contains data

method-name

Specifies a method name or * (an asterisk) for all methods. If a method is overloaded, specifies all methods with the same name.

This element is not implemented for GlassFish v3 Prelude.

Superelements

java-method (sun-web.xml, sun-ejb-jar.xml); finder, query-method , method (sun-ejb-jar.xml)

Subelements

none - contains data

Examples

<method-name>findTeammates</method-name>

<method-name>*</method-name>

method-param

Specifies the fully qualified Java type name of a method parameter.

This element is not implemented for GlassFish v3 Prelude.

Superelements

method-params (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

method-params

Specifies fully qualified Java type names of method parameters.

This element is not implemented for GlassFish v3 Prelude.

Superelements

java-method (sun-web.xml, sun-ejb-jar.xml); query-method, method (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the method-params element.

N

name

Specifies the name of the entity.

Superelements

call-property, default-resource-principal, stub-property (sun-web.xml, sun-ejb-jar.xml); enterprise-beans, principal, property (with subelements) (sun-ejb-jar.xml)

Subelements

none - contains data

namespaceURI

Specifies the namespace URI.

Superelements

service-qname, wsdl-port (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

O

one-one-finders

Describes the finders for CMP 1.1 beans.

This element is not implemented for GlassFish v3 Prelude.

Superelements

cmp (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the one-one-finders element.

operation-name

Specifies the WSDL name of an operation of a web service.

This element is not implemented for GlassFish v3 Prelude.

Superelements

message (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

P

parameter-encoding

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

If both the sun-web-app and locale-charset-info elements have parameter-encoding subelements, the subelement of sun-web-app takes precedence. For encodings, see http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html.

Superelements

locale-charset-info, sun-web-app (sun-web.xml)

Subelements

none

Attributes

The following table describes attributes for the parameter-encoding element.

pass-by-reference

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

The pass-by-reference element only applies to remote calls. As defined in the EJB 2.1 specification, section 5.4, calls to local interfaces use pass-by-reference semantics.

If the pass-by-reference element is set to its default value of false, the passing semantics for calls to remote interfaces comply with the EJB 2.1 specification, section 5.4. If set to true, remote calls involve pass-by-reference semantics instead of pass-by-value semantics, contrary to this specification.

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 true, parameters and return values should be considered read-only. The behavior of a program that modifies such parameters or return values is undefined.

When a servlet or enterprise bean calls a remote interface method in another bean that is colocated within the same process, by default the Enterprise 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.

Superelements

ejb (sun-ejb-jar.xml)

Subelements

none - contains data

password

Specifies the password for the principal.

Superelements

default-resource-principal (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

pm-descriptors

This element and its subelements are deprecated. Do not use.

Superelements

enterprise-beans (sun-ejb-jar.xml)

pool-idle-timeout-in-seconds

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

For a stateless session bean or a message-driven bean, the bean is removed (garbage collected) when the timeout expires.

This element is not implemented for GlassFish v3 Prelude.

Superelements

bean-pool (sun-ejb-jar.xml)

Subelements

none - contains data

port-component-name

Specifies a unique name for a port component within a web or EJB module.

Superelements

webservice-endpoint (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

port-info

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

Superelements

service-ref (sun-web.xml, sun-ejb-jar.xml)

Subelements

The following table describes subelements for the port-info element.

prefetch-disabled

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

This element is not implemented for GlassFish v3 Prelude.

Superelements

cmp (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the prefetch-disabled element.

principal

Defines a node that specifies a user name on the platform.

Superelements

ejb (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the principal element.

principal-name

Contains the principal (user) name.

In an enterprise bean, specifies the principal (user) name that has the run-as role specified.

Superelements

security-role-mapping (sun-web.xml, sun-ejb-jar.xml), servlet (sun-web.xml)

Subelements

none - contains data

Attributes

The following table describes attributes for the principal-name element.

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 Enterprise Server

• Needed by a system or object that Enterprise Server doesn’t have knowledge of, such as an LDAP server or a Java class

Superelements

cache, cache-helper, class-loader, cookie-properties, default-helper, manager-properties, session-properties, store-properties, sun-web-app, webservice-endpoint (sun-web.xml)

Subelements

The following table describes subelements for the property element.

Attributes

The following table describes attributes for the property element.

Example

<property name="reapIntervalSeconds" value="20" />

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 Enterprise Server

• Needed by a system or object that Enterprise Server doesn’t have knowledge of, such as an LDAP server or a Java class

Superelements

cmp-resource, schema-generator-properties, webservice-endpoint (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the property element.

Example

<property>
   <name>use-unique-table-names</name>
   <value>true</value>
</property>

Q

query-filter

Specifies the query filter for the CMP 1.1 finder.

This element is not implemented for GlassFish v3 Prelude.

Superelements

finder (sun-ejb-jar.xml)

Subelements

none - contains data

query-method

Specifies a query method.

This element is not implemented for GlassFish v3 Prelude.

Superelements

prefetch-disabled (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the query-method element.

query-ordering

Specifies the query ordering for the CMP 1.1 finder.

This element is not implemented for GlassFish v3 Prelude.

Superelements

finder (sun-ejb-jar.xml)

Subelements

none - contains data

query-params

Specifies the query parameters for the CMP 1.1 finder.

This element is not implemented for GlassFish v3 Prelude.

Superelements

finder (sun-ejb-jar.xml)

Subelements

none - contains data

query-variables

Specifies variables in the query expression for the CMP 1.1 finder.

This element is not implemented for GlassFish v3 Prelude.

Superelements

finder (sun-ejb-jar.xml)

Subelements

none - contains data

R

realm

Specifies 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 Sun GlassFish Enterprise Server v3 Prelude Developer’s Guide.

Superelements

as-context, login-config (sun-ejb-jar.xml)

Subelements

none - contains data

refresh-field

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

Superelements

cache-mapping (sun-web.xml)

Subelements

none

Attributes

The following table describes attributes for the refresh-field element.

refresh-period-in-seconds

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

Superelements

ejb (sun-ejb-jar.xml)

Subelements

none - contains data

removal-timeout-in-seconds

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

This element is not implemented for GlassFish v3 Prelude.

Superelements

bean-cache (sun-ejb-jar.xml)

Subelements

none - contains data

remote-home-impl

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

This value is automatically generated by the server at deployment or redeployment time. Do not specify it or change it after deployment.

This element is not implemented for GlassFish v3 Prelude.

Superelements

gen-classes (sun-ejb-jar.xml)

Subelements

none - contains data

remote-impl

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

This value is automatically generated by the server at deployment or redeployment time. Do not specify it or change it after deployment.

This element is not implemented for GlassFish v3 Prelude.

Superelements

gen-classes (sun-ejb-jar.xml)

Subelements

none - contains data

request-protection

Defines the authentication policy requirements of the application’s request processing.

This element is not implemented for GlassFish v3 Prelude.

Superelements

message-security (sun-web.xml, sun-ejb-jar.xml)

Subelements

none

Attributes

The following table describes attributes for the request-protection element.

required

Specifies whether the authentication method specified in the auth-method element must be used for client authentication. The value is true or false (the default).

Superelements

as-context (sun-ejb-jar.xml)

Subelements

none - contains data

res-ref-name

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

Superelements

resource-ref (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

resize-quantity

This element is not implemented for GlassFish v3 Prelude.

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

Superelements

bean-cache, bean-pool (sun-ejb-jar.xml)

Subelements

none - contains data

resource-adapter-mid

Specifies the module ID of the resource adapter that is responsible for delivering messages to the message-driven bean.

Superelements

mdb-resource-adapter (sun-ejb-jar.xml)

Subelements

none - contains data

resource-env-ref

Maps the res-ref-name in the corresponding Java EE deployment descriptor file resource-env-ref entry to the absolute jndi-name of a resource.

Superelements

sun-web-app (sun-web.xml), ejb (sun-ejb-jar.xml))

Subelements

The following table describes subelements for the resource-env-ref element.

Example

<resource-env-ref>
   <resource-env-ref-name>jms/StockQueueName</resource-env-ref-name>
   <jndi-name>jms/StockQueue</jndi-name>
</resource-env-ref>

resource-env-ref-name

Specifies the res-ref-name in the corresponding Java EE deployment descriptor file resource-env-ref entry.

Superelements

resource-env-ref (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

resource-ref

Maps the res-ref-name in the corresponding Java EE deployment descriptor file resource-ref entry to the absolute jndi-name of a resource.

Connections acquired from JMS connection factories are not shareable in the current release of the Enterprise Server. The res-sharing-scope element in the ejb-jar.xml file resource-ref element is ignored for JMS connection factories.

When resource-ref specifies a JMS connection factory for the Sun GlassFish Message Queue, the default-resource-principal (name/password) must exist in the Message Queue user repository.

Superelements

sun-web-app (sun-web.xml), ejb (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the resource-ref element.

Example

<resource-ref>
   <res-ref-name>jdbc/EmployeeDBName</res-ref-name>
   <jndi-name>jdbc/EmployeeDB</jndi-name>
</resource-ref>

response-protection

Defines the authentication policy requirements of the application’s response processing.

This element is not implemented for GlassFish v3 Prelude.

Superelements

message-security (sun-web.xml, sun-ejb-jar.xml)

Subelements

none

Attributes

The following table describes attributes for the response-protection element.

role-name

Contains the role-name in the security-role element of the corresponding Java EE deployment descriptor file.

Superelements

security-role-mapping (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

S

sas-context

Describes the sas-context fields.

Superelements

ior-security-config (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the sas-context element.

schema-generator-properties

Specifies field-specific column attributes in property subelements.

This element is not implemented for GlassFish v3 Prelude.

Superelements

cmp-resource (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the schema-generator-properties element.

Properties

The following table describes properties for the schema-generator-properties element.

The following table lists the column attributes for properties defined in the schema-generator-properties element.

Example

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

security-role-mapping

Maps roles to users or groups in the currently active realm. See Realm Configuration in Sun GlassFish Enterprise Server v3 Prelude Developer’s 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.

Superelements

sun-web-app (sun-web.xml), sun-ejb-jar (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the security-role-mapping element.

service-endpoint-interface

Specifies the web service reference name relative to java:comp/env.

Superelements

port-info (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

service-impl-class

Specifies the name of the generated service implementation class.

Superelements

service-ref (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

service-qname

Specifies the WSDL service element that is being referred to.

Superelements

service-ref (sun-web.xml, sun-ejb-jar.xml); webservice-endpoint (sun-web.xml, sun-ejb-jar.xml)

Subelements

The following table describes subelements for the service-qname element.

service-ref

Specifies 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

Superelements

sun-web-app (sun-web.xml), ejb (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the service-ref element.

service-ref-name

Specifies the web service reference name relative to java:comp/env.

Superelements

service-ref (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

servlet

Specifies a principal name for a servlet. Used for the run-as role defined in web-xml.

Superelements

sun-web-app (sun-web.xml)

Subelements

The following table describes subelements for the servlet element.

servlet-impl-class

Specifies the automatically generated name of the servlet implementation class.

Superelements

webservice-endpoint (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

servlet-name

Specifies the name of a servlet, which is matched to a servlet-name in web.xml. This name must be present in web.xml.

Superelements

cache-mapping, servlet (sun-web.xml)

Subelements

none - contains data

session-config

Specifies session configuration information. Overrides the web container settings for an individual web module.

Superelements

sun-web-app (sun-web.xml)

Subelements

The following table describes subelements for the session-config element.

session-manager

Specifies session manager information.

Superelements

session-config (sun-web.xml)

Subelements

The following table describes subelements for the session-manager element.

Attributes

The following table describes attributes for the session-manager element.

session-properties

Specifies session properties.

Superelements

session-config (sun-web.xml)

Subelements

The following table describes subelements for the session-properties element.

Properties

The following table describes properties for the session-properties element.

steady-pool-size

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

This element is not implemented for GlassFish v3 Prelude.

Superelements

bean-pool (sun-ejb-jar.xml)

Subelements

none - contains data

store-properties

Specifies session persistence (storage) properties.

Superelements

session-manager (sun-web.xml)

Subelements

The following table describes subelements for the store-properties element.

Properties

The following table describes properties for the store-properties element.

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-property

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

Superelements

port-info (sun-web.xml, sun-ejb-jar.xml)

Subelements

The following table describes subelements for the stub-property element.

Properties

The following table describes properties for the stub-property element.

Example

<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-ejb-jar

Defines the Enterprise Server specific configuration for an EJB JAR file. This is the root element; there can only be one sun-ejb-jar element in a sun-ejb-jar.xml file. See The sun-ejb-jar.xml File.

Superelements

none

Subelements

The following table describes subelements for the sun-ejb-jar element.

sun-web-app

Defines Enterprise Server specific configuration for a web module. This is the root element; there can only be one sun-web-app element in a sun-web.xml file. See The sun-web.xml File.

Superelements

none

Subelements

The following table describes subelements for the sun-web-app element.

Attributes

The following table describes attributes for the sun-web-app element.

Properties

The following table describes properties for the sun-web-app element.

Property	Default	Description
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 virtual-server in Sun GlassFish Enterprise Server v3 Prelude Administration Reference. 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 virtual-server in Sun GlassFish Enterprise Server v3 Prelude Administration Reference.
valve_n	none	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 Enterprise Server releases, or the org.glassfish.web.valve.GlassFishValve interface from the current Enterprise 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 virtual-server in Sun GlassFish Enterprise Server v3 Prelude Administration Reference.
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 virtual-server in Sun GlassFish Enterprise Server v3 Prelude Administration Reference.
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 virtual-server in Sun GlassFish Enterprise Server v3 Prelude Administration Reference.
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).

T

tie-class

Specifies the automatically generated name of a tie implementation class for a port component.

Superelements

webservice-endpoint (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

timeout

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

Superelements

cache-mapping (sun-web.xml)

Subelements

none - contains data

Attributes

The following table describes attributes for the timeout element.

transport-config

Specifies the security transport information.

Superelements

ior-security-config (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the transport-config element.

transport-guarantee

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

Superelements

webservice-endpoint (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

U

unique-id

Contains the unique ID for the application. This value is automatically updated each time the application is deployed or redeployed. Do not edit this value.

Superelements

enterprise-beans (sun-ejb-jar.xml)

Subelements

none - contains data

url-pattern

Specifies a servlet URL pattern for which caching is enabled. See the Servlet 2.4 specification section SRV. 11.2 for applicable patterns.

Superelements

cache-mapping (sun-web.xml)

Subelements

none - contains data

use-thread-pool-id

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

This element is not implemented for GlassFish v3 Prelude.

Superelements

ejb (sun-ejb-jar.xml)

Subelements

none - contains data

V

value

Specifies the value of the entity.

Superelements

call-property, stub-property (sun-web.xml, sun-ejb-jar.xml); property (with subelements) (sun-ejb-jar.xml)

Subelements

none - contains data

victim-selection-policy

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

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.

This element is not implemented for GlassFish v3 Prelude.

Superelements

bean-cache (sun-ejb-jar.xml)

Subelements

none - contains data

Example

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

W

webservice-description

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

Superelements

sun-web-app (sun-web.xml), enterprise-beans (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the webservice-description element.

webservice-description-name

Specifies a unique name for the web service within a web or EJB module.

Superelements

webservice-description (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

webservice-endpoint

Specifies information about a web service endpoint.

Superelements

servlet (sun-web.xml), ejb (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the webservice-endpoint element.

wsdl-override

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

Superelements

service-ref (sun-web.xml, sun-ejb-jar.xml)

Subelements

none - contains data

Example

// available via HTTP
<wsdl-override>http://localhost:8000/myservice/myport?WSDL</wsdl-override>

// in a file
<wsdl-override>file:/home/user1/myfinalwsdl.wsdl</wsdl-override>

wsdl-port

Specifies the WSDL port.

Superelements

port-info (sun-web.xml, sun-ejb-jar.xml)

Subelements

The following table describes subelements for the wsdl-port element.

wsdl-publish-location

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

Superelements

webservice-description (sun-web.xml, sun-ejb-jar.xml)