Sun Java System Web Proxy Server 4.0.2 2005Q4 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 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 plugins 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

How This Book Is Organized

The guide is divided into parts, each of which addresses specific areas and tasks. The following table lists the parts of 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 plugins 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 your own 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 describes 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.

Related Books

The Sun documents that are related to this manual are:

Sun Java System Web Proxy Server 4.0.2 Release Notes
Sun Java System Web Proxy Server 4.0.2 Installation and Migration Guide
Sun Java System Web Proxy Server 4.0.2 Administration Guide
Sun Java System Web Proxy Server 4.0.2 Configuration File Reference

The following table lists the tasks and concepts described in guide.

Table P–2 Proxy Server Documentation


For Information About	See
Late-breaking information about the software and documentation	Release Notes
Performing installation and migration tasks: Supported platforms and environments Installing Sun Java System Web Proxy Server Migrating from version 3.6 to version 4	Installation and Migration 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 Tuning the Proxy Server to optimize performance	Administration Guide (and the online Help included with the product)
Editing configuration files	Configuration File Reference

Related 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.

Feedback

Sun is interested in improving its documentation and welcomes your comments and suggestions. To share your comments, go to http://docs.sun.com/app/docs and click “Send comments.” Be sure to provide the document title and part number in the online form.

Documentation, Support, and Training

Sun Function	URL	Description
Documentation	`http://www.sun.com/documentation/`	Download PDF and HTML documents, and order printed documents
Support and Training	`http://www.sun.com/support/` `http://www.sun.com/training/`	Obtain technical support, download patches, and learn about Sun courses

Sun Function

URL

Description

Documentation

http://www.sun.com/documentation/

Download PDF and HTML documents, and order printed documents

Support and Training

http://www.sun.com/support/

http://www.sun.com/training/

Obtain technical support, download patches, and learn about Sun courses

Typographic Conventions

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

Table P–3 Typographic Conventions


Typeface or Symbol	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`	Placeholder: replace 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	Read Chapter 6 in the User's Guide. Perform a patch analysis. Do not save the file. [Note that some emphasized items appear bold online.]

Shell Prompts in Command Examples

The following table shows the default system prompt and superuser prompt for the C shell, Bourne shell, and Korn shell.

Table P–4 Shell Prompts


Shell	Prompt
C shell prompt	`machine_name%`
C shell superuser prompt	`machine_name#`
Bourne shell and Korn shell prompt	`$`
Bourne shell and Korn shell superuser prompt	`#`