Oracle iPlanet Web Proxy Server 4.0.14 Configuration File Reference

Chapter 2 Server Configuration Elements in the `server.xml` file

The server.xml file contains most of the server configuration. The encoding is UTF-8 to maintain compatibility with regular UNIX text editors. The server.xml file is located in the <instance-directory>/config directory. A schema file, sun-web-proxy-server_4_0.dtd, determines the format and content of the server.xml file.

This chapter describes the server.xml and sun-web-proxy-server_4_0.dtd file in the following sections:

sun-web-proxy-server_4_0.dtd File

The sun-web-proxy-server_4_0.dtd file defines the structure of the server.xml file, including the elements it can contain and the subelements and attributes these elements can have. The sun-web-proxy-server_4_0.dtd file is located in the <Install_Directory>/bin/proxy/dtds directory.

Each element defined in a DTD file (which may be present in the corresponding XML file) can contain the following:

Subelements

Elements can contain subelements. For example, the following file fragment defines the VSCLASS element:

<!ELEMENT LS (DESCRIPTION?, SSLPARAMS?)>

The ELEMENT tag specifies that a LSCLASS element can contain DESCRIPTION, and SSLPARAMS elements in that order.

The following table shows how optional suffix characters of subelements determine the requirement rules, or number of allowed occurrences, for the subelements.

Table 2–1 Requirement Rules and Subelement Suffixes


Subelement Suffix	Requirement Rule
element*	Can contain zero or more of this subelement
element?	Can contain zero or one of this subelement
element+	Must contain one or more of this subelement
element (no suffix)	Must contain only one of this subelement

