JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle GlassFish Server 3.1 Application Deployment Guide
search filter icon
search icon

Document Information

Preface

1.  Overview of Oracle GlassFish Server 3.1 Application Deployment

2.  Deploying Applications

A.  The asadmin Deployment Subcommands

B.  GlassFish Server Deployment Descriptor Files

C.  Elements of the GlassFish Server Deployment Descriptors

activation-config

Superelements

Subelements

activation-config-property

Superelements

Subelements

activation-config-property-name

Superelements

Subelements

activation-config-property-value

Superelements

Subelements

admin-object-resource

Superelements

Subelements

Attributes

Properties

as-context

Superelements

Subelements

archive-name

Superelements

Subelements

auth-method

Superelements

Subelements

auth-realm

Superelements

Subelements

Attributes

Example

backend-principal

Superelements

Subelements

Attributes

bean-cache

Superelements

Subelements

Example

bean-pool

Superelements

Subelements

Example

cache

Superelements

Subelements

Attributes

Properties

Cache Class Names

cache-helper

Superelements

Subelements

Attributes

cache-helper-ref

Superelements

Subelements

cache-idle-timeout-in-seconds

Superelements

Subelements

cache-mapping

Superelements

Subelements

call-property

Superelements

Subelements

caller-propagation

Superelements

Subelements

cert-db

Superelements

Subelements

Attributes

check-all-at-commit

Superelements

check-modified-at-commit

Superelements

Subelements

check-version-of-accessed-instances

Superelements

Subelements

checkpoint-at-end-of-method

Superelements

Subelements

checkpointed-methods

Superelements

class-loader

Superelements

Subelements

Attributes

Properties

client-container

Superelements

Subelements

Attributes

Properties

client-credential

Superelements

Subelements

Attributes

cmp

Superelements

Subelements

cmp-field-mapping

Superelements

Subelements

cmp-resource

Superelements

Subelements

cmr-field-mapping

Superelements

Subelements

cmr-field-name

Superelements

Subelements

cmt-timeout-in-seconds

Superelements

Subelements

column-name

Superelements

Subelements

column-pair

Superelements

Subelements

commit-option

Superelements

Subelements

compatibility

Superelements

Subelements

confidentiality

Superelements

Subelements

connector-connection-pool

Superelements

Subelements

Attributes

Properties

connector-resource

Superelements

Subelements

Attributes

consistency

Superelements

Subelements

constraint-field

Superelements

Subelements

Attributes

constraint-field-value

Superelements

Subelements

Attributes

context-root

Superelements

Subelements

cookie-properties

Superelements

Subelements

Properties

create-tables-at-deploy

Superelements

Subelements

custom-resource

Superelements

Subelements

Attributes

database-vendor-name

Superelements

Subelements

debugging-enabled

Superelements

Subelements

default

Superelements

Subelements

default-helper

Superelements

Subelements

Properties

default-resource-principal

Superelements

Subelements

description

Superelements

Subelements

disable-nonportable-jndi-names

Superelements

Subelements

dispatcher

Superelements

Subelements

drop-tables-at-undeploy

Superelements

Subelements

ejb

Superelements

Subelements

Attributes

Example

ejb-name

Superelements

Subelements

ejb-ref

Superelements

Subelements

ejb-ref-name

Superelements

Subelements

eligible

Superelements

Subelements

endpoint-address-uri

Superelements

Subelements

Example

enterprise-beans

Superelements

Subelements

Example

entity-mapping

Superelements

Subelements

establish-trust-in-client

Superelements

Subelements

establish-trust-in-target

Superelements

Subelements

external-jndi-resource

Superelements

Subelements

Attributes

fetched-with

Superelements

Subelements

field-name

Superelements

Subelements

finder

Superelements

Subelements

flush-at-end-of-method

Superelements

Subelements

gen-classes

Superelements

Subelements

glassfish-application

Superelements

Subelements

glassfish-application-client

Superelements

Subelements

glassfish-ejb-jar

Superelements

Subelements

glassfish-web-app

Superelements

Subelements

Attributes

Properties

group-map

Superelements

Subelements

Attributes

group-name

Superelements

Subelements

http-method

Superelements

Subelements

idempotent-url-pattern

Superelements

Subelements

Attributes

Example

integrity

Superelements

Subelements

ior-security-config

Superelements

Subelements

