Sun Java System Web Proxy Server 4.0.2 2005Q4 Configuration File Reference

Summary of Init Functions

The following table lists the Init functions available in the obj.conf file:

Table 5–26 Init functions

Function/Parameter  

Allowed Values  

Default Value  

Description  

define-perf-bucket

   

Creates a performance bucket, which you can use to measure the performance of SAFs in obj.conf (see the Sun Java system Web Proxy Server NSAPI Developer’s Guide). This function works only if the perf-init function is enabled.

name

   

A name for the bucket, for example cgi-bucket.

description

   

A description of what the bucket measures, for example CGI Stats.

dns-cache-init

   

Configures DNS caching. 

cache-size

32 to 32768 (32K)

1024

(optional) Specifies how many entries are contained in the cache. 

expire

1 to 31536000 seconds (1 year)

1200 seconds (20 minutes)

(optional) specifies how long (in seconds) it takes for a cache entry to expire. 

flex-init

   

Initializes the flexible logging system. 

logFileName

A path or file name 

 

The full path to the log file or a file name relative to the server’s logs directory. In this example, the log file name is access and the path is /logdir/access:

access="/logdir/access"

format.logFileName

   

Specifies the format of each log entry in the log file. 

relaxed.logFileName

true, on, yes, or 1;false, off, no, or 0

 

Turns on relaxed logging, which skips logging components that would normally block static page acceleration if static page acceleration is enabled. 

buffer-size

Number of bytes 

8192

Specifies the size of the global log buffer. 

buffers-per-file

The lower bound is 1. There always needs to be at least one buffer per file. 

The upper bound is dictated by the number of buffers that exist. The upper bound on the number of buffers that exist can be defined by the num-buffers parameter. 

Determined by the server 

Specifies the number of buffers for a given log file 

num-buffers

 

1000

Specifies the maximum number of logging buffers to use. 

thread-buffer-size

Number of bytes 

8192 (8 KB)

Specifies the size of the per thread log buffer. 

flex-rotate-init

   

Enables rotation for logs. 

rotate-start

A 4-digit string indicating the time in 24-hour format 

 

Indicates the time to start rotation. For example, 0900 indicates 9 am while 1800 indicates 9 pm. 

rotate-interval

Number of minutes 

 

Indicates the number of minutes to elapse between each log rotation. 

rotate-access

yes, no

yes

(optional) determines whether common-log, flex-log, and record-useragent logs are rotated. For more information, see the Sun Java System Web Proxy Server 4.0.2 NSAPI Developer’s Guide.

rotate-error

yes, no

yes

(optional) determines whether error logs are rotated. 

rotate-callback

A path 

 

(optional) specifies the file name of a user-supplied program to execute following log file rotation. The program is passed the post-rotation name of the rotated log file as its parameter. 

init-cgi

   

Changes the default settings for CGI programs. 

timeout

Number of seconds 

300

(optional) specifies how many seconds the server waits for CGI output before terminating the script. 

cgistub-path

   

(optional) specifies the path to the CGI stub binary. If not specified, iPlanet Web Server looks in the following directories, in the following order, relative to the server instance’s config directory: ../private/Cgistub, then ../../bin/https/bin/Cgistub.

For information about installing an suid Cgistub, see the Sun Java System Web Proxy Server 4.0.2 NSAPI Developer’s Guide.

env-variable

   

(optional) specifies the name and value for an environment variable that the server places into the environment for the CGI. 

init-clf

   

Initializes the Common Log subsystem. 

logFileName

A path or file name 

 

Specifies either the full path to the log file or a file name relative to the server’s logs directory.

init-uhome

   

Loads user home directory information. 

pwfile

   

(optional) specifies the full file system path to a file other than /etc/passwd. If not provided, the default UNIX path (/etc/passwd) is used.

load-modules

   

Loads shared libraries into the server. 

shlib

   

Specifies either the full path to the shared library or dynamic link library or a file name relative to the server configuration directory. 

funcs

A comma separated list with no spaces 

 

A list of the names of the functions in the shared library or dynamic link library to be made available for use by other Init or Service directives. The dash (-) character may be used in place of the underscore (_) character in function names.

NativeThread

yes, no

yes

(optional) specifies which threading model to use. no causes the routines in the library to use user-level threading. yes enables kernel-level threading.

pool

 

 

The name of a custom thread pool, as specified in thread-pool-init.

nt-console-init

   

Enables the NT console, which is the command-line shell that displays standard output and error streams. 

stderr

console

 

Directs error messages to the NT console. 

stdout

console

 

Directs output to the NT console. 

perf-init

   

Enables system performance measurement via performance buckets. 

disable

true, false

true

Disables the function when true.

pool-init

   

Configures pooled memory allocation. 

free-size

1048576 bytes or less

 

(optional) maximum size in bytes of free block list. 

disable

true, false

false

(optional) flag to disable the use of pooled memory if true.

register-http-method

   

Lets you extend the HTTP protocol by registering new HTTP methods. 

methods

A comma separated list 

 

Names of the methods you are registering. 

stats-init

   

Enables reporting of performance statistics in XML format. 

profiling

yes, no

no

Enables NSAPI performance profiling using buckets. This can also be enabled through perf-init.

update-interval

1 or greater

5

The period in seconds between statistics updates within the server. 

virtual-servers

1 or greater

1000

The maximum number of virtual servers for which statistics are tracked. This number should be set higher than the number of virtual servers configured. 

thread-pool-init

   

Configures an additional thread pool. 

name

   

Name of the thread pool. 

maxthreads

   

Maximum number of threads in the pool. 

minthreads

   

Minimum number of threads in the pool. 

queueSize

Number of bytes 

 

Size of the queue for the pool. 

stackSize

Number of bytes 

 

Stack size of each thread in the native (kernel) thread pool.