Documentation Home
> Sun Java System Web Proxy Server 4.0.5 NSAPI Developer's Guide
Sun Java System Web Proxy Server 4.0.5 NSAPI Developer's Guide
Book Information
Index
A
B
C
D
E
F
G
H
I
L
M
N
O
P
Q
R
S
T
U
V
W
Preface
Chapter 1 Creating Custom SAFs
Future Compatibility Issues
SAF Interface
SAF Parameters
pb (parameter block)
sn (session)
rq (request)
Result Codes
Creating and Using Custom SAFs
To create a custom SAF
Writing the Source Code
Compiling and Linking
Include Directory and nsapi.h File
Linker Libraries
Linker Commands and Options for Generating a Shared Object
Additional Linker Flags
Compiler Flags
Loading and Initializing the SAF
Instructing the Server to Call the SAFs
Restarting the Server
Testing the SAF
Overview of NSAPI C Functions
Parameter Block Manipulation Routines
Protocol Utilities for Service SAFs
Memory Management
File I/O
Network I/O
Threads
Utilities
Required Behavior of SAFs for Each Directive
Init SAFs
AuthTrans SAFs
NameTrans SAFs
PathCheck SAFs
ObjectType SAFs
Input SAFs
Output SAFs
Service SAFs
Error SAFs
AddLog SAFs
Connect
DNS
Filter
Route
CGI to NSAPI Conversion
Chapter 2 Creating Custom Filters
Future Compatibility Issues
NSAPI Filter Interface
Filter Methods
C Prototypes for Filter Methods
insert
See Also
remove
See Also
flush
See Also
read
See Also
write
See Also
writev
See Also
sendfile
See Also
Position of Filters in the Filter Stack
Filters That Alter Content-Length
Creating and Using Custom Filters
To create a custom filter
Writing the Source Code
Compiling and Linking
Loading and Initializing the Filter
Instructing the Server to Insert the Filter
Restarting the Server
Testing the Filter
Overview of NSAPI Functions for Filter Development
Chapter 3 Examples of Custom SAFs and Filters
Examples in the Build
AuthTrans Example
Installing the AuthTrans Example
AuthTrans Example Source Code
NameTrans Example
Installing the NameTrans Example
NameTrans Example Source Code
PathCheck Example
Installing the PathCheck Example
PathCheck Example Source Code
ObjectType Example
Installing the ObjectType Example
ObjectType Example Source Code
Output Example
Installing the Output Example
Output Example Source Code
Service Example
Installing the Service Example
Service Example Source Code
More Complex Service Example
AddLog Example
Installing the AddLog Example
AddLog Example Source Code
Chapter 4 NSAPI Function Reference
NSAPI Functions (in Alphabetical Order)
C
cache_digest
Syntax
Returns
Parameters
See Also
cache_filename
See Also
cache_fn_to_dig
Syntax
Returns
Parameters
CALLOC
Syntax
Returns
Parameters
Example
See Also
ce_free
Syntax
Returns
Parameters
See Also
ce_lookup
Syntax
Returns
Parameters
See Also
cif_write_entry
Syntax
Returns
Parameters
cinfo_find
Syntax
Returns
Parameters
condvar_init
Syntax
Returns
Parameters
See Also
condvar_notify
Syntax
Returns
Parameters
See Also
condvar_terminate
Warning
Syntax
Returns
Parameters
See Also
condvar_wait
Syntax
Returns
Parameters
See Also
crit_enter
Syntax
Returns
Parameters
See Also
crit_exit
Syntax
Returns
Parameters
See Also
crit_init
Warning
Syntax
Returns
Parameters
See Also
crit_terminate
Syntax
Returns
Parameters
See Also
D
daemon_atrestart
Syntax
Returns
Parameters
Example
dns_set_hostent
Syntax
Returns
Parameters
Example
F
fc_close
Syntax
Returns
Parameters
fc_open
Syntax
Returns
Parameters
filebuf_buf2sd
Syntax
Returns
Parameters
Example
See Also
filebuf_close
Syntax
Returns
Parameters
Example
See Also
filebuf_getc
Syntax
Returns
Parameters
See Also
filebuf_open
Syntax
Returns
Parameters
Example
See Also
filebuf_open_nostat
Syntax
Returns
Parameters
Example
See Also
filter_create
Syntax
Returns
Parameters
Example
filter_find
Syntax
Returns
Parameters
filter_insert
Syntax
Returns
Parameters
filter_layer
Syntax
Returns
Parameters
filter_name
Syntax
Returns
Parameters
filter_remove
Syntax
Returns
Parameters
flush
Syntax
Returns
Parameters
Example
See Also
FREE
Syntax
Returns
Parameters
Example
See Also
fs_blk_size
Syntax
Returns
Parameters
See Also
fs_blks_avail
Syntax
Returns
Parameters
See Also
func_exec
Syntax
Returns
Parameters
See Also
func_find
Syntax
Returns
Parameters
Example
See Also
func_insert
Syntax
Returns
Parameters
Example
See Also
I
insert
Syntax
Returns
Parameters
Example
L
log_error
Syntax
Returns
Parameters
Example
See Also
M
magnus_atrestart
Syntax
Returns
Parameters
Example
MALLOC
Syntax
Returns
Parameters
Example
See Also
N
net_flush
Syntax
Returns
Parameters
Example
See Also
net_ip2host
Syntax
Returns
Parameters
net_read
Syntax
Returns
Parameters
See Also
net_sendfile
Syntax
Returns
Parameters
Example
See Also
net_write
Syntax
Returns
Parameters
Example
See Also
netbuf_buf2sd
Syntax
Returns
Parameters
See Also
netbuf_close
Syntax
Returns
Parameters
See Also
netbuf_getc
Syntax
Returns
Parameters
See Also
netbuf_grab
Syntax
Returns
Parameters
See Also
netbuf_open
Syntax
Returns
Parameters
See Also
nsapi_module_init
Syntax
Returns
Parameters
NSAPI_RUNTIME_VERSION
Syntax
Example
See Also
NSAPI_VERSION
Syntax
Example
See Also
P
param_create
Syntax
Returns
Parameters
Example
See Also
param_free
Syntax
Returns
Parameters
Example
See Also
pblock_copy
Syntax
Returns
Parameters
See Also
pblock_create
Syntax
Returns
Parameters
See Also
pblock_dup
Syntax
Returns
Parameters
See Also
pblock_find
Syntax
Returns
Parameters
See Also
pblock_findlong
Syntax
Returns
Parameters
See Also
pblock_findval
Syntax
Returns
Parameters
Example
See Also
pblock_free
Syntax
Returns
Parameters
See Also
pblock_nlinsert
Syntax
Returns
Parameters
See Also
pblock_nninsert
Syntax
Returns
Parameters
See Also
pblock_nvinsert
Syntax
Returns
Parameters
Example
See Also
pblock_pb2env
Syntax
Returns
Parameters
See Also
pblock_pblock2str
Syntax
Returns
Parameters
See Also
pblock_pinsert
Syntax
Returns
Parameters
See Also
pblock_remove
Syntax
Returns
Parameters
See Also
pblock_replace_name
Syntax
Returns
Parameters
See Also
pblock_str2pblock
Syntax
Returns
Parameters
See Also
PERM_CALLOC
Syntax
Returns
Parameters
Example
See Also
PERM_FREE
Syntax
Returns
Parameters
Example
See Also
PERM_MALLOC
Syntax
Returns
Parameters
Example
See Also
PERM_REALLOC
Warning
Syntax
Returns
Parameters
Example
See Also
PERM_STRDUP
Syntax
Returns
Parameters
See Also
prepare_nsapi_thread
Syntax
Returns
Parameters
See Also
protocol_dump822
Syntax
Returns
Parameters
See Also
protocol_finish_request
Syntax
Returns
Parameters
See Also
protocol_handle_session
Syntax
Parameters
See Also
protocol_parse_request
Syntax
Returns
Parameters
See Also
protocol_scan_headers
Syntax
Returns
Parameters
See Also
protocol_set_finfo
Syntax
Returns
Parameters
See Also
protocol_start_response
Syntax
Returns
Parameters
Example
See Also
protocol_status
Syntax
Returns
Parameters
Example
See Also
protocol_uri2url
Syntax
Returns
Parameters
See Also
protocol_uri2url_dynamic
Syntax
Returns
Parameters
See Also
R
read
Syntax
Returns
Parameters
Example
See Also
REALLOC
Warning
Syntax
Returns
Parameters
Example
See Also
remove
Syntax
Returns
Parameters
See Also
request_create
Syntax
Returns
Parameters
See Also
request_free
Syntax
Returns
Parameters
See Also
request_header
Syntax
Returns
Parameters
See Also
S
sem_grab
Syntax
Returns
Parameters
See Also
sem_init
Syntax
Returns
Parameters
See Also
sem_release
Syntax
Returns
Parameters
See Also
sem_terminate
Syntax
Returns
Parameters
See Also
sem_tgrab
Syntax
Returns
Parameters
See Also
sendfile
Syntax
Returns
Parameters
Example
See Also
session_create
Syntax
Returns
Parameters
See Also
session_dns
Syntax
Returns
Parameters
session_free
Syntax
Returns
See Also
Parameters
session_maxdns
Syntax
Returns
Parameters
shexp_casecmp
Syntax
Returns
Parameters
See Also
shexp_cmp
Syntax
Returns
Parameters
Example
See Also
shexp_match
Syntax
Returns
Parameters
See Also
shexp_valid
Syntax
Returns
Parameters
See Also
shmem_alloc
Syntax
Returns
Parameters
See Also
shmem_free
Syntax
Returns
Parameters
See Also
STRDUP
Syntax
Returns
Parameters
Example
See Also
system_errmsg
Syntax
Returns
Parameters
See Also
system_fclose
Syntax
Returns
Parameters
Example
See Also
system_flock
Syntax
Returns
Parameters
See Also
system_fopenRO
Syntax
Returns
Parameters
See Also
system_fopenRW
Syntax
Returns
Parameters
Example
See Also
system_fopenWA
Syntax
Returns
Parameters
See Also
system_fread
Syntax
Returns
Parameters
See Also
system_fwrite
Syntax
Returns
Parameters
See Also
system_fwrite_atomic
Syntax
Returns
Parameters
Example
See Also
system_gmtime
Syntax
Returns
Parameters
Example
See Also
system_localtime
Syntax
Returns
Parameters
See Also
system_lseek
Syntax
Returns
Parameters
See Also
system_rename
Syntax
Returns
Parameters
system_ulock
Syntax
Returns
Parameters
See Also
system_unix2local
Syntax
Returns
Parameters
See Also
systhread_attach
Syntax
Returns
Parameters
See Also
systhread_current
Syntax
Returns
Parameters
See Also
systhread_getdata
Syntax
Returns
Parameters
See Also
systhread_init
Syntax
Returns
Parameters
See also
systhread_newkey
Syntax
Returns
Parameters
See Also
systhread_setdata
Syntax
Returns
Parameters
See Also
systhread_sleep
Syntax
Returns
Parameters
See Also
systhread_start
Syntax
Returns
Parameters
See Also
systhread_terminate
Syntax
Returns
Parameters
See Also
systhread_timerset
Syntax
Returns
Parameters
See Also
U
USE_NSAPI_VERSION
Syntax
Example
See Also
util_can_exec
UNIX Only
Syntax
Returns
Parameters
See Also
util_chdir2path
Syntax
Returns
Parameters
util_cookie_find
Syntax
Returns
Parameters
util_does_process_exist
Syntax
Returns
Parameters
See Also
util_env_create
Syntax
Returns
Parameters
See Also
util_env_find
Syntax
Returns
Parameters
See Also
util_env_free
Syntax
Returns
Parameters
See Also
util_env_replace
Syntax
Returns
Parameters
See Also
util_env_str
Syntax
Returns
Parameters
See Also
util_get_current_gmt
Syntax
Returns
Parameters
See Also
util_get_int_from_aux_file
Syntax
Returns
Parameters
See Also
util_get_int_from_file
Syntax
Returns
Parameters
See Also
util_get_long_from_aux_file
Syntax
Returns
Parameters
See Also
util_get_long_from_file
Syntax
Returns
Parameters
See Also
util_get_string_from_aux_file
Syntax
Returns
Parameters
See Also
util_get_string_from_file
Syntax
Returns
Parameters
See Also
util_getline
Syntax
Returns
Parameters
See Also
util_hostname
Syntax
Returns
Parameters
util_is_mozilla
Syntax
Returns
Parameters
See Also
util_is_url
Syntax
Returns
Parameters
See Also
util_itoa
Syntax
Returns
Parameters
util_later_than
Syntax
Returns
Parameters
See Also
util_make_filename
Syntax
Returns
Parameters
util_make_gmt
Syntax
Returns
Parameters
See Also
util_make_local
Syntax
Returns
Parameters
See Also
util_move_dir
Syntax
Returns
Parameters
See Also
util_move_file
Syntax
Returns
Parameters
See Also
util_parse_http_time
Syntax
Returns
See Also
util_put_int_to_file
Syntax
Returns
Parameters
See Also
util_put_long_to_file
Syntax
Returns
Parameters
See Also
util_put_string_to_aux_file
Syntax
Returns
Parameters
See Also
util_put_string_to_file
Syntax
Returns
Parameters
See Also
util_sect_id
Syntax
Returns
Parameters
util_sh_escape
Syntax
Returns
Parameters
See Also
util_snprintf
Syntax
Returns
Parameters
See Also
util_sprintf
Syntax
Returns
Parameters
Example
See Also
util_strcasecmp
Syntax
Returns
Parameters
See Also
util_strftime
Syntax
Returns
Parameters
See Also
util_strncasecmp
Syntax
Returns
Parameters
See Also
util_uri_check
Syntax
Returns
Parameters
util_uri_escape
Syntax
Returns
Parameters
See Also
util_uri_is_evil
Syntax
Returns
Parameters
See Also
util_uri_parse
Syntax
Returns
Parameters
See Also
util_uri_unescape
Syntax
Returns
Parameters
See Also
util_url_cmp
Syntax
Returns
Parameters
See Also
util_url_fix_host name
Syntax
Returns
Parameters
See Also
util_url_has_FQDN
Syntax
Returns
Parameters
util_vsnprintf
Syntax
Returns
Parameters
See Also
util_vsprintf
Syntax
Returns
Parameters
See Also
W
write
Syntax
Returns
Parameters
Example
writev
Syntax
Returns
Parameters
Example
See Also
Chapter 5 Data Structure Reference
Privatization of Some Data Structures
Session
pblock
pb_entry
pb_param
Session->client
Request
stat
shmem_s
cinfo
sendfiledata
Filter
FilterContext
FilterLayer
FilterMethods
CacheEntry Data Structure
CacheState Data Structure
ConnectMode Data Structure
Chapter 6 Using Wildcard Patterns
Wildcard Patterns
Wildcard Examples
Chapter 7 Time Formats
Time format strings
Chapter 8 Hypertext Transfer Protocol
HTTP Compliance
HTTP Requests
Request Method, URI, and Protocol Version
Request Headers
Request Data
Server Responses
HTTP Protocol Version, Status Code, and Reason Phrase
Response Headers
Response Data
Buffered Streams
Appendix A Alphabetical List of NSAPI Functions and Macros
© 2010, Oracle Corporation and/or its affiliates