Server properties  Thread monitor properties

Appendix B: Repository Properties Reference

Servlet properties

Description

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




com.sybase.jaguar.servlet.cache

Description

Enables and disables servlet response caching.

Syntax

To enable caching:

CtsComponents/PageCache

No value means caching is disabled.




com.sybase.jaguar.servlet.cache.entire-tree

Description

Specifies whether to cache all the pages or files that are invoked by a Web component.

Syntax

true or false. The default is false, which means that a page is cached only when a client requests it directly.

See also

Chapter 5, “Web Application Tuning,” in the EAServer Performance and Tuning Guide.




com.sybase.jaguar.servlet.cache.locale-sensitive

Description

When response caching is enabled, specifies whether to include the accept-languages header in the cache key.

Syntax

true or false. The default is false.

See also

com.sybase.jaguar.servlet.cache




com.sybase.jaguar.servlet.cache.message-topics

Description

When response caching is enabled, specifies message service topic names used to synchronize the cache with an external storage mechanism such as a database.

Syntax

A comma-separated list of topic names.

See also

com.sybase.jaguar.servlet.cache




com.sybase.jaguar.servlet.cache.request-headers

Description

When response caching is enabled, specifies request headers to include in the cache key.

Syntax

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.

See also

com.sybase.jaguar.servlet.cache




com.sybase.jaguar.servlet.cache.request-parameters

Description

When response caching is enabled, specifies request parameters to include in the cache key.

Syntax

A comma-separated list of parameter names, or “*” to include all of them.

See also

com.sybase.jaguar.servlet.cache




com.sybase.jaguar.servlet.cache.session-attributes

Description

When response caching is enabled, specifies session attributes to include in the cache key.

Syntax

A comma-separated list of attribute names, or “*” to include all of them.

See also

com.sybase.jaguar.servlet.cache




com.sybase.jaguar.servlet.cache.timeout

Description

When response caching is enabled, specifies the cache timeout value.

Syntax

The timeout value in seconds. A value of 0 indicates infinity.

See also

com.sybase.jaguar.servlet.cache




com.sybase.jaguar.servlet.cache.use-sessionid

Description

When response caching is enabled, specifies whether to include the session ID in the cache key.

Syntax

true or false. The default is false.

See also

com.sybase.jaguar.servlet.cache




com.sybase.jaguar.servlet.description

Description

An optional description of the servlet or JSP.

Syntax

The descriptive text.




com.sybase.jaguar.servlet.destroy.wait-time

Description

Overrides the server or Web application servlet destroy timeout setting for this servlet.

Syntax

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.

See also

com.sybase.jaguar.servlet.init.timeout, com.sybase.jaguar.server.servlet.destroy-wait-time, com.sybase.jaguar.webapplication.destroy-wait-time




com.sybase.jaguar.servlet.files

Description

Specifies additional files to be included if this servlet is archived or replicated to another installation using the synchronize feature.

Syntax

Same as for the com.sybase.jaguar.applicationclient.files component property.

See also

com.sybase.jaguar.component.files, com.sybase.jaguar.webapplication.files




com.sybase.jaguar.servlet.init-param

Description

Specifies initialization parameters for the servlet.

Syntax

Same as for the com.sybase.jaguar.filter.init-param filter property.

See also

com.sybase.jaguar.filter.init-param




com.sybase.jaguar.servlet.init.timeout

Description

Specifies how long the server should wait for the servlet’s init method to return.

Syntax

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.

Table B-21: Initialization timeout values

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.

See also

com.sybase.jaguar.server.servlet.init-timeout, com.sybase.jaguar.webapplication.init-timeout




com.sybase.jaguar.servlet.javacache.enabled

Description

Enables the servlet Java cache mechanism for this servlet or JSP.

Syntax

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

Usage

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:

Servlets that cannot run under these limitations can still use page caching, enabled by setting com.sybase.jaguar.servlet.cache.

See also

com.sybase.jaguar.servlet.cache, com.sybase.jaguar.servlet.javacache.maxsize, com.sybase.jaguar.servlet.javacache.session, com.sybase.jaguar.servlet.javacache.timeout




com.sybase.jaguar.servlet.javacache.maxsize

Description

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.

Syntax

The default is 8. The hard upper limit is 100. If you set a value greater than 100, the effective cache size is 100K.

See also

com.sybase.jaguar.servlet.javacache.enabled, com.sybase.jaguar.servlet.javacache.session, com.sybase.jaguar.servlet.javacache.timeout




com.sybase.jaguar.servlet.javacache.session

Description

When using the Java cache mechanism, specifies how session cookie settings are treated in response headers when using the Java cache mechanism.

Syntax

Allowable values are:

Value

To indicate

no (the default)

