Oracle iPlanet Web Proxy Server 4.0.14 Configuration File Reference

Route

The Route directive specifies information about where the proxy server should route requests.

icp-route

Applicable in Route-class directives.

The icp-route function tells the proxy server to use ICP to determine the best source for a requested object whenever the local proxy does not have the object.

Syntax

Route fn=icp-route
    redirect=yes|no

Parameters

The following table describes the parameter for the icp-route function.

Table 5–137 icp-route Parameters


Parameter	Description
`redirect`	Specifies whether the proxy server will send a redirect message back to the client telling it where to get the object. `yes` means the proxy will send a redirect message back to the client to tell it where to retrieve the requested object. `no` means the proxy will not send a redirect message to the client. Instead it will use the information from ICP to get the object.

pa-enforce-internal-routing

Applicable in Route-class directives.

The pa-enforce-internal-routing function enables internal routing through a proxy array. Internal routing occurs when a non PAC-enabled client routes requests through a proxy array.

Syntax

Route fn="pa_enforce_internal_routing"    redirect="yes|no"

Parameters

The following table describes the parameter for the pa-enforce-internal-routing function.

Table 5–138 pa-enforce-internal-routing parameters


Parameter	Description
`redirect`	Specifies whether clients requests will be redirected. Redirecting means that if a member of a proxy array receives a request that it should not service, it tells the client which proxy to contact for that request.

pa-set-parent-route

Applicable in Route-class directives.

The pa-set-parent-route function sets a route to a parent array.

Syntax

Route fn="pa_set_parent_route"

set-proxy-server

Applicable in Route-class directives.

The set-proxy-server function directs the proxy server to connect to another proxy for retrieving the current resource. It also sets the address and port number of the proxy server to be used.

Syntax

Route fn=set-proxy-server
     server=URL of other proxy server    host name=otherhost name
     port=number

Parameters

The following table describes parameters for the set-proxy-server function.

Table 5–139 set-proxy-server Parameters


Parameter	Description
`server`	URL of the other proxy server. If multiple server parameters are given, the proxy server will distribute load among the specified proxy servers. For compatibility with earlier releases, `hostname` and `port` may be specified instead of `server`.
`host name`	The name of the host on which the other proxy server is running.
`port`	The port number of the remote proxy server.

Example

Route fn=set-proxy-server
     host name=proxy.netscape.com
     port=8080

set-origin-server

Applicable in Route-class directives.

The set-origin-server function enables you to distributed load across a set of homogeneous HTTP origin servers by controlling which origin server the proxy server sends a request to.

Parameters

The following table describes parameters for the set-origin-server function.

Table 5–140 set-origin-server Parameters


Parameter	Description
server	URL of an origin server. If multiple server parameters are given, the proxy server will distribute load among the specified origin servers.
sticky-cookie	(Optional) Name of a cookie that, when present in a response, will cause subsequent requests to "stick" to that origin server. The default is `JSESSIONID`.
sticky-param	(Optional) Name of a URI parameter to inspect for route information. When the URI parameter is present in a request URI and its value contains a colon, ’:’, followed by a route ID, the request will "stick" to the origin server identified by that route ID. The default is `jsessionid`.
route-hdr	(Optional) Name of the HTTP request header used to communicate route IDs to origin servers. `set-origin-server` associates each origin server named by a server parameter with a unique route ID. Origin servers may encode this route ID in the URI parameter named by the sticky-param parameter to cause subsequent requests to "stick" to them. The default is `Proxy-jroute`.
route-cookie	(Optional) Name of the cookie generated by the proxy server when it encounters a sticky-cookie cookie in a response. The route-cookie cookie stores a route ID that enables the proxy server to direct subsequent requests back to the same origin server. The default is `JROUTE`.
rewrite-host	(Optional) Boolean that indicates whether the Host HTTP request header is rewritten to match the host specified by the server parameter. The default is `false`, meaning the Host header is not rewritten.
rewrite-location	(Optional) Boolean that indicates whether Location HTTP response headers that match the server parameter should be rewritten. The default is `true`, meaning matching Location headers are rewritten.
rewrite-content-location	(Optional) Boolean that indicates whether Content-location HTTP response headers that match the server parameter should be rewritten. The default is `true`, meaning matching Content-location headers are rewritten.
rewrite-headername	(Optional) Boolean that indicates whether `headername` HTTP response headers that match the server parameter should be rewritten, where `headername` is a user-defined header name. With the exception of the Location and Content-location headers, the default is `false`, meaning the `headername` header is not rewritten.

set-socks-server

Applicable in Route-class directives.

The set-socks-server directs the proxy server to connect to a SOCKS server for retrieving the current resource. It also sets the address and port number of the SOCKS server to be used.

Syntax

Route fn=set-socks-server
     host name=sockshost name
     port=number

Parameters

The following table describes parameters for the set-socks-server function.

Table 5–141 set-socks-server Parameters


Parameter	Description
`host name`	The name of the host on which the SOCKS server runs.
`port`	The port on which the SOCKS server listens.

Example

ObjectType fn=set-socks-server
     host name=socks.netscape.com
     port=1080

unset-proxy-server

Applicable in Route-class directives.

The unset-proxy-server function tells the proxy server not to connect to another proxy server to retrieve the current resource. This function nullifies the settings of any less specific set-proxy-server functions.

Syntax

Route fn=unset-proxy-server

unset-socks-server

Applicable in Route-class directives.

The unset-socks-server function tells the proxy server not to connect to a SOCKS server to retrieve the current resource. This function nullifies the settings of any less specific set-socks-server functions.

Syntax

Route fn=unset-socks-server