server.xml elements beginning with A
The following elements are discussed below:
access-log
The access-log element configures an HTTP access log. 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 access-log element can contain the following subelements:
Table 3-1 List of access-log Subelements
| Element | Occurrences | Description |
|---|---|---|
| enabled | 0 or 1 | Determines whether the server writes to this access log. The default value is true. |
| name | 0 or 1 | The name that uniquely identifies the access log. If you specify a name, the server will not automatically log to this access log. Instead, you should explicitly configure this access log in an obj.conf AddLog directive. |
| file | 1 | The file name of the access log. If a relative path is used, it is relative to the server's config directory. For example, ../logs/access. |
| format | 0 or 1 | The format of the access log entries. The default format is the CLF (common log file) format. For more information on the access log format, see Appendix C: Using the Custom Log File Format. |
See Also
access-log-buffer
The access-log-buffer element configures the access log buffering subsystem. This element may appear zero or one time within the server element. For more information, see server.
Subelements
The access-log-buffer element can contain the following subelements:
Table 3-2 List of access-log-buffer Subelements
| Element | Occurrences | Description |
|---|---|---|
| direct-io | 0 or 1 | Indicates whether the file system should cache access log writes. The default value, false, indicates that the file system should cache access log writes. Setting the value to true indicates that the file system should not cache access log writes. The setting is purely advisory; either the server or the operating system may choose to ignore it. |
| enabled | 0 or 1 | Determines whether the server buffers the access log entries. The default value is true. |
| buffer-size | 0 or 1 | The size (in bytes) of individual access log buffers. The value can be from 4096 to 1048576. |
| max-buffers | 1 | The maximum number of access log buffers per server. The value can be from 1 to 65536. |
| max-buffers-per-file | 0 or 1 | The maximum number of access log buffers per access log file. The value can be from 1 to 128. |
| max-age | 0 or 1 | The maximum time (in seconds) to buffer a given access log entry. The value can be from 0.001 to 3600. |
See Also
acl-cache
The acl-cache element configures the Access Control List (ACL) cache. This element may appear zero or one time within the server element. For more information, see server.
Subelements
The acl-cache element can contain the following subelements:
Table 3-3 List of acl-cache Subelements
| Element | Occurrences | Description |
|---|---|---|
| enabled | 0 or 1 | Determines whether the server caches ACLs and information about authenticated users. The default value is true. |
| max-users | 0 or 1 | The maximum number of users for which the server will cache the authentication information. The value can be from 1 to 1048576. |
| max-groups-per-user | 0 or 1 | The maximum number of groups per user for which the server will cache the membership information. The value can be from 1 to 1024. |
| max-age | 0 or 1 | The maximum time (in seconds) required to cache the authentication information. The value can be from 0.001 to 3600. |
See Also
acl-db
The acl-db element configures the WebDAV Access Control Protocol ACL database. This element may appear zero or one time within the dav element and zero or one time within the dav-collection element. For more information, see dav and dav-collection.
Subelements
The acl-db element can contain the following subelements:
Table 3-4 List of acl-db Subelements
| Element | Occurrences | Description |
|---|---|---|
| max-entries | 0 or 1 | The maximum number of Access Control Entries (ACE) that can be allowed on a single resource. The value can be from 0 to 2147483647, or -1 for no limit. |
| max-size | 0 or 1 | The maximum size (in bytes) of memory representation of the WebDAV ACL database for a collection. If the memory limit specified using this subelement is exceeded, the server will not cache the WebDAV ACLs. The value can be from 0 to 2147483647, or -1 for no limit. |
| update-interval | 0 or 1 | The interval (in seconds) at which the WebDAV ACL databases are synchronized to the disk. The value can be from 0.001 to 3600, or 0 to disable caching of WebDAV ACLs. |
See Also
acl-file
The acl–file element defines a file that controls access to the server. 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.
The value of this element is the file name of the ACL file. If a relative path is used, it is relative to the server's config directory. This element does not contain any subelements.
See Also
audit-accesses
The audit-accesses element determines whether authentication and authorization events are logged. This element may appear zero or one time within the server element. For more information, see server. The default value is false. This element does not contain any subelements.
See Also
auth
The auth element configures WebDAV Access Control Protocol authentication. This element may appear zero or one time within the dav element and zero or one time within the dav-collection element. For more information, see dav and dav-collection.
Subelements
The auth element can contain the following subelements:
Table 3-5 List of auth Subelements
| Element | Occurrences | Description |
|---|---|---|
| auth-db-name | 0 or 1 | The ACL authentication database to use. The value is the name from an auth-db element. The default value is the value of the default-auth-db-name element. For more information, see auth-db. |
| method | 0 or 1 | The authentication method to use. The value can be basic, digest, or ssl. The default value is basic. |
| prompt | 0 or 1 | The prompt that is displayed to clients when they request authentication. The default prompt is Sun Java System Web Server WebDAV. |
See Also
auth-db
The auth-db element configures an ACL authentication database. 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 auth-db element can contain the following subelements:
Table 3-6 List of auth-db Subelements
| Element | Occurrences | Description |
|---|---|---|
| enabled | 0 or 1 | Determines whether the ACL authentication database is enabled at runtime. The default value is true. |
| name | 1 | The name that uniquely identifies the ACL authentication database for use in ACL files. |
| url | 1 | The URL of the ACL authentication database. The type of ACL authentication database is specified in the URL scheme. For example, ldap://ds.example.com/dc=example,dc=com configures a LDAP directory server as an ACL authentication database. |
| auth-expiring-url | 0 or 1 | The URL to which the server redirects the client if the supplied password is about to expire. |
| property | 0 or more | Configures the ACL authentication database properties. For more details, see property. |
| description | 0 or 1 | The description of the ACL authentication database. The value is in text format. |
See Also
auth-realm
The auth-realm element configures a Servlet container authentication realm, which is used to authenticate access to web applications. This element may appear zero or more times within the server element. For more information, see server.
Subelements
The auth-realm element can contain the following subelements:
Table 3-7 List of auth-realm Subelements
| Element | Occurrences | Description |
|---|---|---|
| name | 1 | The name that uniquely identifies the Servlet container authentication realm. |
| type | 0 or 1 | The type of a built-in authentication realm. Only applicable when class is omitted. The value can be file, ldap, pam, certificate, or native. |
| class | 0 or 1 | The class that implements a Servlet container authentication realm. Only applicable when type is omitted. The value is a class name. |
| property | 0 or more | The Servlet container authentication realm properties. For more details, see property. |
Sign up or Log in to add a comment or watch this page.