server.xml element beginning with V and W
The following elements are discussed below:
variable
The variable element defines a variable for use in expressions, log formats, and obj.conf parameters. This element may appear zero or more times within the server element, and zero or more times within the virtual-server element. For more information, see server, and virtual-server.
Subelements
The variable element can contain the following subelements:
Table 3-59 List of variable Subelements
| Element | Occurrences | Description |
|---|---|---|
| name | 1 | The name of the variable. The value should be in text format. |
| value | 1 | The value of the variable. The value should be in text format. |
| description | 0 or 1 | The description of the variable. The value should be in text format. |
See Also
virtual-server
The virtual-server element configures an HTTP virtual server. Each server would typically have at least one virtual server. This element may appear zero or more times within the server element. For more information, see server.
Subelements
The virtual-server element can contain the following subelements:
Table 3-60 List of virtual-server Subelements
| Element | Occurrences | Description |
|---|---|---|
| enabled | 0 or 1 | Determines whether the virtual server is enabled at runtime. The default value is true. |
| name | 1 | A name that uniquely identifies the virtual server. |
| http-listener-name | 0 or more | The name of an HTTP listener associated with one or more of the virtual server's host names. The value is the name from an http-listener element. For more details, see http-listener. |
| host | 0 or more | The host name that the virtual server services. Host comparisons are not case sensitive. The value can be a host name or a wildcard pattern. For more information on wildcards, see Appendix B: Using Wildcard Patterns |
| canonical-server-name | 0 or 1 | The canonical name of the virtual server. Requests using a different name will be redirected to the canonical name. The value is a host name or URL prefix. |
| acl-file | 0 or more | The name of the ACL file that controls access to the virtual server. |
| mime-file | 0 or more | The mime.types file that configures MIME mappings for the virtual server. |
| object-file | 1 | The obj.conf file that controls request processing for the virtual server. |
| default-object-name | 0 or 1 | The name of the root obj.conf object. The default value is default. |
| document-root | 1 | The document root for the virtual server. |
| localization | 0 or 1 | Configures localization. For more details, see localization. |
| qos-limits | 0 or 1 | Configures QOS limits for the virtual server. For more details, see qos-limits. |
| search-app | 0 or 1 | Configures the built-in search web application for the virtual server. For more details, see search-app. |
| access-log | 0 or more | Configures an HTTP access log for the virtual server. For more details, see access-log. |
| auth-db | 0 or more | Configures an ACL authentication database for the virtual server. For more details, see auth-db. |
| search-collection | 0 or more | Configures a collection of searchable documents for the virtual server. For more details, see search-collection. |
| dav-collection | 0 or more | Configures a WebDAV collection for the virtual server. For more details, see dav-collection. |
| web-app | 0 or more | Configures the Java web application mappings for the virtual server. For more details, see web-app. |
| log-file | 0 or 1 | The log file for the virtual server. The value is the log file name, for example, ../logs/errors. |
| variable | 0 or more | Defines an obj.conf variable for the virtual server. For more details, see variable. |
| description | 0 or 1 | The description of the virtual server. |
| single-sign-on | 0 or 1 | Configures single sign-on for Java web applications within the virtual server. For more details, see single-sign-on. |
See Also
web-app
The web-app element configures a Java web application mapping. This element may appear zero or more times within the virtual-server element. For more information, see virtual-server.
Subelements
The web-app element can contain the following subelements:
Table 3-61 List of web-app Subelements
| Element | Occurrences | Description |
|---|---|---|
| enabled | 0 or 1 | Determines whether the web application is enabled at runtime. The default value is true. |
| uri | 1 | The root URI for the web application. |
| path | 1 | The path where the web application is stored. If a relative path is used, it is relative to the server's config directory. |
| description | 0 or 1 | The description of the web application. |