Skip Headers
Oracle® iPlanet Web Proxy Server Release Notes
Release 4.0.16

Part Number E18782-01
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Index
Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

3 Product Documentation

The Proxy Server 4.0 documentation is provided in a number of ways:

Oracle iPlanet Web Proxy Server 4.0.14 is the last release for which the entire documentation set for Oracle iPlanet Web Proxy Server 4.0 was updated. Subsequent to the 4.0.14 release, updates and corrections to Oracle iPlanet Web Proxy Server 4.0 documentation are provided in this Release Notes document; see Section 3.2, "Corrections and Updates to 4.0.14 Manuals."

This chapter includes the following sections:

3.1 Documentation Set

The Oracle iPlanet Web Proxy Server 4.0.14 documentation is available at:

http://download.oracle.com/docs/cd/E19438-01/

For an introduction to Oracle iPlanet Web Proxy Server, read the books in the order in which they are listed in Table 3-1.

Table 3-1 Proxy Server 4.0.14 Documentation Set

Document Title Contents

Oracle® iPlanet Web Proxy Server 4.0.15 Release Notes (this document)

Summarizing the Proxy Server release:

  • Late-breaking information about the software and the documentation

  • New features

  • Supported platforms and environments

  • System requirements

  • Known issues and workarounds

Installation and Migration Guide

Performing installation and migration tasks:

  • Installing Proxy Server

  • Migrating from release 3.6 to release 4.0

Administration Guide

Performing administration and management tasks:

  • Using the administration and command-line interfaces

  • Configuring server preferences

  • Managing users and groups

  • Monitoring and logging server activity

  • Using certificates and public key cryptography to secure the server

  • Controlling server access

  • Proxying and routing URLs

  • Caching

  • Filtering content

  • Using a reverse proxy

  • Using SOCKS

Configuration File Reference

Editing configuration files

NSAPI Developer's Guide

Creating custom Netscape Server Application Programming Interface (NSAPI) plugins

Performance Tuning, Sizing, and Scaling Guide

Tuning Proxy Server to optimize performance


3.2 Corrections and Updates to 4.0.14 Manuals

The following sections describe corrections and updates to Oracle iPlanet Web Proxy Server 4.0.14 manuals:

3.2.1 Increase in the Maximum Cache Capacity

The "Setting Cache Capacity" section of the Oracle iPlanet Web Proxy Server 4.0.13 Administration Guide mentions that the cache capacity can be up to a maximum of 32 GB.

Starting from the 4.0.10 release, the maximum cache capacity that can be configured through the administration interface is 128 GB.

Note:

You can manually configure the cache capacity to any value higher than 128 GB (no upper limit) by editing the server.xml configuration file. But if you opt for the manual configuration route and want to set the cache capacity to a value that is less than 128 GB, then only the following values are allowed: 125, 250, 500, 1000, 2000, 4000, 8000, 16000, 32000, 64000, 128000.

3.2.2 %Req->vars.xfer-time% Option of the flex-init Function

In the "Log Format" section of the Oracle iPlanet Web Proxy Server 4.0.14 Configuration File Reference, Table 5-4 lists the available flexible logging options. The %Req->vars.xfer-time% option is missing from the list.

The %Req->vars.xfer-time% option can be used to log the transfer time (in seconds).

3.2.3 clf-request-leading-whitespace Parameter of the flex-log SAF

Proxy Server 4.0.16 supports a new parameter, clf-request-leading-whitespace, for the flex-log SAF of the AddLog directive. The following table provides information about the new parameter.

Parameter Description
clf-request-leading-whitespace (Optional) A boolean value indicating whether leading newlines in request lines should be removed before printing to the server access log.

The default value is yes.

Example:

AddLog fn="flex-log" name="access" clf-request-leading-whitespace="no"

For information about the other parameters of the flex-log SAF, see the "flex-log" section of the Oracle iPlanet Web Proxy Server 4.0.14 Configuration File Reference.

3.2.4 New Parameters of the um-define-junction SAF

Table 3-2 lists new parameters added for the um-define-junction SAF of the Init directive since the 4.0.14 release. Note that these parameters are not documented in the Oracle iPlanet Web Proxy Server 4.0.14 Configuration File Reference.

Table 3-2 New Parameters of the um-define-junction SAF

Parameter Added in Release Description

set-cookie-domain-from and set-cookie-domain-to

4.0.16

(Optional) These parameters can be used to specify the target and destination values for rewriting the domain parameter of Set-cookie: headers received from backend servers.

rewrite-set-cookie-domain

4.0.16

(Optional) If this parameter is set to true, the domain parameter of Set-cookie: headers received from backend servers are rewritten to the domain of the proxy server.