is-cache-overflow-allowed

Superelements

is-one-one-cmp

Superelements

is-read-only-bean

Superelements

Subelements

java-method

Superelements

Subelements

java-web-start-access

Superelements

Subelements

jdbc-connection-pool

Superelements

Subelements

Attributes

GlassFish Server Properties

Database Properties

jdbc-resource

Superelements

Subelements

Attributes

jms-durable-subscription-name

Superelements

Subelements

jms-max-messages-load

Superelements

Subelements

jndi-name

Superelements

Subelements

jnlp-doc

Superelements

Subelements

jsp-config

Superelements

Subelements

Properties

keep-state

Superelements

Subelements

key-field

Superelements

Subelements

Attributes

level

Superelements

Subelements

local-home-impl

Superelements

Subelements

local-impl

Superelements

Subelements

locale-charset-info

Superelements

Subelements

Attributes

locale-charset-map

Superelements

Subelements

Attributes

Example Agents

localpart

Superelements

Subelements

lock-when-loaded

Superelements

Subelements

lock-when-modified

Superelements

log-service

Superelements

Subelements

Attributes

login-config

Superelements

Subelements

mail-resource

Superelements

Subelements

Attributes

Properties

manager-properties

Superelements

Subelements

Properties

mapping-properties

Superelements

max-cache-size

Superelements

Subelements

max-pool-size

Superelements

Subelements

max-wait-time-in-millis

Superelements

mdb-connection-factory

Superelements

Subelements

mdb-resource-adapter

Superelements

Subelements

message

Superelements

Subelements

message-destination

Superelements

Subelements

message-destination-name

Superelements

Subelements

message-destination-ref

Superelements

Subelements

message-destination-ref-name

Superelements

Subelements

message-security

Superelements

Subelements

message-security-binding

Superelements

Subelements

Attributes

message-security-config

Superelements

Subelements

Attributes

method

Superelements

Subelements

method-intf

Superelements

Subelements

method-name

Superelements

Subelements

Examples

method-param

Superelements

Subelements

method-params

Superelements

Subelements

name

Superelements

Subelements

named-group

Superelements

Subelements

namespaceURI

Superelements

Subelements

none

Superelements

Subelements

one-one-finders

Superelements

Subelements

operation-name

Superelements

Subelements

parameter-encoding

Superelements

Subelements

Attributes

pass-by-reference

Superelements

Subelements

password

Superelements

Subelements

per-request-load-balancing

Superelements

Subelements

pm-descriptors

Superelements

pool-idle-timeout-in-seconds

Superelements

Subelements

port-component-name

Superelements

Subelements

port-info

Superelements

Subelements

prefetch-disabled

Superelements

Subelements

principal

Superelements

Subelements

principal-map

Superelements

Subelements

Attributes

principal-name

Superelements

Subelements

Attributes

property (with attributes)

Superelements

Subelements

Attributes

Example

property (with subelements)

Superelements

Subelements

Example

provider-config

Superelements

Subelements

Attributes

query-filter

Superelements

Subelements

query-method

Superelements

Subelements

query-ordering

Superelements

Subelements

query-params

Superelements

Subelements

query-variables

Superelements

Subelements

read-only

Superelements

Subelements

realm

Superelements

Subelements

refresh-field

Superelements

Subelements

Attributes

refresh-period-in-seconds

Superelements

Subelements

removal-timeout-in-seconds

Superelements

Subelements

remote-home-impl

Superelements

Subelements

remote-impl

Superelements

Subelements

request-policy

Superelements

Subelements

Attributes

request-protection

Superelements

Subelements

Attributes

required

Superelements

Subelements

res-ref-name

Superelements

Subelements

resize-quantity

Superelements

Subelements

resource-adapter-config

Superelements

Subelements

Attributes

Properties

resource-adapter-mid

Superelements

Subelements

resource-env-ref

Superelements

Subelements

Example

resource-env-ref-name

Superelements

Subelements

resource-ref

Superelements

Subelements

Example

resources

Superelements

Subelements

response-policy

Superelements

Subelements

Attributes

response-protection

Superelements

Subelements

Attributes

role-name

Superelements

Subelements

sas-context

Superelements

Subelements

schema

Superelements

Subelements

Examples

schema-generator-properties

Superelements

Subelements

Properties

Example

secondary-table

Superelements

Subelements

security

Superelements

