Appendix B Repository Properties Reference
Web
application property names begin with com.sybase.jaguar.webapplication
.
The application where this Web application is installed.
The application name, or no value if the Web application is not installed in any application.
A Web application can be installed in one application, or directly to one or more servers. A Web application cannot be installed both directly in a server and to an application.
com.sybase.jaguar.application.webapplications,
com.sybase.jaguar.server.webapplications
For installed servlets, specifies the default for the servlet property com.sybase.jaguar.servlet.cache.locale-sensitive.
See com.sybase.jaguar.servlet.cache.locale-sensitive.
For installed servlets, specifies the default for the servlet property com.sybase.jaguar.servlet.cache.message-topics.
See com.sybase.jaguar.servlet.cache.message-topics.
For installed servlets, specifies the default for the servlet property com.sybase.jaguar.servlet.cache.request-headers.
See com.sybase.jaguar.servlet.cache.request-headers.
For installed servlets, specifies the default for the servlet property com.sybase.jaguar.servlet.cache.request-parameters.
See com.sybase.jaguar.servlet.cache.request-parameters.
For installed servlets, specifies the default for the servlet property com.sybase.jaguar.servlet.cache.session-attributes.
See com.sybase.jaguar.servlet.cache.session-attributes.
For installed servlets, specifies the default for the servlet property com.sybase.jaguar.servlet.cache.timeout.
See com.sybase.jaguar.servlet.cache.timeout.
For installed servlets, specifies the default for the servlet property com.sybase.jaguar.servlet.cache.use-sessionid.
See com.sybase.jaguar.servlet.cache.use-sessionid.
Specifies the context initialization parameters for the servlets in the Web application.
Same as the servlet property com.sybase.jaguar.server.servlet.context-param.
All servlets and JSPs in a Web application share a common set of context initialization properties specified by the deployment descriptor. Servlet code can retrieve the values by calling the getInitParamers() and getInitParameterNames() methods in interface javax.Servlet.ServletContext.
Environment properties can be used for the same purpose as context-initialization properties, and allow additional datatypes besides java.lang.String.
See com.sybase.jaguar.server.servlet.context-param for an explanation of context parameters.
com.sybase.jaguar.webapplication.env-entry
The request-path prefix that clients use in URLs to access your Web application's static content, servlets, and JSPs.
The context path, which must be a string containing no path separators. For example, if you enter "estore," users access your Web application with the prefix:
http://host:port/estore/
The default context path is the name of the Web application.
Specifies whether session data cookies are persistent or temporary.
true
or false
.
The default is false
, which
means cookies are temporary.
When this property is false (the default), EAServer stores session data in temporary cookies. When set to true, EAServer sends a persistent cookie that expires when the Web application session-timeout setting expires. This property affects only the cookies that EAServer creates to store session data for the Web application (available to servlets and JSPs via request.getSession). It does not affect cookies created explicitly by servlets and JSPs.
Specifies dependencies on standard Java extensions.
A string of the form:
dep1, dep2, dep3, ...
Where dep1, dep1, dep3 are of the form:
(prefix=name,extension-name=name,specification-version=vnum,specification-vendor=spec-vendor,implementation-version=inum,implementation-vendor-id=impl-vendor-id,implementation-vendor=impl-vendor,implementation-url=impl-url)
Table 15-8 describes the values and the corresponding entries in the manifest.mf file within an extension JAR file.
| Property value | Manifest entry | Description |
|---|---|---|
| name | Extension-Name
|
The extension name. |
| vnum | Specification-Version
|
The version number of the specification that the extension conforms to. |
| spec-vendor | Specification-Vendor
|
The company or organization responsible for the specification that the extension conforms to. |
| inum | Implementation-Version
|
The implementation version number. |
| impl-vendor | Implementation-Vendor
|
The company or organization responsible for the implementation. |
| impl-vendor-id | Implementation-Vendor-ID
|
A unique identifier for the company or organization responsible for the implementation. Usually follows the reverse-domain naming convention used in Java packages, for example, "com.sybase." |
| impl-url | Implementation-URL
|
A Web URL to obtain information on the implementation. |
The number of seconds that EAServer should wait for servlet service calls to return before calling the servlet destroy method. Affects all servlets installed in the Web application.
The timeout value in seconds. A value of 0 indicates infinity.
com.sybase.jaguar.webapplication.init-timeout
Specifies whether multiple instances of the Web application can run in a distributed server environment on different servers.
true
or false
.
The default is false
.
Setting this property to true causes Web client session data to be stored in a remote database, so all servers in a cluster can share the data. Additional configuration is required to configure the datastore. See "Creating Web Applications" in the EAServer Programmer's Guide for more information.
Specifies the class name for a custom DOM XML parser factory class.
The class name. If the class is in a JAR file, the JAR file name must be listed in the com.sybase.jaguar.webapplication.java.classes property or placed in the WEB-INF/lib directory under the Web application's context root.
com.sybase.jaguar.webapplication.jagmgr.DOMFactoryChoice,
com.sybase.jaguar.webapplication.SAXfactory,
com.sybase.jaguar.server.XSLTfactory
Specifies a list of EJB local references that define aliased JNDI names for local EJB components invoked by servlets in the Web application.
ejb-ref1, ejb-ref2, ...
Where ejb-ref1, ejb-ref2, and so forth follow the syntax of EJB local reference properties.
Use this property for beans invoked through the local interface. Use com.sybase.jaguar.webapplication.ejb-ref for beans invoked through the remote interface.
EJB local reference properties, com.sybase.jaguar.webapplication.ejb-ref
Specifies a list of EJB references that define aliased JNDI names for EJB components invoked by servlets in the Web application.
ejb-ref1, ejb-ref2, ...
Where ejb-ref1, ejb-ref2, and so forth follow the syntax of EJB reference properties.
Use this property for beans invoked through the remote interface. Use com.sybase.jaguar.webapplication.ejb-local-ref for beans invoked through the local interface.
EJB reference properties, com.sybase.jaguar.webapplication.ejb-local-ref
Environment properties allow you to specify global read-only
data for use by the servlets in the Web application. Servlets must
use JNDI to retrieve environment properties, using the prefix java:comp/env
in
JNDI lookups.
Specifies additional files to be included when the Web application is exported into a Jaguar JAR file or replicated using the synchronization feature.
Same as com.sybase.jaguar.applicationclient.files.
Associates filters with servlets and URL paths.
mapping1, mapping2, mapping3, ...
Where mapping1, mapping2, mapping3 are strings of the form:
(description=desc,filter-name=filter,type=pattern-or-servlet)
Where:
url-pattern
or servlet-name
.
url-pattern
).
com.sybase.jaguar.webapplication.filters
Specifies filters installed in this Web application.
A comma-separated list of filter names.
Filter properties,
com.sybase.jaguar.webapplication.filters
Specifies how long to wait for each installed servlet's init method to return.
The timeout in seconds. The default is 0, which indicates that there is no time limit.
com.sybase.jaguar.webapplication.destroy-wait-time
Specifies the XSLT parser configuration displayed in Jaguar Manager.
| Value | To indicate |
|---|---|
| 0 | No parse. |
| 1 | Platform default |
| 2 | The parser specified by the com.sybase.jaguar.webapplication.DOMfactory property |
com.sybase.jaguar.webapplication.DOMfactory,
com.sybase.jaguar.webapplication.jagmgr.SAXFactoryChoice,
com.sybase.jaguar.webapplication.jagmgr.XSLTFactoryChoice
Specifies the SAX parser configuration displayed in Jaguar Manager.
| Value | To indicate |
|---|---|
| 0 | No parser |
| 1 | Platform default |
| 2 | The parser specified by the com.sybase.jaguar.webapplication.SAXfactory property |
com.sybase.jaguar.webapplication.SAXfactory,
com.sybase.jaguar.webapplication.jagmgr.DOMFactoryChoice,
com.sybase.jaguar.webapplication.jagmgr.XSLTFactoryChoice
Specifies the XSLT parser configuration displayed in Jaguar Manager.
| Value | To indicate |
|---|---|
| 0 | No parser |
| 1 | Platform default |
| 2 | The parser specified by the com.sybase.jaguar.webapplication.XSLTfactory property |
com.sybase.jaguar.webapplication.XSLTfactory,
com.sybase.jaguar.webapplication.jagmgr.DOMFactoryChoice,
com.sybase.jaguar.webapplication.jagmgr.SAXFactoryChoice
Specifies the class loading order when classes are loaded from JAR files in the WEB-INF/lib directory under the Web application's context root.
A comma-separated list of JAR files. JAR files not listed in this property are loaded in directory order; that is, the order that they are returned in a directory listing.
com.sybase.jaguar.webapplication.java.classes
Specifies additional classes and JAR files to be loaded by the Web application's custom class loader, in addition to those deployed in the WEB-INF/lib and WEB-INF/classes directories.
Same as for com.sybase.jaguar.application.java.classes.
com.sybase.jaguar.application.java.classes,
com.sybase.jaguar.server.java.classes,
com.sybase.jaguar.servlet.java.classes
Specifies the name of the large icon file associated with the Web application. This property is not used in EAServer, but accommodated to comply with the Servlet 2.3 Web archive descriptor.
A file name.
Specifies application lifecycle event listeners installed in this Web application.
A comma-separated list of listener class names. Listeners are notified in the order that they are listed.
Configures login authentication for the Web application.
(form-login-config=(form-login-page=lpage,form-error-page=epage),realm-name=realm,auth-method=method)
Where:
| lpage | When method is FORM, the login form page. Unused for other methods. |
| epage | When method is FORM, the login error page. |
| realm | The realm name. When using the BASIC authentication method, some browsers display the realm name when prompting for authentication credentials. |
| method | One of the following:
"Web Application Security" in the EAServer Security Administration and Configuration Guide explains these options in more detail and describes how to create login and error form pages. |
com.sybase.jaguar.webapplication.security-constraint
Configures MIME mappings for the Web application to augment or override the server's default MIME mappings.
Same as the servlet property com.sybase.jaguar.server.servlet.mime-mapping.
Specifies the Web application name.
The name.
Resource environment references are logical names applied to objects administered by EAServer.
See Resource environment reference properties.
In Jaguar Manager, set this property using the Resource Env Refs tab in the Web Application Properties dialog box.
Resource environment reference properties.
Specifies aliased JNDI names for database connections, JavaMail sessions, and URL factories used by the Web application.
See Resource reference properties.
In Jaguar Manager, set this property using the Resource Refs tab in the Web Application Properties dialog box.
Resource reference properties.
Maps an identity name used in servlet properties to an identity defined in the EAServer repository.
Specify the identity referenced in a servlet com.sybase.jaguar.servlet.security.runasidentity property in the property name, for example:
com.sybase.jaguar.servlet.runasidentity.ddFooId
Specify the mapped EAServer identity as the value, for example:
fooId
Security properties,
com.sybase.jaguar.servlet.security.runasidentity
Specifies the class name for a custom SAX XML parser factory class.
The class name. If the class is in a JAR file, the JAR file name must be listed in the com.sybase.jaguar.webapplication.java.classes property or placed in the WEB-INF/lib directory under the Web application's context root.
com.sybase.jaguar.webapplication.jagmgr.SAXFactoryChoice,
com.sybase.jaguar.webapplication.DOMfactory,
com.sybase.jaguar.webapplication.XSLTfactory
Enables and disables security implementation tracing.
true
or false
.
The default is false
.
Associates required user roles and transport security for Web resource collections defined in the com.sybase.jaguar.webapplication.web-resource-collection property.
constraint1,constraint2, ...
Where constraint1, constraint2, and so forth are of the form:
(sec-constraint-name=constraint-name,web-res-list=(res-list),user-data-constraint=(desc=desc, transport-guarantee=transport),auth-constraint=(description=desc,name=(role-list)))
Where:
| constraint-name | The constraint name, which must be unique. |
| res-list | A comma-separated list of Web resource collection names, defined in the com.sybase.jaguar.webapplication.web-resource-collection property. |
| desc | An optional text description. Neither of the two description values are displayed in Jaguar Manager. |
| transport | The required network transport security.
One of:
|
| role-list | A comma-separated list of logical role names defined in the com.sybase.jaguar.webapplication.security-roles property. |
For more information on configuring Web application security, see "Web Application Security" in the EAServer Security Administration and Configuration Guide.
com.sybase.jaguar.webapplication.login-config,
com.sybase.jaguar.webapplication.security-roles,
com.sybase.jaguar.webapplication.web-resource-collection
Specifies a mapping from a J2EE role name used in the Web application to a role defined in the EAServer repository.
com.sybase.jaguar.webapplication.security-role.j2ee-role=jag-role
Where:
In Jaguar Manager, set this property using the Role Mapping tab in the Application Properties dialog box.
Role names may also be specified at the package, component, or Web application level.
com.sybase.jaguar.webapplication.security-constraint,
com.sybase.jaguar.webapplication.security-roles,
com.sybase.jaguar.application.security-role.<j2ee-role>,
com.sybase.jaguar.application.security-roles
Specifies logical J2EE role names used in the Web application com.sybase.jaguar.webapplication.security-constraint property.
role1, role2, ...
Where role1, role2, and so forth are of the form:
(description=role-desc, name=role-name)
Where role-desc is an optional description of the role, and role-name is the name used in the application.
com.sybase.jaguar.webapplication.security-role.<j2ee-role>,
com.sybase.jaguar.webapplication.security-constraint,
com.sybase.jaguar.application.security-roles
Associates installed servlets with request paths.
Same as the Web application property com.sybase.jaguar.server.servlet.servlet-mapping.
Configures HTTP session properties.
(session-timeout=timeout)
Where timeout is the session timeout in minutes. A value of 0 indicates that sessions do not expire.
Specifies the name of the small icon file associated with the Web application. This property is not used in EAServer, but accommodated to comply with the Servlet 2.3 Web archive descriptor.
A file name.
Configures path aliases for JSP Tag Library Descriptors (TLDs) used in the Web application.
Where alias is the path used in JSP source code, and real-path is the TLD files location relative to the Web application's context root.
alias1,alias2,...
Where alias1, alias2, and so forth are alias definitions of the form:
(taglib-uri=alias, taglib-location=real-path)
Where:
| alias | Is the path used in JSP source code. |
| real-path | Is the TLD file's location relative to the Web application's context root. |
Specifies a collection of request paths to be protected by security constraints.
set1,set2,...
Where set1, set2, and so forth are of the form:
(web-res-name=name,http-method=(methods),url-pattern=(patterns))
Where:
| name | Is the name used to refer to this collection
in com.sybase.jaguar.webapplication.security-constraint property.
For compatibility with Jaguar Manager, use the format:
constraint/display Where constraint is the security constraint that uses this collection, and display is the collection name displayed when this resource collection is viewed and edited in Jaguar Manager. |
| methods | Is a comma-separated list of HTTP methods
that can include: POST
, GET
, TRACE
, DELETE
, PUT
, OPTIONS
|
| patterns | Is a comma-separated list of URL patterns
associated with the collection, for example:
/control/*,welcome.htm |
com.sybase.jaguar.webapplication.security-constraint
Configures welcome files for the Web application. Welcome files are used to satisfy HTTP requests that end in a directory name, rather than specifying the full path to a file or a path that is mapped to a servlet invocation.
A comma-separated list of file names which may not contain path separators.
Specifies the class name for a custom XSLT XML parser factory class.
The class name. If the class is in a JAR file, the JAR file name must be listed in the com.sybase.jaguar.webapplication.java.classes property or placed in the WEB-INF/lib directory under the Web application's context root.
com.sybase.jaguar.webapplication.jagmgr.XSLTFactoryChoice,
com.sybase.jaguar.webapplication.DOMfactory,
com.sybase.jaguar.webapplication.SAXfactory
| Copyright © 2002 Sybase, Inc. All rights reserved. | ||