Documentation Home
> Sun Java System Web Server 7.0 Update 6 NSAPI Developer's Guide
Sun Java System Web Server 7.0 Update 6 NSAPI Developer's Guide
Book Information
Index
A
C
D
E
F
G
H
I
L
M
N
O
P
Q
R
S
T
U
V
W
Preface
Chapter 1 About NSAPI
Overview of NSAPI
HTTP Request-Response Process
About Server Application Function
About Parameter Block
Passing Parameters to SAF
Chapter 2 Creating Custom Server Application Functions
Future Compatibility Issues
SAF Interface
SAF Parameters
pb (Parameter Block) Parameter
sn (Session) Parameter
rq (Request) Parameter
Result Codes
Creating and Using Custom SAFs
Writing the Source Code for a Custom SAF
Compiling and Linking
Including Directory and nsapi.h File
Libraries
Linker Commands and Options for Generating a Shared Object
Additional Linker Flags
Compiler Flags
Compiling and Linking in 64–bit Mode
Issues With Using C++ in a NSAPI Plug-in
Load and Initialize the SAF
Instruct 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
Virtual Server
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
CGI to NSAPI Conversion
Chapter 3 Creating Custom Filters
Future Compatibility Issues
NSAPI Filter Interface
Filter Methods
C Prototypes for Filter Methods
insert Filter Method
remove Filter Method
flush Filter Method
read Filter Method
write Filter Method
sendfile Filter Method
writev Filter Method
Position of Filters in the Filter Stack
Filters That Alter Content-Length
Creating and Using Custom Filters
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 4 Examples of Custom SAFs and Filters
Using the NSAPI Examples
AuthTrans() Example
Installing the AuthTrans() Example
NameTrans() Example
Installing the NameTrans Example
PathCheck() Example
Installing the PathCheck() Example
ObjectType() Example
Installing the ObjectType() Example
Output() Example
Installing the Output() Example
Service() Example
Simple Service() Example
More Complex Service() Example
AddLog() Example
Installing the AddLog() Example
Quality of Service() Example
Installing the Quality of Service() Example
Chapter 5 Creating Custom Server-Parsed HTML Tags
Defining Custom Server-parsed HTML Tags
Defining the Functions that Implement the Tag
Writing an Initialization Function
Loading the New Tag into the Server
Chapter 6 NSAPI Function and Macro Reference
NSAPI Functions and Macros
C
CALLOC() Macro
Syntax
Return Values
Parameters
Example
See Also
cinfo_find() Function
Syntax
Returns
Parameters
condvar_init() Function
Syntax
Return Values
Parameters
See Also
condvar_notify() Function
Syntax
Return Values
Parameters
See Also
condvar_terminate() Function
Syntax
Return Values
Parameters
See Also
condvar_wait() Function
Syntax
Return Values
Parameters
See Also
crit_enter() Function
Syntax
Return Values
Parameters
See Also
crit_exit() Function
Syntax
Return Values
Parameters
See Also
crit_init() Function
Syntax
Return Values
Parameters
See Also
crit_terminate() Function
Syntax
Return Values
Parameters
See Also
D
daemon_atrestart() Function
Syntax
Return Values
Parameters
Example
F
filebuf_buf2sd() Function
Syntax
Return Values
Parameters
Example
See Also
filebuf_close() Function
Syntax
Return Values
Parameters
Example
See Also
filebuf_getc() Function
Syntax
Return Values
Parameters
See Also
filebuf_open() Function
Syntax
Return Values
Parameters
Example
See Also
filebuf_open_nostat() Function
Syntax
Return Values
Parameters
Example
See Also
filter_create() Function
Syntax
Return Values
Parameters
Example
See Also
filter_find() Function
Syntax
Return Values
Parameters
filter_insert() Function
Syntax
Return Values
Parameters
See Also
filter_layer() Function
Syntax
Return Values
Parameters
filter_name() Function
Syntax
Return Values
Parameters
filter_remove() Function
Syntax
Return Values
Parameters
flush() Function
Syntax
Return Values
Parameters
Example
See Also
FREE() Macro
Syntax
Return Values
Parameters
Example
See Also
func_exec() Function
Syntax
Return Values
Parameters
See Also
func_find() Function
Syntax
Return Values
Parameters
Example
See Also
func_insert() Function
Syntax
Return Values
Parameters
Example
See Also
I
insert() Function
Syntax
Return Values
Parameters
Example
See Also
L
log_error() Function
Syntax
Return Values
Parameters
Example
See Also
M
MALLOC() Macro
Syntax
Return Values
Parameters
Example
See Also
N
net_flush() Function
Syntax
Return Values
Parameters
Example
See Also
net_ip2host() Function
Syntax
Return Values
Parameters
net_read() Function
Syntax
Return Values
Parameters
See Also
net_sendfile() Function
Syntax
Return Values
Parameters
Example
See Also
net_write() Function
Syntax
Return Values
Parameters
Example
See Also
netbuf_buf2sd() Function
Syntax
Return Values
Parameters
See Also
netbuf_close() Function
Syntax
Return Values
Parameters
See Also
netbuf_getbytes() Function
Syntax
Return Values
Parameters
Example
See Also
netbuf_getc() Function
Syntax
Return Values
Parameters
See Also
netbuf_grab() Function
Syntax
Return Values
Parameters
See Also
netbuf_open() Function
Syntax
Return Values
Parameters
See Also
nsapi_module_init() Function
Syntax
Return Values
Parameters
See Also
NSAPI_RUNTIME_VERSION() Macro
Syntax
Example
See Also
NSAPI_VERSION() Macro
Syntax
Example
See Also
P
param_create() Function
Syntax
Return Values
Parameters
Example
See Also
param_free() Function
Syntax
Return Values
Parameters
Example
See Also
pblock_copy() Function
Syntax
Return Values
Parameters
See Also
pblock_create() Function
Syntax
Return Values
Parameters
See Also
pblock_dup() Function
Syntax
Return Values
Parameters
See Also
pblock_find() Function
Syntax
Return Values
Parameters
See Also
pblock_findval() Function
Syntax
Return Values
Parameters
See Also
pblock_free() Function
Syntax
Return Values
Parameters
See Also
pblock_nninsert() Function
Syntax
Return Values
Parameters
See Also
pblock_nvinsert() Function
Syntax
Return Values
Parameters
Example
See Also
pblock_pb2env() Function
Syntax
Return Values
Parameters
See Also
pblock_pblock2str() Function
Syntax
Return Values
Parameters
See Also
pblock_pinsert() Function
Syntax
Return Values
Parameters
See Also
pblock_remove() Function
Syntax
Return Values
Parameters
See Also
pblock_str2pblock() Function
Syntax
Return Values
Parameters
See Also
PERM_CALLOC() Macro
Syntax
Return Values
Parameters
Example
See Also
PERM_FREE() Macro
Syntax
Return Values
Parameters
Example
See Also
PERM_MALLOC() Macro
Syntax
Return Values
Parameters
Example
See Also
PERM_REALLOC() Macro
Syntax
Return Values
Parameters
Example
See Also
PERM_STRDUP() Macro
Syntax
Return Values
Parameters
See Also
prepare_nsapi_thread() Function
Syntax
Return Values
Parameters
See Also
protocol_dump822() Function
Syntax
Return Values
Parameters
See Also
protocol_set_finfo() Function
Syntax
Return Values
Parameters
See Also
protocol_start_response() Function
Syntax
Return Values
Parameters
Example
See Also
protocol_status() Function
Syntax
Return Values
Parameters
Example
See Also
protocol_uri2url() Function
Syntax
Return Values
Parameters
See Also
protocol_uri2url_dynamic() Function
Syntax
Return Values
Parameters
See Also
R
read() Function
Syntax
Return Values
Parameters
Example
See Also
REALLOC() Macro
Syntax
Return Values
Parameters
Example
See Also
remove() Function
Syntax
Return Values
Parameters
See Also
request_get_vs() Function
Syntax
Return Values
Parameters
See Also
request_header() Function
Syntax
Return Values
Parameters
See Also
request_stat_path() Function
Syntax
Return Values
Parameters
Example
See Also
request_translate_uri() Function
Syntax
Return Values
Parameters
See Also
S
sendfile() Function
Syntax
Return Values
Parameters
Example
See Also
session_dns() Function
Syntax
Return Values
Parameters
session_maxdns() Function
Syntax
Return Values
Parameters
shexp_casecmp() Function
Syntax
Return Values
Parameters
See Also
shexp_cmp() Function
Syntax
Return Values
Parameters
Example
See Also
shexp_match() Function
Syntax
Return Values
Parameters
See Also
shexp_valid() Function
Syntax
Return Values
Parameters
See Also
STRDUP() Macro
Syntax
Return Values
Parameters
Example
See Also
system_errmsg() Function
Syntax
Return Values
Parameters
See Also
system_fclose() Function
Syntax
Return Values
Parameters
Example
See Also
system_flock() Function
Syntax
Return Values
Parameters
See Also
system_fopenRO() Function
Syntax
Return Values
Parameters
See Also
system_fopenRW() Function
Syntax
Return Values
Parameters
Example
See Also
system_fopenWA() Function
Syntax
Return Values
Parameters
See Also
system_fread() Function
Syntax
Return Values
Parameters
See Also
system_fwrite() Function
Syntax
Return Values
Parameters
See Also
system_fwrite_atomic() Function
Syntax
Return Values
Parameters
Example
See Also
system_gmtime() Function
Syntax
Return Values
Parameters
Example
See Also
system_localtime() Function
Syntax
Return Values
Parameters
See Also
system_lseek() Function
Syntax
Return Values
Parameters
See Also
system_rename() Function
Syntax
Return Values
Parameters
system_ulock() Function
Syntax
Return Values
Parameters
See Also
system_unix2local() Function
Syntax
Return Values
Parameters
See Also
systhread_attach() Function
Syntax
Return Values
Parameters
See Also
systhread_current() Function
Syntax
Return Values
Parameters
See Also
systhread_getdata() Function
Syntax
Return Values
Parameters
See Also
systhread_newkey() Function
Syntax
Return Values
Parameters
See Also
systhread_setdata() Function
Syntax
Return Values
Parameters
See Also
systhread_sleep() Function
Syntax
Return Values
Parameters
See Also
systhread_start() Function
Syntax
Return Values
Parameters
See Also
systhread_timerset() Function
Syntax
Return Values
Parameters
See Also
U
USE_NSAPI_VERSION() Macro
Syntax
Example
See Also
util_can_exec() Function (UNIX Only)
Syntax
Return Values
Parameters
See Also
util_chdir2path() Function
Syntax
Return Values
Parameters
util_cookie_find() Function
Syntax
Return Values
Parameters
util_env_find() Function
Syntax
Return Values
Parameters
See Also
util_env_create() Function
Syntax
Return Values
Parameters
See Also
util_env_free() Function
Syntax
Return Values
Parameters
See Also
util_env_replace() Function
Syntax
Return Values
Parameters
See Also
util_env_str() Function
Syntax
Return Values
Parameters
See Also
util_getline() Function
Syntax
Return Values
Parameters
util_hostname() Function
Syntax
Return Values
Parameters
util_is_mozilla() Function
Syntax
Return Values
Parameters
See Also
util_is_url() Function
Syntax
Return Values
Parameters
See Also
util_itoa() Function
Syntax
Return Values
Parameters
util_later_than() Function
Syntax
Return Values
Parameters
See Also
util_sh_escape() Function
Syntax
Return Values
Parameters
See Also
util_snprintf() Function
Syntax
Return Values
Parameters
See Also
util_sprintf() Function
Syntax
Return Values
Parameters
Example
See Also
util_strcasecmp() Function
Syntax
Return Values
Parameters
See Also
util_strftime() Function
Syntax
Return Values
Parameters
See Also
util_strncasecmp() Function
Syntax
Return Values
Parameters
See Also
util_uri_escape() Function
Syntax
Return Values
Parameters
See Also
util_uri_is_evil() Function
Syntax
Return Values
Parameters
See Also
util_uri_parse() Function
Syntax
Return Values
Parameters
See Also
util_uri_unescape() Function
Syntax
Return Values
Parameters
See Also
util_vsnprintf() Function
Syntax
Return Values
Parameters
See Also
util_vsprintf() Function
Syntax
Return Values
Parameters
See Also
V
vs_alloc_slot() Function
Syntax
Return Values
See Also
vs_get_data() Function
Syntax
Return Values
Parameters
See Also
vs_get_default_httpd_object() Function
Syntax
Return Values
Parameters
See Also
vs_get_doc_root() Function
Syntax
Return Values
Parameters
vs_get_httpd_objset() Function
Syntax
Return Values
Parameters
See Also
vs_get_id() Function
Syntax
Return Values
Parameters
See Also
vs_get_mime_type() Function
Syntax
Return Values
Parameters
vs_lookup_config_var() Function
Syntax
Return Values
Parameters
vs_register_cb() Function
Syntax
Return Values
Parameters
vs_set_data() Function
Syntax
Return Values
Parameters
See Also
vs_translate_uri() Function
Syntax
Return Values
Parameters
W
write() Function
Syntax
Return Values
Parameters
Example
See Also
writev() Function
Syntax
Return Values
Parameters
Example
See Also
Chapter 7 Data Structure Reference
Public Data Structures
Session Data Structure
pblock Data Structure
pb_entry Data Structure
pb_param Data Structure
Request Data Structure
stat Data Structure
shmem_s Data Structure
cinfo Data Structure
sendfiledata Data Structure
Filter Data Structure
FilterContext Data Structure
FilterLayer Data Structure
FilterMethods Data Structure
Chapter 8 Dynamic Results Caching Functions
About Results Caching Plug-ins
Dynamic Result Cache Functions
dr_cache_destroy() Function
Parameters
Returns
Example
dr_cache_init() Function
Syntax
Returns
Parameters
Example
dr_cache_refresh() Function
Syntax
Return Values
Parameters
Example
dr_net_write() Function
Syntax
Return Values
Parameters
Flags
Example
fc_open() Function
Syntax
Return Values
Parameters
fc_close() Function
Syntax
Return Values
Parameters
fc_net_write() Function
Syntax
Return Values
Parameters
Flags
Example
Appendix A Hypertext Transfer Protocol
Compliance
Requests
Request Method, URI, and Protocol Version
Request Headers
Request Data
Responses
HTTP Protocol Version, Status Code, and Reason Phrase
Response Headers
Response Data
Appendix B Alphabetical List of NSAPI Functions and Macros
NSAPI Functions and Macros
© 2010, Oracle Corporation and/or its affiliates