Sun Java System Web Proxy Server 4.0.11 NSAPI Developer's Guide

Preface

This guide describes how to configure and administer the Sun Java^TM System Web Proxy Server 4, formerly known as Sun ONE^TM Web Proxy Server and iPlanet^TM Web Proxy Server and hereafter referred to as Sun Java System Web Proxy Server or just Proxy Server.

Who Should Use This Book

The intended audience for this guide is the person who develops, assembles, and deploys NSAPI plug-ins in a corporate enterprise. This guide assumes you are familiar with the following topics:

HTTP
HTML
NSAPI
C programming
Software development processes, including debugging and source code control

Before You Read This Book

Sun Java System Web Proxy Server can be purchased by itself or as a component of Sun Java Enterprise System, a software infrastructure that supports enterprise applications distributed across a network or Internet environment. If you purchased Sun Java System Web Proxy Server as a component of Java Enterprise System, you should be familiar with the system documentation at http://docs.sun.com/coll/1286.2.

How This Book Is Organized

The following table lists the chapters in the guide and their contents.

Table P–1 Guide Organization


Chapter	Description
Chapter 1, Creating Custom SAFs	This chapter discusses how to create your own plug-ins that define new SAFs to modify or extend the way the server handles requests.
Chapter 2, Creating Custom Filters	This chapter discusses how to create custom filters that you can use to intercept, and potentially modify, incoming content presented to or generated by another function.
Chapter 3, Examples of Custom SAFs and Filters	This chapter provides examples of custom SAFs to use at each stage in the request-handling process.
Chapter 4, NSAPI Function Reference	This chapter presents a reference of the NSAPI functions. You use NSAPI functions to define SAFs.
Chapter 5, Data Structure Reference	This chapter discusses some of the commonly used NSAPI data structures.
Chapter 6, Using Wildcard Patterns	This chapter lists the wildcard patterns you can use when specifying values in `obj.conf` and various predefined SAFs.
Chapter 7, Time Formats	This chapter lists time formats.
Chapter 8, Hypertext Transfer Protocol	This chapter gives an overview of HTTP.
Appendix A, Alphabetical List of NSAPI Functions and Macros	This appendix provides an alphabetical list of NSAPI functions and macros.

Proxy Server Documentation Set

The documentation set lists the Sun documents that are related to Proxy Server. The URL for Sun Java System Web Proxy Server 4.0.11 documentation is http://docs.sun.com/coll/1311.11. For an introduction to Proxy Server, refer to the books in the order in which they are listed in the following table.

Table P–2 Sun Java System Web Proxy Server Documentation


Document Title	Contents
Sun Java System Web Proxy Server 4.0.11 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
Sun Java System Web Proxy Server 4.0.11 Installation and Migration Guide	Performing installation and migration tasks: Installing Sun Java System Web Proxy Server Migrating from version 3.6 to version 4
Sun Java System Web Proxy Server 4.0.11 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
Sun Java System Web Proxy Server 4.0.11 Configuration File Reference	Editing configuration files
Sun Java System Web Proxy Server 4.0.11 NSAPI Developer’s Guide	Creating custom Netscape Server Application Programmer’s Interface (NSAPI) plug-ins
Sun Java System Web Proxy Server 4.0.11 Performance Tuning, Sizing, and Scaling Guide	Tuning Sun Java System Web Proxy Server to optimize performance

Related Books

The URL for all documentation about Sun Java Enterprise System (Java ES) and its components is http://docs.sun.com/prod/entsys.5.

Default Paths and File Names

The following table describes the default paths and file names that are used in this book.

Table P–3 Default Paths and File Names


Placeholder	Description	Default Value
`install-dir`	Represents the base installation directory for Sun Java System Web Proxy Server.	Solaris and Linux installations: /opt/sun/proxyserver40 Windows installations: \Sun\ProxyServer40

Typographic Conventions

The following table describes the typographic changes that are used in this book.

Table P–4 Typographic Conventions


Typeface	Meaning	Example
`AaBbCc123`	The names of commands, files, and directories, and onscreen computer output	Edit your `.login` file. Use `ls -a` to list all files. `machine_name% you have mail.`
`AaBbCc123`	What you type, contrasted with onscreen computer output	`machine_name%` `su` `Password:`
`AaBbCc123`	A placeholder to be replaced with a real name or value	The command to remove a file is `rm` `filename`.
AaBbCc123	Book titles, new terms, and terms to be emphasized (note that some emphasized items appear bold online)	Read Chapter 6 in the User's Guide. A cache is a copy that is stored locally. Do not save the file.

Shell Prompts in Command Examples

The following table shows default system prompts and superuser prompts.

Table P–5 Shell Prompts


Shell	Prompt
C shell on UNIX and Linux systems	`machine_name%`
C shell superuser on UNIX and Linux systems	`machine_name#`
Bourne shell and Korn shell on UNIX and Linux systems	`$`
Bourne shell and Korn shell superuser on UNIX and Linux systems	`#`
Microsoft Windows command line	`C:\`

Symbol Conventions

The following table explains symbols that might be used in this book.

Table P–6 Symbol Conventions


Symbol	Description	Example	Meaning
`[ ]`	Contains optional arguments and command options.	`ls [-l]`	The `-l` option is not required.
`{ \| }`	Contains a set of choices for a required command option.	`-d {y\|n}`	The `-d` option requires that you use either the `y` argument or the `n` argument.
`${ }`	Indicates a variable reference.	`${com.sun.javaRoot}`	References the value of the `com.sun.javaRoot` variable.
-	Joins simultaneous multiple keystrokes.	Control-A	Press the Control key while you press the A key.
+	Joins consecutive multiple keystrokes.	Ctrl+A+N	Press the Control key, release it, and then press the subsequent keys.
->	Indicates menu item selection in a graphical user interface.	File -> New -> Templates	From the File menu, choose New. From the New submenu, choose Templates.

Documentation, Support, and Training

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

Documentation (http://www.sun.com/documentation/)
Support (http://www.sun.com/support/)
Training (http://www.sun.com/training/)

Searching Sun Product Documentation

Besides searching Sun product documentation from the docs.sun.com^SM 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 “broker,” type the following:

broker site:docs.sun.com

To include other Sun 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 –

Sun is not responsible for the availability of third-party web sites mentioned in this document. Sun 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. Sun 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.

Sun Welcomes Your Comments

Sun is interested in improving its documentation and welcomes your comments and suggestions. To share your comments, go to http://docs.sun.com and click Feedback.