No session support. EAServer does not check request Set-Cookie headers or return response Set-Cookie headers.

keep

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.

create

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.

See also

com.sybase.jaguar.servlet.javacache.enabled, com.sybase.jaguar.servlet.javacache.maxsize, com.sybase.jaguar.servlet.javacache.timeout




com.sybase.jaguar.servlet.javacache.timeout

Description

When using the Java cache mechanism, specifies the time, in seconds, that cached responses remain valid.

Syntax

The timeout value in seconds. The default is 60. A negative value specifies an infinite timeout, that is, cached responses do not expire.

See also

com.sybase.jaguar.servlet.javacache.enabled, com.sybase.jaguar.servlet.javacache.maxsize, com.sybase.jaguar.servlet.javacache.session




com.sybase.jaguar.servlet.java.class

Description

Specifies the servlet implementation class.

Syntax

The Java class name, for example:

com.acme.SearchServlet

See also

com.sybase.jaguar.servlet.java.classes




com.sybase.jaguar.servlet.java.classes

Description

Specifies additional classes to be reloaded when the servlet is refreshed.

Syntax

Same as for the com.sybase.jaguar.application.java.classes component property.

Usage

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.

See also

com.sybase.jaguar.servlet.java.class, com.sybase.jaguar.webapplication.java.classes




com.sybase.jaguar.servlet.jsp.compile-extra-cp

Description

Specifies additional JAR files and directories to include in the JSP compiler class path.

Syntax

Same as for com.sybase.jaguar.webapplication.jsp.compile-extra-cp




com.sybase.jaguar.servlet.jsp.compile-use-eas-cp

Description

Applies to JSPs only. Specifies whether the EAServer process CLASSPATH should be included in the compilation class path when compiling this JSP.

Syntax

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.

See also

com.sybase.jaguar.webapplication.jsp.compile-use-eas-cp




com.sybase.jaguar.servlet.jsp.compile-use-third-party

Description

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.

Syntax

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.

See also

com.sybase.jaguar.webapplication.jsp.compile-use-third-party




com.sybase.jaguar.servlet.jsp-file

Description

If this servlet is generated from a JSP file, specifies the .jsp file name.

Syntax

The file name, including the path relative to the Web application’s context root directory. For example:

annotation/annotated_account.jsp

See also

com.sybase.jaguar.servlet.servletorjsp




com.sybase.jaguar.servlet.large-icon

Description

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.

Syntax

A file name.




com.sybase.jaguar.servlet.load-on-startup

Description

Specifies whether the servlet is loaded at server start-up time, or after the first client request.

Syntax

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.




com.sybase.jaguar.servlet.name

Description

The servlet name.

Syntax

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.




com.sybase.jaguar.servlet.security.runasidentity

Description

Specifies the run-as identity used for component calls. If this property is not set, intercomponent calls use the client identity.

Syntax

(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 <id> is the logical identity name.

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 <j2ee-role> is the logical role name. The mapping can also be established by setting the application property com.sybase.jaguar.application.security-role.<j2ee-role>.

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.

See also

com.sybase.jaguar.webapplication.runasidentity.<id>, com.sybase.jaguar.webapplication.security-role.<j2ee-role>, com.sybase.jaguar.application.security-role.<j2ee-role>




com.sybase.jaguar.servlet.servletorjsp

Description

Specifies whether this servlet is generated from a JSP.

Syntax

Value

To indicate

SERVLET

A servlet

JSP

A JSP

See also

com.sybase.jaguar.servlet.jsp-file




com.sybase.jaguar.servlet.session.allowed

Description

For servlets not in a Web application, specifies whether the servlet can use sessions.

Syntax

true or false. The default is false.

Usage

For Web application servlets, sessions are always enabled.




com.sybase.jaguar.servlet.session.timeout

Description

For servlets not in a Web application, specifies the session timeout.

Syntax

The timeout value in seconds. A value of 0 indicates infinity.

Usage

For Web application servlets, the Web application com.sybase.jaguar.webapplication.session-config property specifies the session timeout value.

See also

com.sybase.jaguar.webapplication.session-config




com.sybase.jaguar.servlet.singlethread

Description

Specifies whether an instance of the servlet class can be run simultaneously on multiple threads.

Syntax

true or false. The default is false.

See also

com.sybase.jaguar.servlet.singlethread.poolsize




com.sybase.jaguar.servlet.singlethread.poolsize

Description

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.

Syntax

A positive integer, or 0 to indicate no limit. The default is 1.

See also

com.sybase.jaguar.servlet.singlethread




com.sybase.jaguar.servlet.small-icon

Description

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.

Syntax

A file name.





Copyright © 2005. Sybase Inc. All rights reserved. Thread monitor properties