The default value is false.

insert-set-cookie-domain

4.0.16

(Optional) This parameter can be used to insert a domain parameter into Set-cookie: headers received from backend servers.

set-cookie-path-from and set-cookie-path-to

4.0.16

(Optional) These parameters can be used to specify the target and destination values for rewriting the path parameter of Set-cookie: headers received from backend servers.

disable-javascript-rewrite

4.0.15

(Optional) A regular expression matched against the names of JavaScript variables when the has-javascript parameter is set to yes. Variables whose names match the regular expression are not rewritten (as they typically would be with has-javascript set to yes). There is no default value for this parameter.


3.2.5 Clarification About Unit of Time Used for the %duration% Log Option

According to the "Log Format" section of the Oracle iPlanet Web Proxy Server 4.0.14 Configuration File Reference, the %duration% option indicates the time the server spent handling the request in microseconds.

Note the following clarification:

  • On Solaris and AIX, the server calculates and records the time in microseconds.

  • However, on Windows, HP-UX, and Linux, the server calculates the time in milliseconds and records it in microseconds.

3.2.6 Clarification About the Need to Explicitly Select New Directory Services

The "Configuring Directory Services" section of the Oracle iPlanet Web Proxy Server 4.0.14 Administration Guide describes how to create a directory service. Note that if you want to use the new directory service with a specific proxy server instance, you must select it as described in the "Selecting Directory Services" section.

3.2.7 Information About the admin.conf File

The admin.conf file, located in the install-dir/proxyadmserv/config directory, is an internal configuration file that Proxy Server maintains. Do not modify this file.

3.2.8 Date and Time Parameters of the <Client> Tag

Oracle iPlanet Web Proxy Server 4.0.15 supports several new parameters for the <Client> tag, as described in the following table.

Parameter Description
date-start and date-end These two parameters specify the start date and end date, respectively, for a time interval. They take values of the format of the UNIX date command, excluding the time zone specification. Additionally, the weekday portion of the date command format is optional.
day-start and day-end These two parameters specify the start day number and end day number, respectively, for a day interval in a month. They take values in the range 1 through 31.
month-start and month-end These two parameters specify the start month and end month, respectively, for a month interval in a year. They take the values Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, and Dec.
time-start and time-end These two parameters specify the start time and end time, respectively, for a time interval in a day. They take values of the form hour:minute:second on a 24-hour clock.
weekday-start and weekday-end These two parameters specify the start day and end day, respectively, for a day interval in a week. They take the values Sun, Mon, Tue, Wed, Thu, Fri, and Sat.

Examples

  • This example specifies a time interval of every Tuesday through Friday from 9:00 AM through 5:00 PM:

    <Client weekday-start="Tue" weekday-end="Fri" time-start="09:00:00" time-end="17:00:00">
    
  • This example specifies a time interval of the first through the fifteenth of every month from 12:00 AM through 4:00 AM:

    <Client day-start="1" day-end="15" time-start="00:00:00" time-end="04:00:00">
    

3.2.9 forward-unread-request-body Parameter of the http-client-config SAF

The section "http-client-config" in Oracle iPlanet Web Proxy Server 4.0.14 Configuration File Reference does not include information about the forward-unread-request-body parameter, which became available in Proxy Server 4.0.14. The following table provides information about this parameter.

Parameter Description
forward-unread-request-body (Optional) A Boolean operator that indicates whether a request body that arrives in a TCP packet separate from the request header should be forwarded to the server of origin. The default value is false, meaning that request bodies arriving in TCP packets separate from their request headers are not forwarded to the server of origin.

3.2.10 <Include> Tag in the obj.conf File

Proxy Server 4.0.15 supports a new tag in the obj.conf file. This tag, <Include>, includes the content of another file in the obj.conf file, effectively enabling you to divide the content of obj.conf across several files to make management of your configuration easier.

The syntax of the <Include> tag is:

<Include>
  filename
</Include>

filename is the name of the file to be included in the obj.conf file where the <Include> tag occurs.

When using the <Include> tag, keep these points in mind:

  • The <Include> tag can be used outside the context of <Object>. For example, you could put all the Init directives in a file and then include that file at the start of the obj.conf. file.

  • An included file can contain other included files; that is, an included file can itself contain an <Include> tag.

  • An included file cannot cross <Object> boundaries; that is, included file cannot end one object and start another.

3.2.11 lookup-ipv6-first Parameter of the dns-config SAF

Proxy Server 4.0.15 supports a new parameter, lookup-ipv6-first, for the dns-config SAF of the DNS directive. The following table provides information about this new parameter.

