About This Guide

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

This guide provides a reference of the NSAPI functions you can use to define new plugins.

This preface contains information about the following topics:

Who Should Use This Guide

How This Guide Is Organized

Documentation Conventions

Using the Documentation

Contacting Sun Technical Support

Third-Party Web Site References

Feedback

Who Should Use This Guide

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

Documentation Conventions

The following table lists the documentation conventions used in this guide.

Table 2 **Documentation Conventions**
Element	Usage
File and directory paths	Given in UNIX� format, with forward slashes separating directory names
Installation root directories	Indicated asinstall_dir.
Italic text	Titles, emphasis, terms
monospace text	Code examples, file names, path names, command names, programming language keywords, properties
iitalic monospace text	Variable path names, environment variables in paths

Using the Documentation

The Sun Java System Web Proxy Server 4.0.1 documentation is available in PDF and HTML formats at:
http://docs.sun.com/app/docs/coll/1311.1

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

Table 3 **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)
Creating custom Netscape Server Application Programmer’s Interface (NSAPI) plugins	NSAPI Developer’s Guide
Editing configuration files	Configuration File Reference

Contacting Sun Technical Support

For technical questions about this product not answered in the product documentation, go to:
http://www.sun.com/service/contacting

Third-Party Web Site References

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 and click "Send comments." Be sure to provide the document title and part number in the online form.

Previous Contents Index Next

Previous Contents Index Next
Sun Java System Web Proxy Server 4.0.1 Developer's Guide