Subelements

security-map

Superelements

Subelements

Attributes

security-role-mapping

Superelements

Subelements

service-endpoint-interface

Superelements

Subelements

service-impl-class

Superelements

Subelements

service-qname

Superelements

Subelements

service-ref

Superelements

Subelements

service-ref-name

Superelements

Subelements

servlet

Superelements

Subelements

servlet-impl-class

Superelements

Subelements

servlet-name

Superelements

Subelements

session-config

Superelements

Subelements

session-manager

Superelements

Subelements

Attributes

session-properties

Superelements

Subelements

Properties

ssl

Superelements

Subelements

Attributes

steady-pool-size

Superelements

Subelements

store-properties

Superelements

Subelements

Properties

stub-property

Superelements

Subelements

Properties

Example

sun-cmp-mapping

Superelements

Subelements

sun-cmp-mappings

Superelements

Subelements

table-name

Superelements

Subelements

target-server

Superelements

Subelements

Attributes

tie-class

Superelements

Subelements

timeout

Superelements

Subelements

Attributes

transport-config

Superelements

Subelements

transport-guarantee

Superelements

Subelements

unique-id

Superelements

Subelements

url-pattern

Superelements

Subelements

user-group

Superelements

Subelements

use-thread-pool-id

Superelements

Subelements

value

Superelements

Subelements

valve

Superelements

Subelements

Attributes

Example

vendor

Superelements

Subelements

version-identifier

Superelements

Subelements

victim-selection-policy

Superelements

Subelements

Example

web

Superelements

Subelements

web-uri

Superelements

Subelements

webservice-description

Superelements

Subelements

webservice-description-name

Superelements

Subelements

webservice-endpoint

Superelements

Subelements

work-security-map

Superelements

Subelements

Attributes

wsdl-override

Superelements

Subelements

Example

wsdl-port

Superelements

Subelements

wsdl-publish-location

Superelements

Subelements

Example

Index

jsp-config

Specifies JSP configuration information.

Superelements

glassfish-web-app (glassfish-web.xml)

Subelements

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

Table C-79 jsp-config Subelements

Element
Required
Description
zero or more
Specifies a property, which has a name and a value.

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:

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

Table C-80 jsp-config Properties

Property
Default
Description
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
If set to true, instructs the compiler to ignore any JSP precompilation errors pertaining to statically included JSP segments that, despite not being top level JSP files, use the .jsp or .jspx extension (instead of the recommended .jspf).
initialCapacity
32
Specifies the initial capacity of the HashMap that maps JSP files to their corresponding servlets.
javaEncoding
UTF8
Specifies the encoding for the generated Java servlet. This encoding is passed to the Java compiler that is used to compile the servlet as well. By default, the web container tries to use UTF8. If that fails, it tries to use the javaEncoding value.

For encodings, see:

http://download.oracle.com/javase/6/docs/technotes/guides/intl/encoding.doc.html

keepgenerated
true with JDK 5 and before and for jspc, otherwise false
If set to true, keeps the generated Java files. If false, deletes the Java files.
mappedfile
true
If set to true, generates static content with one print statement per input line, to ease debugging.
modificationTestInterval
0
Specifies the frequency in seconds at which JSPs are checked for modification. A value of 0 causes the JSP to be checked on every access. Used only if development is set to true.
reload-interval
0
Specifies the frequency in seconds at which JSP files are checked for modifications. Setting this value to 0 checks JSP files for modifications on every request. Setting this value to -1 disables checks for JSP modifications and JSP recompilation.
saveBytecode
true for jspc, otherwise false
If true, generated byte code is saved to .class files? This option is meaningful only when the Java compiler API, JSR 199 (available with and used as the default on Java 6) is used for javac compilations.
scratchdir
The default work directory for the web application
Specifies the working directory created for storing all the generated code.
suppressSmap
false
If set to true, generation of SMAP information for JSR 45 debugging is suppressed.
trimSpaces
false
If set to true, trims white spaces in template text between actions or directives.
usePrecompiled
false
If set to true, an accessed JSP file is not compiled. Its precompiled servlet class is used instead.

It is assumed that JSP files have been precompiled, and their corresponding servlet classes have been bundled in the web application’s WEB-INF/lib or WEB-INF/classes directory.

xpoweredBy
true
If set to true, the X-Powered-By response header is added by the generated servlet.