Servlet property names
begin with com.sybase.jaguar.servlet.
Servlet properties apply to servlet entities defined in the EAServer
installed servlets folder (com.sybase.jaguar.server.servlets property),
as well as to servlets and JSPs installed in a Web application (com.sybase.jaguar.webapplication.webcomponents property).
Enables and disables servlet response caching.
To enable caching:
CtsComponents/PageCache
No value means caching is disabled.
Specifies whether to cache all the pages or files that are invoked by a Web component.
true or false.
The default is false, which
means that a page is cached only when a client requests it directly.
Chapter 5, “Web Application Tuning,” in the EAServer Performance and Tuning Guide.
When response caching is enabled, specifies whether to include the accept-languages header in the cache key.
true or false.
The default is false.
com.sybase.jaguar.servlet.cache
When response caching is enabled, specifies message service topic names used to synchronize the cache with an external storage mechanism such as a database.
A comma-separated list of topic names.
com.sybase.jaguar.servlet.cache
When response caching is enabled, specifies request headers to include in the cache key.
A comma-separated list of request headers. For example, if
you include date, EAServer
looks for cache entries whose date headers match the request’s
date header.
com.sybase.jaguar.servlet.cache
When response caching is enabled, specifies request parameters to include in the cache key.
A comma-separated list of parameter names, or “*” to include all of them.
com.sybase.jaguar.servlet.cache
When response caching is enabled, specifies session attributes to include in the cache key.
A comma-separated list of attribute names, or “*” to include all of them.
com.sybase.jaguar.servlet.cache
When response caching is enabled, specifies the cache timeout value.
The timeout value in seconds. A value of 0 indicates infinity.
com.sybase.jaguar.servlet.cache
When response caching is enabled, specifies whether to include the session ID in the cache key.
true or false.
The default is false.
com.sybase.jaguar.servlet.cache
An optional description of the servlet or JSP.
The descriptive text.
Overrides the server or Web application servlet destroy timeout setting for this servlet.
Same as the server property com.sybase.jaguar.server.servlet.destroy-wait-time. For servlets installed in a Web application, the default is the value of the Web application property com.sybase.jaguar.webapplication.destroy-wait-time. For servlets installed directly in the server, the default is the value of the server property com.sybase.jaguar.server.servlet.destroy-wait-time.
com.sybase.jaguar.servlet.init.timeout, com.sybase.jaguar.server.servlet.destroy-wait-time, com.sybase.jaguar.webapplication.destroy-wait-time
Specifies additional files to be included if this servlet is archived or replicated to another installation using the synchronize feature.
Same as for the com.sybase.jaguar.applicationclient.files component property.
com.sybase.jaguar.component.files, com.sybase.jaguar.webapplication.files
Specifies initialization parameters for the servlet.
Same as for the com.sybase.jaguar.filter.init-param filter property.
com.sybase.jaguar.filter.init-param
Specifies how long the server should wait for the servlet’s init method to return.
A value from Table B-21. If this property is not set for a servlet in a Web application, the default is the value of the Web application property com.sybase.jaguar.webapplication.init-timeout. For servlets installed directly in the server, the default is the value of the server property com.sybase.jaguar.server.servlet.init-timeout.
Value |
To indicate |
|---|---|
-1 |
(The server or Web application default.) init can run indefinitely, unless the server is shutdown or refreshed. If the init method is still running when the server is shutdown or refreshed, the server does not wait for init to complete before shutting down or refreshing the servlet. |
0 |
init can run indefinitely. Sybase does not recommend this setting, because deadlocks or other hangs in the init method can cause the server to hang when shutting down or refreshing the servlet. |
A positive integer. |
The number of seconds to wait for init to return. If the init method is still running when the server is shutdown or refreshed, the server waits the specified time for init to return. |
com.sybase.jaguar.server.servlet.init-timeout, com.sybase.jaguar.webapplication.init-timeout
Enables the servlet Java cache mechanism for this servlet or JSP.
true or false.
The default is false. A value
of true enables the Java cache. If
both page caching and Java caching are enabled, Java caching is
used. (The com.sybase.jaguar.servlet.cache property enables page
caching.)
When enabled, this feature allows caching of servlet output in Java core memory, which offers a faster response than page caching for servlets that can run under these limitations:
The output does not change during the cache timeout period, and does not depend on request method, parameters, or headers.
The servlet runs with exact path mappings. Responses are not cached if the servlet uses prefix mappings, default mappings, or extension mappings.
Cached content is returned without modification.
Cached response headers are returned without modification, except for:
The Set-Cookie header, which depends on the com.sybase.jaguar.servlet.javacache.session property.
The Connection header, which depends on the request Connection header.
Return code 200 is used for all cached replies. If the original response uses any other return code, it is not cached.
Chunked replies are not cached.
Only responses to GET requests are cached.
Servlets that cannot run under these limitations can still use page caching, enabled by setting com.sybase.jaguar.servlet.cache.
com.sybase.jaguar.servlet.cache, com.sybase.jaguar.servlet.javacache.maxsize, com.sybase.jaguar.servlet.javacache.session, com.sybase.jaguar.servlet.javacache.timeout
When using the Java cache mechanism, specifies the size, in kilobytes, of the largest reply that can be cached. Responses larger than this are not cached.
The default is 8. The hard upper limit is 100. If you set a value greater than 100, the effective cache size is 100K.
com.sybase.jaguar.servlet.javacache.enabled, com.sybase.jaguar.servlet.javacache.session, com.sybase.jaguar.servlet.javacache.timeout
When using the Java cache mechanism, specifies how session cookie settings are treated in response headers when using the Java cache mechanism.
Allowable values are:
Value |
To indicate |
|---|---|
|
No session support. EAServer does not check request Set-Cookie headers or return response Set-Cookie headers. |
|
Attempt to preserve valid sessions. If the request includes a session identifier, EAServer checks if the session is valid. If it is not, the response Set-Cookie header is set to indicate an invalid session. Otherwise, no Set-Cookie header is returned. |
|
Preserve valid session and create a new session if the previous session is invalid. If the request includes a session identifier, EAServer checks if the session is valid. If it is not, the response Set-Cookie header is set to indicate a new session. Otherwise, no Set-Cookie header is returned. |
com.sybase.jaguar.servlet.javacache.enabled, com.sybase.jaguar.servlet.javacache.maxsize, com.sybase.jaguar.servlet.javacache.timeout
When using the Java cache mechanism, specifies the time, in seconds, that cached responses remain valid.
The timeout value in seconds. The default is 60. A negative value specifies an infinite timeout, that is, cached responses do not expire.
com.sybase.jaguar.servlet.javacache.enabled, com.sybase.jaguar.servlet.javacache.maxsize, com.sybase.jaguar.servlet.javacache.session
Specifies the servlet implementation class.
The Java class name, for example:
com.acme.SearchServlet
com.sybase.jaguar.servlet.java.classes
Specifies additional classes to be reloaded when the servlet is refreshed.
Same as for the com.sybase.jaguar.application.java.classes component property.
If configuring servlets or JSPs that are installed in a Web application, see “Custom class lists for Web applications” in Chapter 30, “Configuring Custom Java Class Lists,” in the EAServer Programmer’s Guide.
If configuring servlets installed directly in the server’s Installed Servlets folder, see “Custom class lists for servlets installed directly in the server” in Chapter 30, “Configuring Custom Java Class Lists,” in the EAServer Programmer’s Guide.
com.sybase.jaguar.servlet.java.class, com.sybase.jaguar.webapplication.java.classes
Specifies additional JAR files and directories to include in the JSP compiler class path.
Same as for com.sybase.jaguar.webapplication.jsp.compile-extra-cp
Applies to JSPs only. Specifies whether the EAServer process CLASSPATH should be included in the compilation class path when compiling this JSP.
true or false.
The default of true indicates
that the server class path should be included. Set this property
to false to exclude entries
from the EAServer process CLASSPATH setting in the JSP compiler
class path.
com.sybase.jaguar.webapplication.jsp.compile-use-eas-cp
Applies to JSPs only. Specifies whether JAR files in the EAServer java/lib directory are automatically be included in the class path when compiling this JSP.
true or false.
If this property is true, all
JAR files in this directory are included. The default is false.
This property is ignored if the com.sybase.jaguar.webapplication.jsp.compile-use-eas-cp property is set to true for
the Web application or the com.sybase.jaguar.servlet.jsp.compile-use-eas-cp is set to true for
the JSP.
com.sybase.jaguar.webapplication.jsp.compile-use-third-party
If this servlet is generated from a JSP file, specifies the .jsp file name.
The file name, including the path relative to the Web application’s context root directory. For example:
annotation/annotated_account.jsp
com.sybase.jaguar.servlet.servletorjsp
Specifies the name of the large icon file associated with the servlet. This property is not used in EAServer, but accommodated to comply with the Servlet 2.3 Web archive descriptor.
A file name.
Specifies whether the servlet is loaded at server start-up time, or after the first client request.
Value |
To specify |
|---|---|
No value. |
The servlet is not loaded at start-up. |
0 |
Load at start-up, with unspecified position relative to other servlets loaded at start-up. |
A positive integer. |
Load at start-up, with specified position relative to other servlets loaded at start-up. |
The servlet name.
For a servlet in a Web application:
web-app/servlet
For a servlet not in a Web application:
servlet
Where servlet is the servlet name as displayed in EAServer Manager, and web-app is the Web application name.
Specifies the run-as identity used for component calls. If this property is not set, intercomponent calls use the client identity.
(specified=id,role=role-name,desc=desc)
where:
Variable |
Specifies |
|---|---|
id |
A logical identity name which must be
mapped to an EAServer identity by setting a corresponding package
property, com.sybase.jaguar.webapplication.runasidentity.<id> where |
role-name |
A logical role name which must be mapped
to an EAServer role by setting a corresponding Web application property, com.sybase.jaguar.webapplication.security-role.<j2ee-role> where The mapped EAServer identity should be in the mapped EAServer role. |
desc |
An optional description of the run-as authorization requirement. The description can help users when the Web application is deployed to another server, and the deployer must choose a different identity mapping. |
com.sybase.jaguar.webapplication.runasidentity.<id>, com.sybase.jaguar.webapplication.security-role.<j2ee-role>, com.sybase.jaguar.application.security-role.<j2ee-role>
Specifies whether this servlet is generated from a JSP.
Value |
To indicate |
|---|---|
|
A servlet |
|
A JSP |
com.sybase.jaguar.servlet.jsp-file
For servlets not in a Web application, specifies whether the servlet can use sessions.
true or false.
The default is false.
For Web application servlets, sessions are always enabled.
For servlets not in a Web application, specifies the session timeout.
The timeout value in seconds. A value of 0 indicates infinity.
For Web application servlets, the Web application com.sybase.jaguar.webapplication.session-config property specifies the session timeout value.
com.sybase.jaguar.webapplication.session-config
Specifies whether an instance of the servlet class can be run simultaneously on multiple threads.
true or false.
The default is false.
com.sybase.jaguar.servlet.singlethread.poolsize
If the servlet is single-threaded, specifies the number of threads to run the servlet on. More threads may decrease the average client response time by eliminating the need to serialize requests.
A positive integer, or 0 to indicate no limit. The default is 1.
com.sybase.jaguar.servlet.singlethread
Specifies the name of the small icon file associated with the servlet. This property is not used in EAServer, but accommodated to comply with the Servlet 2.3 Web archive descriptor.
A file name.
