General elements are as follows:
The SERVER element defines a server. SERVER is the root element. Only one SERVER element can exist in a server.xml file.
The following table describes subelements for the SERVER element.
Table 2–2 SERVER subelements
Element |
Required |
Description |
---|---|---|
Zero or more |
Specifies a property of the server |
|
One or more |
Defines one or more HTTP listen sockets |
|
Zero or one |
Defines mime type |
|
Zero or one |
References one or more ACL files |
|
Zero or more |
Defines the user database used |
|
Only one |
Configures NSFC parameters |
|
Zero or one |
Configures the disk cache parameters |
|
Zero or one |
Configures the system logging service |
|
Zero or more |
Configures events |
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. |
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 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"/>
The following table describes subelements for the PROPERTY element.
Table 2–4 PROPERTY subelements
Element |
Required |
Description |
---|---|---|
Zero or one |
Contains a text description of the property |
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 |
Contains a text description of the parent element.
None
None
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.
The following table describes subelements for the LOG element.
Table 2–6 LOG subelements
Element |
Required |
Description |
---|---|---|
Zero or more |
Specifies a property or a variable |
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. |
true |
(optional) If true, redirects stdout output to the errors log. Valid values are on, off, yes, no, 1, 0, true, false. |
|
true |
(optional) If true, redirects stderr output to the errors log. Valid values are on, off, yes, no, 1, 0, true, false. |
|
true |
(optional, UNIX only) If true, redirects log messages to the console. |
|
false |
(optional, Windows only) If true, creates a Windows console. Valid values are on, off, yes, no, 1, 0, true, false. |
|
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. |
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.
The following table describes subelements for the EVENT element.
Table 2–8 EVENT subelements
Element |
Required |
Description |
---|---|---|
Zero or one |
Descriptive text about the event. Used for informational purposes. This element is optional. |
|
Only one |
Container element that specifies the time at which the event is to be executed. This element is required. |
|
Only one |
Container element that specifies the event action to be executed. This element is required. |
|
Zero or more |
Specifies a property or a variable. |
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 |
Container element that specifies the time at which the event is to be executed. This is a required element.
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. |
Container element that specifies the event action to be executed.
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. |