set-variable (Sun Java System Web Server 6.1 SP12 Administrator's Configuration File Reference)

Sun Java System Web Server 6.1 SP12 Administrator's Configuration File Reference

set-variable

Applicable in all stage directives.

The set-variable function enables you to change server settings based upon conditional information in a request. It can also be used to manipulate variables in parameter blocks with the following commands:

insert-pblock="name=value"

Adds a new value to the specified pblock.
set-pblock="name=value"

Sets a new value in the specified pblock, replacing any existing value(s) with the same name.
remove-pblock="name"

Removes all values with the given name from the specified pblock.

Note –

For more information about parameter blocks, see the Sun Java System Web Server 6.1 SP12 NSAPI Programmer’s Guide.

Syntax

stage fn="set-variable" [{insert|set|remove}-pblock="name=value" ...][name="value" ...]

Parameters

The following table describes parameter values for the set-variable function.

Table 4–7 set-variable Parameter Values


Value	Description
pblock	One of the following Session/Request parameter block names: `client`: Contains the IP address of the client machine and the DNS name of the remote machine. For more information, see the description of the `Session->client` function in the “Data Structure Reference” chapter of the Sun Java System Web Server 6.1 SP12 NSAPI Programmer’s Guide. `vars`: Contains the server's working variables, which includes anything not specifically found in the `reqpb`, `headers`, or `srvhdrs` pblocks. The contents of this pblock differ, depending upon the specific request and the type of SAF. `reqpb`: Contains elements of the HTTP request, which includes the HTTP method (GET, POST, and so on), the URI, the protocol (generally HTTP/1.0), and the query string. This pblock doesn’t usually change during the request-response process.`headers`: Contains all the request headers (such as `User-Agent`, I`f-Modified-Since`, and so on) received from the client in the HTTP request. This pblock doesn’t usually change during the request-response process. For more information about request headers, see the “Hypertext Transfer Protocol” chapter of the Sun Java System Web Server 6.1 SP12 NSAPI Programmer’s Guide. `srvhdrs`: Contains the response headers (such as `Server`, `Date`, `Content-type`, `Content-length`, and so on) that are to be sent to the client in the HTTP response. For more information about response headers, see the “Hypertext Transfer Protocol” chapter of the Sun Java System Web Server 6.1 SP12 NSAPI Programmer’s Guide. Note – For more information about parameter blocks, see the Sun Java System Web Server 6.1 SP12 NSAPI Programmer’s Guide.
name	The variable to set.
value	The string assigned to the variable specified by name.

Variables

The following tables lists variables supported by the set-variable SAF.

Table 4–8 Supported Variables


Parameter	Description
`abort`	A value of `true` indicates the result code should be set to `REQ_ABORTED`. Setting the result code to `REQ_ABORTED` will abort the current request and send an error to the browser. For information about result codes, see the “Creating Custom SAFs” chapter of the Sun Java System Web Server 6.1 SP12 NSAPI Programmer’s Guide.
`error`	Sets the error code to be returned in the event of an aborted browser request.
`escape`	A boolean value signifying whether a URL should be escaped using `util_uri_escape`. For information about `util_uri_escape`, see the “NSAPI Function Reference” chapter of the Sun Java System Web Server 6.1 SP12 NSAPI Programmer’s Guide.
`find-pathinfo-forward`	Path information after the file name in a URI. See find-pathinfo.
`http-downgrade`	HTTP version number (for example, 1.0).
`http-upgrade`	HTTP version number (for example, 1.0).
`keep-alive`	A boolean value that establishes whether a keep-alive request from a browser will be honored.
`name`	Specifies an additional named object in the `obj.conf` file whose directives will be applied to this request. See also assign-name.
`noaction`	A value of `true` indicates the result code should be set to `REQ_NOACTION`. For `AuthTrans`, `NameTrans`, `Service`, and `Error` stage SAFs, setting the result code to `REQ_NOACTION` indicates that subsequent SAFs in that stage should be allowed to execute. For information about result codes, see the “Creating Custom SAFs” chapter of the Sun Java System Web Server 6.1 SP12 NSAPI Programmer’s Guide.
`nostat`	Causes the server not to perform the `stat()` function for a URL when possible. See also assign-name.
`senthdrs`	A boolean value that indicates whether HTTP response headers have been sent to the client.
`ssl-unclean-shutdown`	A boolean value that can be used to alter the way SSL3 connections are closed. As this violates the SSL3 RFCs, you should only use this with great caution if you know that you are experiencing problems with SSL3 shutdowns.
`stop`	A value of `true` indicates the result code should be set to `REQ_PROCEED`. For `AuthTrans`, `NameTrans`, `Service`, and `Error` stage SAFs, setting the result code to `REQ_PROCEED` indicates that no further SAFs in that stage should be allowed to execute. For information about result codes, see the “Creating Custom SAFs” chapter of the Sun Java System Web Server 6.1 SP12 NSAPI Programmer’s Guide.
`url`	Redirect requests to a specified URL.

Examples

To deny HTTP keep-alive requests for a specific server class (while still honoring keep-alive requests for the other classes), add this AuthTrans directive to the obj.conf for the server class, and set the variable keep-alive to disabled:

AuthTrans fn="set-variable" keep-alive="disabled"

To cause that same server class to use HTTP/1.0 while the rest of the server classes use HTTP/1.1, the AuthTrans directive would be:

AuthTrans fn="set-variable" keep-alive="disabled" http-downgrade="true"
To insert an HTTP header into each response, add a NameTrans directive to obj.conf, using the insert-pblock command and specifying srvhdrs as your Session/Request parameter block.

For example, to insert the HTTP header P3P, you would add the following line to each request:

NameTrans fn="set-variable" insert-srvhdrs="P3P"
To terminate processing a request based upon certain URIs, use a <Client> tag to specify the URIs and an AuthTrans directive that sets the variable abort to true when there is a match. Your <Client> tag would be comparable to the following:

<Client uri="*(system32|root.exe)*">AuthTrans fn="set-variable" abort="true"</Client>

set-variable

Syntax

Parameters

Variables

Examples

See Also