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.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-wide servlet destroy timeout setting for this servlet.

Syntax

Same as the server property com.sybase.jaguar.server.servlet.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

Overrides the server-wide servlet initialization timeout for this servlet.

Syntax

Same as the server property com.sybase.jaguar.server.servlet.init-timeout.


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.

See Also

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


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

id Is 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 Is 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 Is 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 © 2002 Sybase, Inc. All rights reserved.