If an element cannot contain other elements, you see EMPTY or (#PCDATA) instead of a list of element names in parentheses.

Data

Some elements contain character data instead of subelements. These elements have definitions of the following format:

<!ELEMENT element-name (#PCDATA)>

For example:

<!ELEMENT DESCRIPTION (#PCDATA)>

In the server.xml file, white space is treated as part of the data in a data element. Therefore, no extra white space should appear before or after the data delimited by a data element. For example:

<DESCRIPTION>myserver</DESCRIPTION>

Attributes

Elements that have ATTLIST tags contain attributes (name-value pairs). For example:

<!ATTLIST ACLFILE

id ID #REQUIRED

file CDATA #REQUIRED

An ACLFILE element can contain id, and file attributes.

The #REQUIRED label means that a value must be supplied. The #IMPLIED label means that the attribute is optional, and that Proxy Server generates a default value. Wherever possible, explicit defaults for optional attributes (such as “true”) are listed.

Attribute declarations specify the type of the attribute. For example, CDATA means character data, and %boolean is a predefined enumeration.

Elements in the server.xml File

This section describes the XML elements in the server.xml file. Elements are grouped as follows:

Note –

Subelements must be defined in the order in which they are listed under each Subelements heading unless otherwise noted.

For an alphabetical listing of elements in server.xml, see Appendix C, Server Configuration Elements.

Core Server Elements

General elements are as follows:

SERVER

The SERVER element defines a server. SERVER is the root element. Only one SERVER element can exist in a server.xml file.

Subelements

The following table describes subelements for the SERVER element.

Table 2–2 SERVER subelements


Element	Required	Description
PROPERTY	Zero or more	Specifies a property of the server
LS	One or more	Defines one or more HTTP listen sockets
MIME	Zero or one	Defines mime type
ACLFILE	Zero or one	References one or more ACL files
USERDB	Zero or more	Defines the user database used
FILECACHE	Only one	Configures NSFC parameters
CACHE	Zero or one	Configures the disk cache parameters
LOG	Zero or one	Configures the system logging service
EVENT	Zero or more	Configures events

Attributes

The following table describes attributes for the SERVER element.

Table 2–3 SERVER attributes


Attribute	Default	Description
`objectfile`	`obj.conf`	Specifies the `obj.conf` file for the server.
`rootobject`	default	(optional) Tells the server which object loaded from an `obj.conf` file is the default. The default object is expected to have all the name translation (NameTrans) directives for the server. Any server behavior that is configured in the default object affects the entire server. If you specify an object that does not exist, the server does not report an error until a client tries to retrieve a document.

PROPERTY

The PROPERTY element specifies a property, or a variable that is defined in server.xml and referenced in obj.conf. For information about variables, see Variables.

A property adds configuration information to its parent element that meets one or both of the following requirments:

Optional with respect to Proxy Server
Needed by a system or object that Proxy Server doesn’t have knowledge of, such as an LDAP server or a Java class

For example:

<PROPERTY name="accesslog" value="<install-root>/<instance-directory>/logs/access"/>

Subelements

The following table describes subelements for the PROPERTY element.

Table 2–4 PROPERTY subelements


Element	Required	Description
DESCRIPTION	Zero or one	Contains a text description of the property

Attributes

The following table describes attributes for the PROPERTY element.

Table 2–5 PROPERTY attributes


Attribute	Default	Description
`name`	None	Specifies the name of the property or variable
`value`	None	Specifies the value of the property or variable

DESCRIPTION

Contains a text description of the parent element.

Subelements

None

Attributes

None

LOG

Configures the system logging service, which includes the following log files:

The errors log file stores messages from the server. The default name is errors.
The access log file stores HTTP access messages from the server. The default name is access.log. To configure the access log, you use server application functions in the obj.conf files.

Subelements

The following table describes subelements for the LOG element.

Table 2–6 LOG subelements


Element	Required	Description
PROPERTY	Zero or more	Specifies a property or a variable

Attributes

The following table describes attributes for the LOG element.

Table 2–7 LOG attributes


Attribute	Default	Description
`file`	`errors`	Specifies the file that stores messages from the server.
`loglevel`	`info`	Controls the default type of messages logged by other elements to the error log. Allowed values are as follows, from highest to lowest: `finest, finer, fine, info, warning, failure, config, security, and catastrophe`.
`logstdout`	`true`	(optional) If `true`, redirects `stdout` output to the errors log. Valid values are `on`, `off`, `yes`, `no`, `1`, `0`, `true`, `false`.
`logstderr`	`true`	(optional) If `true`, redirects `stderr` output to the errors log. Valid values are `on`, `off`, `yes`, `no`, `1`, `0`, `true`, `false`.
`logtoconsole`	`true`	(optional, UNIX only) If `true`, redirects log messages to the console.
`createconsole`	`false`	(optional, Windows only) If `true`, creates a Windows console. Valid values are `on`, `off`, `yes`, `no`, `1`, `0`, `true`, `false`.
`usesyslog`	`false`	(optional) If `true`, uses the UNIX `syslog` service or Windows Event Logging to produce and manage logs. Valid values are `on`, `off`, `yes`, `no`, `1`, `0`, `true`, `false`.

EVENT

An event can be scheduled to run at specific times, either on days of the week or on days of the month, or when the server starts up or shuts down.

Subelements

The following table describes subelements for the EVENT element.

Table 2–8 EVENT subelements


Element	Required	Description
DESCRIPTION	Zero or one	Descriptive text about the event. Used for informational purposes. This element is optional.
EVENTTIME	Only one	Container element that specifies the time at which the event is to be executed. This element is required.
EVENTACTION	Only one	Container element that specifies the event action to be executed. This element is required.
PROPERTY	Zero or more	Specifies a property or a variable.

Attributes

The following table describes attributes for the EVENT element.

Table 2–9 EVENT attributes


Attribute	Default	Description
`enabled`	`true`	Indicates whether the specified event is to be scheduled
`name`	None	Specifies the name of the event

EVENTTIME

Container element that specifies the time at which the event is to be executed. This is a required element.

Subelements

The following table describes subelements for the EVENTTIME element.

Table 2–10 EVENTTIME subelements


Element	Required	Description
`TIMEOFDAY`	Only one	A space-separated list of times (in 24 hour hh:mm notation) at which the event should be run. This element is required. If neither `DAYOFWEEK` or `DAYOFMONTH` is specified then the event will be scheduled at these times every day of the week. For example: `<TIMEOFDAY>00:30 6:30 12:30 18:30</TIMEOFDAY>`
`DAYOFWEEK`	Zero or one	A space-separated list of weekday names on which the event should be run at the time specified by the `TIMEOFDAY` value. A value for either this element or the `DAYOFMONTH` element must be specified. The valid names for weekdays are `Mon, Tue, Wed, Thu, Fri, Sat, Sun`. For example: `<DAYOFWEEK>Mon Wed Fri</DAYOFWEEK>`
`DAYOFMONTH`	Zero or one	A space-separated list of integers from 1-31 that denotes the day of the month on which the event is to be run. The `TIMEOFDAY` value specifies the time at which the event will be run. A value for either this element or the `TIMEOFDAY` element must be specified. For example: `<DAYOFMONTH>1 15</DAYOFMONTH>`
`ONSTARTUP`	Only one	The event is scheduled to occur when the server starts up.
`ONSHUTDOWN`	Only one	The event is scheduled to occur when the server shuts down.

EVENTACTION

Container element that specifies the event action to be executed.

Subelements

The following table describes subelements for the EVENTACTION element.

Table 2–11 EVENTACTION subelements


Element	Required	Description
`RESTART`	Zero or one	If specified, this event will restart the server at the specified times
`RECONFIG`	Zero or one	If specified, this event will dynamically reconfigure the server at the specified times.
`ROTATELOGS`	Zero or one	If specified, this event will rotate the server access and error log files at the specified times.
`COMMAND`	Zero or one	The command line of the executable to run at the scheduled times. This element is an optional subelement of `EVENTACTION`.

Listener Elements

The Listener elements are as follows:

LS

Defines an HTTP listen socket.

Note –

When you create a secure listen socket through the Server Manager, security is automatically turned on globally in magnus.conf. When you create a secure listen socket manually in server.xml, security must be turned on by editing magnus.conf.

Subelements

The following table describes subelements for the LS element.

Table 2–12 LS subelements


Element	Required	Description
DESCRIPTION	Zero or one	Contains a text description of the listen socket
SSLPARAMS	Zero or one	Defines Secure Socket Layer (SSL) parameters

Attributes

The following table describes attributes for the LS element.

Table 2–13 LS attributes


Attribute	Default	Description
`id`	None	(optional) The socket family type. A socket family type cannot begin with a number. When you create a secure listen socket in the `server.xml` file, security must be turned on in `magnus.conf`. When you create a secure listen socket in the Server Manager, security is automatically turned on globally in `magnus.conf`.
`ip`	Any	Specifies the IP address of the listen socket. The value can be in dotted-pair or IPv6 notation. The value can also be `any` for `INADDR_ANY`.
`port`	None	Port number on which to create the listen socket. Legal values are `1` - `65535`. On UNIX, creating sockets that listen on ports `1` - `1024` requires superuser privileges. Configuring an SSL listen socket to listen on port 443 is recommended. Two different IP addresses can’t use the same port.
`security`	`false`	(optional) Determines whether the listen socket runs SSL. Valid values are `on`, `off`, `yes`, `no`, `1`, `0`, `true`, `false`. You can turn SSL2 or SSL3 on or off and set ciphers using an `SSLPARAMS` subelement for this listen socket. The `Security` setting in the `magnus.conf` file globally enables or disables SSL by making certificates available to the server instance. Therefore, `Security` in `magnus.conf` must be turned `on` or security in `server.xml` does not work. For more information, see Chapter 3, Syntax and Use of the `magnus.conf` File.
`acceptorthreads`	`1`	(optional) Number of acceptor threads for the listener. The recommended value is the number of processors in the machine. Valid values are `1` - `1024`.
`family`	None	(optional) The socket family type. Valid values are `inet, inet6, and nca`. Use the value `inet6` for IPv6 listen sockets. When using the value of `inet6,` IPv4 addresses will be prefixed with `::ffff:` in the log file. Specify `nca` to make use of the Solaris Network Cache and Accelerator.
`blocking`	`false`	(optional) Determines whether the listen socket and the accepted socket are put into blocking mode. Use of blocking mode may improve benchmark scores. Valid values are `on`, `off`, `yes`, `no`, `1`, `0`, `true`, `false`.
`servername`	None	Tells the server what to put in the host name section of any URLs it sends to the client. This affects URL values that the server automatically generates. This value does not affect the URLs for directories and files stored in the server. This name should be the alias name if your server uses an alias. If you append a colon and port number, that port will be used in URLs the server sends to the client.

SSLPARAMS

Defines SSL (Secure Socket Layer) parameters.

Subelements

none

Attributes

The following table describes attributes for the SSLPARAMS element.

Table 2–14 SSLPARAMS attributes


Attribute	Default	Description
`servercertnickname`	`Server-Cert`	The nickname of the server certificate in the certificate database or the PKCS#11 token. In the certificate, the name format is tokenname:nickname. Including the tokenname: part of the name in this attribute is optional.
`ssl2`	`false`	(optional) Determines whether SSL2 is enabled. Valid values are `on`, `off`, `yes`, `no`, `1`, `0, true,` and `false`. If both SSL2 and SSL3 are enabled for a virtual server, the server tries SSL3 encryption first. If that encryption fails, the server tries SSL2 encryption.
`ssl2ciphers`	None	(optional) A space-separated list of the SSL2 ciphers used with the prefix + to enable or - to disable, for example, +rc4. Allowed values are `rc4`, `rc4export`, `rc2`, `rc2export`, `idea`, `des`, `desede3`.
`ssl3`	`true`	(optional) Determines whether SSL3 is enabled. Valid values are `on`, `off`, `yes`, `no`, `1`, `0`, `true` and `false`. If both SSL2 and SSL3 are enabled for a virtual server, the server tries SSL3 encryption first. If that encryption fails, the server tries SSL2 encryption.
`ssl3tlsciphers`	none	(optional) A space-separated list of the SSL3 ciphers used with the prefix + to enable or - to disable, for example, +rsa_des_sha. Allowed SSL3 values are `rsa_rc4_128_md5`, `rsa_3des_sha`, `rsa_des_sha`, `rsa_rc4_40_md5`, `rsa_rc2_40_md5`, `rsa_null_md5`. Allowed TLS values are `rsa_des_56_sha`, `rsa_rc4_56_sha`.
`tls`	`true`	(optional) Determines whether TLS is enabled. Valid values are `on`, `off`, `yes`, `no`, `1`, `0`, `true`, and `false`.
`tlsrollback`	`true`	(optional) Determines whether TLS rollback is enabled. Valid values are `on`, `off`, `yes`, `no`, `1`, `0`, `true`, and `false`. TLS rollback should be enabled for Microsoft Internet Explorer 5.0 and 5.5.
`clientauth`	`false`	(optional) Determines whether SSL3 client authentication is performed on every request, independent of ACL-based access control. Valid values are `on`, `off`, `yes`, `no`, `1`, `0`, `true`, and `false`.

MIME

The MIME element defines MIME types.

The most common way that the server determines the MIME type of a requested resource is by invoking the type-by-extension directive in the ObjectType section of the obj.conf file. The type-by-extension function does not work if no MIME element has been defined in the SERVER element.

Subelements

The following table lists the subelements for the MIME element.

Table 2–15 Mime subelements


Element	Required	Description
`TYPE`	Zero or more	Specifies the mime type of the requested resource.

Attributes

The following table describes attributes for the MIME element.

Table 2–16 MIME attributes


Attribute	Default	Description
`id`	None	Internal name for the MIME types listing. The MIME types name cannot begin with a number.
`file`	None	The name of a MIME types file. For more information, see Chapter 6, MIME Types

TYPE

Defines the type of the requested resource.

Subelements

None

Attributes

The following table describes attributes for the TYPE element.

Table 2–17 TYPE attributes


Attribute	Default	Description
`type`	None	Defines the type of the requested resource
`language`	None	Defines the content language
`encoding`	None	Defines the content-encoding
`extensions`	None	Defines the file extensions associated with the specified resource

ACLFILE

References one ACL file.

Subelements

The following table describes subelements for the ACLFILE element.

Table 2–18 ACLFILE subelements


Element	Required	Description
DESCRIPTION	Zero or one	Contains a text description of the `ACLFILE` element

Attributes

The following table describes attributes for the ACLFILE element.

Table 2–19 ACLFILE attributes


Attribute	Default	Description
`id`	None	Internal name for the ACL file listing. An ACL file listing name cannot begin with a number.
`file`	None	A space-separated list of ACL files. Each ACL file must have a unique name. For information about the format of an ACL file, see the Proxy Server Administration Guide. The name of the default ACL file is `generated.https-server-id.acl`, and the file resides in the `server_root/server-id/httpacl` directory. To use this file, you must reference it in `server.xml`.

USERDB

Defines the user database used by the server.

Subelements

The following table describes subelements for the USERDB element.

Table 2–20 USERDB subelements


Element	Required	Description
DESCRIPTION	Zero or one	Contains a text description of this element

Attributes

The following table describes attributes for the USERDB element.

Table 2–21 USERDB attributes


Attribute	Default	Description
`id`	None	The user database name in the server’s ACL file. A user database name cannot begin with a number.
`database`	None	The user database name in the `dbswitch.conf` file.
`basedn`	None	(optional) Overrides the base DN lookup in the `dbswitch.conf` file. However, the `basedn` value is still relative to the base DN value from the `dbswitch.conf` entry.
`certmaps`	None	(optional) Specifies which certificate mapped to LDAP entry mappings defined in `certmap.conf` to use. If the certificate is not present, all mappings are used. All lookups based on mappings in `certmap.conf` are relative to the final base DN of the server.

Cache Elements

Cache elements are as follows:

FILECACHE

Configures the in-memory cache.

Subelements

The following table describes subelements for the FILECACHE element.

Table 2–22 FILECACHE subelements


Element	Required	Description
DESCRIPTION	Zero or one	Contains a text description of this element

Attributes

The following table describes attributes for the FILEACHE element.

Table 2–23 FILECACHE attributes


Attribute	Default	Description
`enabled`	`true`	Select this option, if not already selected.
`transmitfile`	`false`	When you enable `transmitfile`, the server caches open file descriptors for files in the file cache, rather than caching the file contents. `PR_transmitfile` is used to send the file contents to a client. When `transmitfile` is enabled, the distinction normally made by the file cache between small, medium, and large files no longer applies, because only the open file descriptor is being cached.
`contentcache`	`true`	Enables caching file content.
`tempdir`		Specifies the directory to store temporary files.
`maxage`	30	The maximum age in seconds of a valid cache entry. This setting controls how long cached information will continue to be used once the file is cached. An entry older than `maxage` is replaced by a new entry for the same file, if the same file is referenced through the cache.
`mediumfilesizelimit`	537600	Size in bytes of the largest (non-small) file that is considered to be medium size. The contents of medium files are cached by mapping the file into virtual memory (currently only on UNIX platforms). The contents of "large" files (larger than "medium") are not cached, although information about large files is cached.
`mediumfilespace`	10485760	Specifies how much virtual memory will be used to map all medium-sized files.
`smallfilesizelimit`	2048	Size in bytes of the largest file that is considered to be "small". The contents of small files are cached by allocating heap space and reading the file into that space.
`smallfilespace`	1048576	Specifies how much heap space will be used for the cache, including heap space used to cache small files.
`maxfiles`	1024	The maximum number of files that may be in the cache at once.
`hashinitsize`	0	Initial number of hash buckets.

CACHE

Configures the disk cache.

Subelements

The following table describes subelements for the CACHE element.

Table 2–24 CACHE subelements


Element	Required	Description
DESCRIPTION	Zero or one	Contains a text description of this element.
PARTITION	One or more	The cache partition is a reserved part of disk or memory that is set aside for caching purposes.
GC	Zero or one	The cache garbage collector is used to delete files from the cache. Garbage collection can be done in either the automatic mode or the explicit mode.

Attributes

The following table describes attributes for the CACHE element.

Table 2–25 CACHE attributes


Attribute	Default	Description
`enabled`	`true`	Select this option, if not already selected.
`cachedir`	`install-root/instance-directory/cache`	Specifies the directory for caching.
`cachecapacity`	2000 Mbytes	The cache capacity should be set equal to or greater than the cache size. Setting the capacity larger than the cache size can be helpful if you know that you plan to increase the cache size later, such as by adding an external disk.

PARTITION

Configures the storage area on a disk that you set aside for caching. If you want to have your cache span several disks, you need to configure at least one cache partition for each disk. Each partition can be independently administered, so you can enable, disable, and configure a partition independently of all other partitions.

Subelements

The following table describes subelements for the PARTITION element.

Table 2–26 PARTITION subelements


Element	Required	Description
DESCRIPTION	Zero or one	Contains a text description of this element.

Attributes

The following table describes attributes for the PARTITION element.

Table 2–27 PARTITION attributes


Attribute	Default	Description
`enabled`	`true`	Select this option, if not already selected.
`partitiondir`	`install-root/instance-directory/cache`	Specify the directory where the partition is to be created.
`partitionname`	part1	Specify a name for the partition.
`maxsize`	1600 Mbytes	(Optional) Number for the maximum size to which you want to allow the cache partition to grow, listed in megabytes.
`minspace`	5 Mbytes	The minimum amount of available space, in megabytes, on the physical partition. This partition is the actual disk on which the cache partition resides. If less space is available, the proxy stops caching to that cache partition, even if the cache has not reached the maximum size (`maxsize`). The proxy server continues to write to other partitions that are not full.

GC

Configures the cache garbage collector that deletes files from the cache. Garbage collection can be done in either the automatic mode or the explicit mode.

Subelements

The following table describes subelements for the GC element.

Table 2–28 CACHE subelements


Element	Required	Description
DESCRIPTION	Zero or one	Contains a text description of this element.

Attributes

The following table describes attributes for the GC element.

Table 2–29 CACHE attributes


Attribute	Default	Description
`enabled`	`true`	Select this option, if not already selected
`gchimargin`	80	Controls the percentage of the maximum cache size that, when reached, triggers garbage collection
`gclomargin`	70	Controls the percentage of the maximum cache size that the garbage collector targets
`gcleavefsfull`	60	Determines the percentage of the cache partition size below which garbage collection will not go
`gcextramargin`	30	Sets the percentage of the cache to be removed by the garbage collector

iPlanet LDAP Schema

This section describes the iPlanet LDAP Schema that defines a set of rules for directory data.

You can use the dcsuffix attribute in the dbswitch.conf file if your LDAP database meets the requirements outlined in this section. For more information about the dbswitch.conf file, see dbswitch.conf.

The subtree rooted at an ISP entry, for example, o=isp is called the convergence tree. It contains all directory data related to organizations (customers) served by an ISP.

The subtree rooted at o=internet is called the domain component tree, or dc tree. It contains a sparse DNS tree with entries for the customer domains served. These entries are links to the appropriate location in the convergence tree where the data for that domain is located.

The directory tree may be single rooted, which is recommended. For example, o=root may have o=isp and o=internet under it. The tree mat also have two separate roots, one for the convergence tree and one for the dc tree.

Convergence Tree

The top level of the convergence tree must have one organization entry for each customer or organization, and one for the ISP itself.

Underneath each organization must be two organizationalUnit entries: ou=People and ou=Groups. A third, ou=Devices, can be present if device data is to be stored for the organization.

Each user entry must have a unique uid value within a given organization. The namespace under this subtree can be partitioned into various ou entries that aggregate user entries in convenient groups, for example, ou=eng, ou=corp. User uid values must still be unique within the entire People subtree.

User entries in the convergence tree are of type inetOrgPerson. The cn, sn, and uid attributes must be present. The uid attribute must be a valid email name, specifically a valid local-part as defined in RFC822. The cn must contain name initial sn. The RDN of the user entry be the uid value. User entries must contain the auxiliary class inetUser if they are to be considered enabled for service or valid.

User entries can also contain the auxiliary class inetSubscriber, which is used for account management purposes. If an inetUserStatus attribute is present in an entry and has a value of inactive or deleted, the entry is ignored.

Groups are located under the Groups subtree and consist of LDAP entries of type groupOfUniqueNames.

Domain Component (dc) Tree

The dc tree contains hierarchical domain entries, each of which is a DNS name component.

Entries that represent the domain name of a customer are overlaid with the LDAP auxiliary class inetDomain. For example, the two LDAP entries dc=customer1,dc=com,o=Internet,o=root and dc=customer2,dc=com,o=Internet,o=root contain the inetDomain class, but dc=com,o=Internet,o=root does not. The latter is present only to provide structure to the tree.

Entries with an inetDomain attribute are called virtual domains. The attribute inetDomainBaseDN for these domains must be filled with the DN of the top-level organization entry where the data of this domain is stored in the convergence tree. For example, the virtual domain entry in dc=cust2,dc=com,o=Internet,o=root would contain the attribute inetDomainBaseDN with value o=Cust2,o=isp,o=root.

If an inetDomainStatus attribute is present in an entry and has a value of inactive or deleted, the entry is ignored.

Variables

Some variables are defined in server.xml for use in the obj.conf file. The following file fragment defines a docroot variable:

<PROPERTY name="accesslog" value="install-root/instance-directory/logs/access"/>

The variable is then used in the obj.conf file. For example:

Init fn="flex-init" access="$accesslog" format.access="%Ses->client.ip% 
	- %Req->vars.auth-user% [%SYSDATE%] ’%Req->reqpb.clf-request%’ 
	%Req->srvhdrs.clf-status% %Req->srvhdrs.content-length%"

Using this accesslog variable enables you to define different document roots for different virtual servers within the same virtual server class.

Format of a Variable

A variable is found in the obj.conf file when the following regular expression matches:

\\$[A-Za-z][A-Za-z0-9_]*

This expression represents a $ followed by one or more alphanumeric characters. A delimited version (“${property}”) is not supported. To use a regular $ character, use $$ to have variable substitution.

Other Important Variables

In a default installation, the following variables are used to configure various aspects of the server’s operation.

General Variables

The following table lists general server.xml variables. The left column lists variables, and the right column lists descriptions of those variables.

Table 2–30 General Variables


Property	Description
`accesslog`	The access log file for the server.

Variable Evaluation

Variables are evaluated when generating specific objectsets. Evaluation is recursive; meaning that variable values can contain other variables.

Sample server.xml File

<?xml version="1.0" encoding="UTF-8"?>
<!--
   Copyright (c) 2003, 2010 Oracle and/or its affiliates.  All rights reserved.
   Use is subject to license terms.
-->
<!DOCTYPE SERVER PUBLIC "-//Sun Microsystems Inc.//DTD iPlanet Web Proxy Server 4.0//EN" "file:///space/proxy40/bin/proxy/dtds/sun-web-proxy-server_4_0.dtd">
<SERVER>
    <PROPERTY name="accesslog" value="/space/proxy40/proxy-server1/logs
		/access"/>
<LS id="ls1" port="8080" servername="agneyam"/>
<MIME id="mime1" file="mime.types"/>
<ACLFILE id="acl1" file="/space/proxy40/httpacl
		/generated.proxy-server1.acl"/>
<USERDB id="default"/>
<FILECACHE enabled="true"  maxage="30" mediumfilesizelimit="537600" 
		mediumfilespace="10485760" smallfilesizelimit="2048" 
		smallfilespace="1048576" transmitfile="false" 
		maxfiles="1024" hashinitsize="0"/>
<CACHE enabled="true" cachecapacity="2000" cachedir="/space/proxy40
		/proxy-server1/cache">
    <PARTITION  partitionname="part1" partitiondir="/space/proxy40/
		proxy-server1/cache" maxsize="1600" minspace="5" enabled="true"/>
    <GC enabled="true" gchimargin="80" gclomargin="70" 
		gcleavefsfull="60" gcextramargin="30"/>
</CACHE>
<LOG file="/space/proxy40/proxy-server1/logs/errors" loglevel="finest"/>
</SERVER>

Chapter 2 Server Configuration Elements in the server.xml file

sun-web-proxy-server_4_0.dtd File

Subelements

Data

Attributes

Elements in the server.xml File

Core Server Elements

SERVER

Subelements

Attributes

PROPERTY

Subelements

Attributes

DESCRIPTION

Subelements

Attributes

LOG

Subelements

Attributes

EVENT

Subelements

Attributes

EVENTTIME

Subelements

EVENTACTION

Subelements

Listener Elements

LS

Subelements

Attributes

SSLPARAMS

Subelements

Attributes

MIME

Subelements

Attributes

TYPE

Subelements

Attributes

ACLFILE

Subelements

Attributes

USERDB

Subelements

Attributes

Cache Elements

FILECACHE

Subelements

Attributes

CACHE

Subelements

Attributes

PARTITION

Subelements

Attributes

GC

Subelements

Attributes

iPlanet LDAP Schema

Convergence Tree

Domain Component (dc) Tree

Variables

Format of a Variable

Other Important Variables

General Variables

Variable Evaluation

Sample server.xml File

Chapter 2 Server Configuration Elements in the `server.xml` file