Sun Java System Application Server Platform Edition 9 Application Deployment Guide

J

java-method

Specifies a method.

Superelements

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

Subelements

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

Table A–50 java-method Subelements

Element 

Required 

Description 

method-name

only one 

Specifies a method name. 

method-params

zero or one 

Specifies fully qualified Java type names of method parameters. 

java-web-start-access

Specifies changes to default Java Web Start parameters for an embedded or stand-alone application client module.

Superelements

sun-application-client (sun-application-client.xml)

Subelements

The following table describes subelements for the java-web-start-access element.

Table A–51 java-web-start-access subelements

Element 

Required 

Description 

context-root

zero or one 

Contains the context root for the Java Web Start enabled application client module. If none is specified, a default is generated. 

The default for an application is as follows: 


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

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


http://host:port/module-name

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

eligible

zero or one 

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

vendor

zero or one 

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

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. For more information about JMS resources, see Chapter 18, Using the Java Message Service, in Sun Java System Application Server Platform Edition 9 Developer’s Guide.

Superelements

ejb-ref, message-destination, resource-env-ref, resource-ref (sun-web.xml, sun-ejb-jar.xml, sun-application-client.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.

Table A–52 jsp-config Subelements

Element 

Required 

Description 

property (with attributes)

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 A–53 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 the Application 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://java.sun.com/j2se/1.5.0/docs/tooldocs/solaris/javac.html#options.

compilerTargetVM

Depends on the Application Server's Java runtime 

Specifies the JVM version for which the servlet class files are generated. Same as the -target release option of javac.

For more information, see http://java.sun.com/j2se/1.5.0/docs/tooldocs/solaris/javac.html#options.

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 separate from the one in which Tomcat is running. 

genStrAsCharArray

false

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

ieClassId

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

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

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

keepgenerated

true

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.

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.