Parameter Description
lookup-ipv6-first (Optional) A Boolean operator that specifies whether to look up IPv6 or IPv4 addresses first. The default value is false, meaning that IPv4 addresses are looked up first.

3.2.12 regexp-redirect Function of the NameTrans Directive

The section "NameTrans" in Oracle iPlanet Web Proxy Server 4.0.14 Configuration File Reference does not include information about the regexp-redirect function. Information about this function follows.

The regexp-redirect function is applicable in NameTrans-class directives.

The regexp-redirect function enables you to change URLs and send the updated URL to the client. When a client accesses your server with an old path, the server treats the request as a request for the new URL.

The following table describes parameters for the regexp-redirect function.

Parameter Description
from A regular expression for the prefix of the requested URL to match.
url/url-prefix url specifies a complete URL to return to the client. url-prefix specifies the new URL prefix to return to the client. The from prefix is simply replaced by this URL prefix. You cannot use these parameters together.
escape (Optional) A Flag that tells the server to use the util_uri_escape action on the URL before sending it. It should be yes or no. The default is yes.

For more information about util_uri_escape, see Oracle iPlanet Web Proxy Server 4.0.14 NSAPI Developer's Guide.

bucket (Optional) This is common to all obj.conf functions.

3.2.13 status-code and status-desc Parameters of the send-error SAF

Proxy Server 4.0.15 supports two new parameters for the send-error SAF of the Service and Error directives. The following table provides information about these new parameters.

Parameter Description
status-code (Optional) Specifies a status code to be set in the HTTP response. It differs from the code parameter in that code specifies which error code triggers execution of the send-error SAF, while status-code specifies a status code to be set in the response generated by the send-error SAF.
status-desc (Optional) Specifies a reason string for the status code.

3.2.14 New Directives in the magnus.conf File

Table 3-3 lists directives added to the magnus.conf file. Note that these directives are not documented in "Syntax and Use of the magnus.conf File" in Oracle iPlanet Web Proxy Server 4.0.14 Configuration File Reference.

Table 3-3 magnus.conf Directives

Parameters Valid Values Description

ChannelPoolMonitorInterval

Any number of seconds

(Added in 4.0.14 release.) Specify how frequently (in seconds) Proxy Server checks the channel pool for stale or closed connections. This value is used when ChannelPoolValidate is set to true. The default value is 30.

ChannelPoolValidate

true, false

(Added in 4.0.14 release.) Cause Proxy Server to actively check the channel pool for stale or closed connections every ChannelPoolMonitorInterval seconds. The default value is false.

ChannelReuseValidate

true, false

(Added in 4.0.14 release.) Cause Proxy Server to validate channels in the channel pool before reusing them. The default value is false.

FtpPoolSize

1 to 65536

(Added in 4.0.12 release.) Specify the size of the FTP connection pool. The default value is 256.

FtpPoolLife

1 to 65536

(Added in 4.0.12 release.) Specify the life of the connection in seconds, that the FTP connection remain unused in the pool before the monitor thread closes it. The default value is 3600.

FtpPoolMonitorThread

OFF

(Added in 4.0.12 release.) Specify the boolean value to monitor the FTP thread functionality. The default is ON.

FtpPoolMonitorLevel

0

(Added in 4.0.12 release.) Specify an integer value. If set to 0 the pool monitor thread checks whether the connection is inactive or active.

If set to 1, the NOOP command is sent to the connection and awaits for the reply. Failure to get a response will cause the connection to be removed from the pool. The default level is 1.

FtpPoolMonitorInterval

30 to 65536

(Added in 4.0.12 release.) Specify an integer value in seconds, after which the pool connections are monitored. The default value is 30.

LDAPPoolMonitorThread

Takes a Boolean value.

(Added in 4.0.12 release.) If set to TRUE, an ldap pool monitor thread would be created, which monitors the ldap connection pool at regular intervals. The default value is FALSE.

LDAPPoolMonitorInterval

Takes an integer argument.

(Added in 4.0.12 release.) Specify the interval at which the ldap pool monitor thread inspects the ldap connection pool. The default value is 30.

LDAPPoolRevalidate

Takes a boolean value.

(Added in 4.0.12 release.) Revalidate the connection if set to TRUE for every connection that is picked off the connection pool; then pass on to the caller. The default value is FALSE.

RouteOfflineCheckInterval

Takes an integer value.

(Added in 4.0.15 release.) Specify the interval, in seconds, at which Proxy Server checks performance of the gateways marked as offine by the routing subsystem. The default value is 30.


3.3 Documentation, Support, and Training

The Oracle web site provides information about the following additional resources: