Sun Java System Web Proxy Server 4.0.2 2005Q4 Configuration File Reference

Core Server Elements

General elements are as follows:

SERVER

Defines a server. This is the root element; there can only be one server element 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

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 is one or both of the following:

Optional with respect to Sun Java System Web Proxy Server
Needed by a system or object that Sun Java System Web 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. Legal values are `on`, `off`, `yes`, `no`, `1`, `0`, `true`, `false`.
`logstderr`	`true`	(optional) If `true`, redirects `stderr` output to the errors log. Legal 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. Legal 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. Legal values are `on`, `off`, `yes`, `no`, `1`, `0`, `true`, `false`.

EVENT

An event can be scheduled to run at (a) specific time(s) either on (a) day(s) of the week or on (a) day(s) 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 is an optional element.
EVENTTIME	only one	Container element that specifies the time at which the event is to be executed. This is a required element.
EVENTACTION	only one	Container element that specifies the event action to be executed. This is a required element.
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 or not.
`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 hr hh:mm notation) at which the event should be run. This is a required element. 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 time(s). This is an optional sub element of `EVENTACTION`.