Oracle iPlanet Web Proxy Server 4.0.15 Release Notes

Product Documentation

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

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

The Proxy Server 4.0.14 documentation set is available at http://docs.sun.com/coll/1311.14. For an introduction to Proxy Server, refer to the books in the order in which they are listed in the following table.

Table 2 iPlanet Web Proxy Server 4.0.14 Documentation Set

Document Title 

Contents 

Release Notes

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 iPlanet Web Proxy Server

  • Migrating from version 3.6 to version 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 iPlanet Web Proxy Server to optimize performance  

Corrections and Updates to 4.0.14 Manuals

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

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.

Information About the Date and Time Parameters of the <Client> Tag

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

Information About the disable-javascript-rewrite Parameter of the um-define-junction SAF

Proxy Server 4.0.15 supports a new parameter, disable-javascript-rewrite, for the um-define-junction SAF of the Init directive. The following table provides information about this new parameter.

Parameter 

Description 

disable-javascript-rewrite 

(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 normally would be with has-javascript set to yes). There is no default value for this parameter.

Information About the 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) Boolean that indicates whether a request body that arrives in a TCP packet separate from the request header should be forwarded to the origin server. The default value is false, meaning that request bodies arriving in TCP packets separate from their request headers are not forwarded to the origin server.

Information About the <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>

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

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

Information About the 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) Boolean that specifies whether to look up IPv6 or IPv4 addresses first. The default value is false, meaning that IPv4 addresses are looked up first.

Information About the 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.

regexp-redirect

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.

Parameters

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

Parameter 

Description 

from

A regular expression for the prefix of the requested URI 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) Flag that tells the server to util_uri_escape 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) Common to all obj.conf functions.

Information About the 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.

Information About New Directives in the magnus.conf File

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

Table 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 – 65536

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

FtpPoolLife

1 – 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 dead or alive. 

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 – 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, a 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.) Specifies 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.) If set to TRUE, every connection that is picked off the connection pool will be "revalidated" before being passed on to the caller. The default value is FALSE.

RouteOfflineCheckInterval

Takes an integer value. 

(Added in 4.0.15 release.) Specifies the interval, in seconds, at which Proxy Server performs a health check on gateways marked as offine by the routing subsystem. The default value is 30.

Documentation, Support, and Training

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

Searching Product Documentation

Besides searching product documentation from the docs.sun.com web site, you can use a search engine by typing the following syntax in the search field:


search-term site:docs.sun.com

For example, to search for “proxy,” type the following:


proxy site:docs.sun.com

To include other Oracle web sites in your search (for example, java.sun.com, www.sun.com, and developers.sun.com), use sun.com in place of docs.sun.com in the search field.

Third-Party Web Site References

Third-party URLs are referenced in this document and provide additional, related information.


Note –

Oracle is not responsible for the availability of third-party web sites mentioned in this document. Oracle does not endorse and is not responsible or liable for any content, advertising, products, or other materials that are available on or through such sites or resources. Oracle will not be responsible or liable for any actual or alleged damage or loss caused or alleged to be caused by or in connection with use of or reliance on any such content, goods, or services that are available on or through such sites or resources.