Index (Sun Java System Web Server 6.1 SP12 NSAPI Programmer's Guide)

Sun Java System Web Server 6.1 SP12 NSAPI Programmer's Guide


A

	about this guide
		contents ( )
		other resources ( )

	AddLog ( )
		example of custom SAF ( )
		flow of control ( )
		requirements for SAFs ( ) ( )
		summary ( )

	Administration interface, more information about ( )

	alphabetical reference, NSAPI functions ( )

	API functions
		CALLOC ( )
		cinfo_find ( )
		condvar_init ( )
		condvar_notify ( )
		condvar_terminate ( )
		condvar_wait ( )
		crit_enter ( )
		crit_exit ( )
		crit_init ( )
		crit_terminate ( )
		daemon_atrestart ( )
		dr_cache_init ( )
		dr_cache_refresh ( )
		dr_net_write ( )
		fc_close ( )
		fc_net_write ( )
		filebuf_buf2sd ( ) ( )
		filebuf_close ( )
		filebuf_getc ( )
		filebuf_open ( )
		filebuf_open_nostat ( )
		filter_create ( )
		filter_find ( )
		filter_insert ( )
		filter_layer ( )
		filter_name ( )
		filter_remove ( )
		flush ( )
		FREE ( )
		func_exec ( )
		func_find ( )
		func_insert ( )
		insert ( )
		log_error ( )
		MALLOC ( )
		net_ip2host ( )
		net_read ( )
		net_write ( )
		netbuf_buf2sd ( )
		netbuf_close ( )
		netbuf_getbytes ( )
		netbuf_getc ( )
		netbuf_grab ( )
		netbuf_open ( )
		param_create ( )
		param_free ( )
		pblock_copy ( )
		pblock_create ( )
		pblock_dup ( )
		pblock_find ( )
		pblock_findval ( )
		pblock_free ( )
		pblock_nninsert ( )
		pblock_nvinsert ( )
		pblock_pb2env ( )
		pblock_pblock2str ( )
		pblock_pinsert ( )
		pblock_remove ( )
		pblock_str2pblock ( )
		PERM_FREE ( )
		PERM_MALLOC ( ) ( ) ( )
		PERM_STRDUP ( )
		prepare_nsapi_thread ( )
		protocol_dump822 ( )
		protocol_set_finfo ( )
		protocol_start_response ( )
		protocol_status ( )
		protocol_uri2url ( ) ( )
		read ( )
		REALLOC ( )
		remove ( )
		request_get_vs ( )
		request_header ( )
		request_stat_path ( )
		request_translate_uri ( )
		sendfile ( )
		session_dns ( )
		session_maxdns ( )
		shexp_casecmp ( )
		shexp_cmp ( )
		shexp_match ( )
		shexp_valid ( )
		STRDUP ( )
		system_errmsg ( )
		system_fclose ( )
		system_flock ( )
		system_fopenRO ( )
		system_fopenRW ( )
		system_fopenWA ( )
		system_fread ( )
		system_fwrite ( )
		system_fwrite_atomic ( )
		system_gmtime ( )
		system_localtime ( )
		system_lseek ( )
		system_rename ( )
		system_ulock ( ) ( ) ( )
		system_unix2local ( )
		systhread_attach ( )
		systhread_current ( )
		systhread_getdata ( )
		systhread_newkey ( )
		systhread_setdata ( )
		systhread_sleep ( )
		systhread_start ( )
		systhread_timerset ( )
		util_can_exec ( )
		util_chdir2path ( )
		util-cookie_find ( )
		util_cookie_find ( )
		util_env_find ( )
		util_env_free ( )
		util_env_replace ( )
		util_env_str ( )
		util_getline ( )
		util_hostname ( )
		util_is_mozilla ( )
		util_is_url ( )
		util_itoa ( )
		util_later_than ( )
		util_sh_escape ( )
		util_snprintf ( )
		util-sprintf ( )
		util_strcasecmp ( )
		util_strftime ( )
		util_strncasecmp ( )
		util_uri_escape ( )
		util_uri_is_evil ( )
		util_uri_parse ( )
		util_uri_unescape ( )
		util_vsnprintf ( )
		util_vsprintf ( )
		vs_alloc_slot ( )
		vs_get_data ( )
		vs_get_default_httpd_object ( )
		vs_get_doc_root ( )
		vs_get_httpd_objset ( )
		vs_get_id ( )
		vs_get_mime_type ( )
		vs_lookup_config_var ( )
		vs_register_cb ( )
		vs_set_data ( )
		vs_translate_uri ( )
		write ( )
		writev ( )

	AUTH_TYPE environment variable ( )

	AUTH_USER environment variable ( )

	AuthTrans ( )
		example of custom SAF ( )
		flow of control ( )
		requirements for SAFs ( ) ( )
		summary ( )


B

	browsers ( )

	buffer-size parameter ( )

	buffered streams ( )

	buffers-per-file parameter ( )


C

	cache, enabling memory allocation pool ( )

	cache-size parameter ( )

	caching, results caching plug-in ( )

	CALLOC API function ( )

	case sensitivity in obj.conf ( )

	CGI
		environment variables in NSAPI ( )
		execution ( )
		to NSAPI conversion ( )

	cgistub-path parameter ( )

	chunked encoding ( ) ( )

	cindex-init function ( )

	cinfo_find API function ( )

	cinfo NSAPI data structure ( )

	client
		field in session parameter ( )
		getting DNS name for ( )
		getting IP address for ( )
		requests ( )
		sessions and ( )

	CLIENT_CERT environment variable ( )

	Client tag ( ) ( )

	comments in obj.conf ( )

	Common Log subsystem, initializing ( )

	compatibility issues ( ) ( )

	compiling custom SAFs ( )

	compression, HTTP ( )

	condvar_init API function ( )

	condvar_notify API function ( )

	condvar_terminate API function ( )

	condvar_wait API function ( )

	configuration, dynamic ( )

	CONTENT_LENGTH environment variable ( )

	CONTENT_TYPE environment variable ( )

	context->data ( )

	context->rq ( )

	context->sn ( )

	creating
		custom filters ( ) ( )
		custom SAFs ( )
		custom server-parsed HTML tags ( )

	crit_enter API function ( )

	crit_exit API function ( )

	crit_init API function ( )

	crit_terminate API function ( )

	csd field in session parameter ( )

	custom
		filters ( ) ( )
		SAFs ( ) ( )
		server-parsed HTML tags ( )


D

	daemon_atrestart API function ( )

	data structures ( )
		cinfo ( )
		compatibility issues ( )
		Filter ( )
		FilterContext ( )
		FilterLayer ( )
		FilterMethods ( )
		nsapi.h header file ( )
		nsapi_pvt.h ( )
		pb_entry ( )
		pb_param ( )
		pblock ( )
		privatization of ( )
		removed from nsapi.h ( )
		request ( )
		sendfiledata ( )
		session ( )
		Session->client ( )
		shmem_s ( )
		stat ( )

	day of month ( )

	define-perf-bucket function ( )

	defining
		custom SAFs ( )
		server-side tags ( )

	description parameter ( )

	directives
		for handling requests ( )
		order of ( )
		summary for obj.conf ( )
		syntax in obj.conf ( )

	disable parameter ( ) ( )

	dns-cache-init function ( )

	DNS names, getting clients ( )

	dr_cache_init API function ( )

	dr_cache_refresh API function ( )

	dr_net_write API function ( )

	dynamic link library, loading ( )

	dynamic reconfiguration ( )


E

	env-variables parameter ( )

	environment variables
		and init-cgi function ( )
		CGI to NSAPI conversion ( )

	Error directive ( )
		flow of control ( )
		requirements for SAFs ( ) ( )
		summary ( )

	errors, finding most recent system error ( )

	examples
		location in the build ( )
		of custom filters ( )
		of custom SAFs (plug-ins) ( )
		of custom SAFs in the build ( )
		quality of service ( )
		wildcard patterns ( )

	expire parameter ( )


F

	fancy indexing ( )

	fc_close API function ( )

	fc_net_write API function ( )

	file descriptor
		closing ( )
		locking ( )
		opening read-only ( )
		opening read-write ( )
		opening write-append ( )
		reading into a buffer ( )
		unlocking ( ) ( ) ( )
		writing from a buffer ( )
		writing without interruption ( )

	file I/O routines ( )

	file name extensions, object type ( )

	filebuf_buf2sd API function ( ) ( )

	filebuf_close API function ( )

	filebuf_getc API function ( )

	filebuf_open API function ( )

	filebuf_open_nostat API function ( )

	filter_create API function ( )

	filter_find API function ( )

	filter_insert API function ( )

	filter_layer API function ( )

	filter methods ( )
		C prototypes for ( )
		FilterLayer data structure ( )
		flush ( )
		insert ( )
		remove ( )
		sendfile ( )
		write ( )
		writev ( )

	filter_name API function ( )

	Filter NSAPI data structure ( )

	filter_remove API function ( )

	FilterContext NSAPI data structure ( )

	FilterLayer NSAPI data structure ( ) ( )
		context->data ( )
		context->rq ( )
		context->sn ( )
		lower ( )

	FilterMethods NSAPI data structure ( )

	filters
		altering Content-length ( )
		creating custom ( )
		examples of ( )
		functions used to implement ( )
		input ( )
		interface ( )
		methods ( )
		NSAPI function overview ( )
		output ( )
		stack position ( )
		using ( )

	filters parameter ( )

	flex-init formatting ( )

	flex-init function ( )

	flex-log function ( ) ( ) ( )

	flex-rotate-init function ( )

	flexible logging ( )

	flow of control ( )

	flush API function ( ) ( )

	fn argument, in directives in obj.conf ( )

	force-type function ( )

	forcing object type ( )

	format parameter ( )

	formats, time ( )

	forward slashes ( )

	FREE API function ( )

	free-size parameter ( )

	func_exec API function ( )

	func_find API function ( )

	func_insert API function ( )

	funcs parameter ( ) ( )

	functions, reference ( )


G

	-G option ( )

	GATEWAY_INTERFACE environment variable ( )

	GMT time, getting thread-safe value ( )


H

	headers
		field in request parameter ( )
		request ( )
		response ( )

	HOST environment variable ( )

	HTML tags, creating custom ( )

	HTTP
		basics ( )
		buffered streams ( )
		compliance with HTTP/1.1 ( )
		HTTP/1.1 specification ( )
		overview ( )
		registering methods ( )
		requests ( )
		responses ( )
		status codes ( )

	HTTP_* environment variable ( )

	HTTP compression ( )

	http-compression filter ( )

	http-decompression filter ( )

	HTTPS environment variable ( )

	HTTPS_KEYSIZE environment variable ( )

	HTTPS_SECRETKEYSIZE environment variable ( )


I

	icon-uri parameter ( )

	IETF home page ( )

	ignore parameter ( )

	include directory, for SAFs ( )

	indexing, fancy ( )

	init-cgi function ( )

	init-clf function ( )

	init-dav function ( )

	Init SAFs in magnus.conf ( )
		requirements for SAFs ( ) ( )

	init-uhome function ( )

	initializing
		for CGI ( )
		global settings ( )
		plug-ins ( )
		SAFs ( )
		the WebDAV subsystem ( )

	Input
		flow of control ( )
		requirements for SAFs ( ) ( )
		summary ( )

	input filters ( )

	insert API function ( ) ( )

	IP address, getting client’ ( )


J

	Java Enterprise System (JES) ( )

	JES ( )


L

	LateInit parameter ( )

	layer parameter ( )

	line continuation ( )

	linking SAFs ( )

	load-modules function ( )
		example ( )

	loading
		custom SAFs ( )
		plug-ins ( )
		SAFs ( )

	localtime, getting thread-safe value ( )

	log entries, chronological order ( )

	log_error API function ( )

	log file format ( )

	logFileName parameter ( ) ( )

	logging
		cookies ( )
		flexible ( )
		rotating logs ( )


M

	magnus.conf
		about ( )
		SAFs in ( )

	Makefile file ( )

	MALLOC API function ( )

	matching, special characters ( )

	maxthreads parameter ( )

	memory allocation, pool-init function ( )

	memory management routines ( )

	methods parameter ( )

	minthreads parameter ( )

	month name ( )


N

	name attribute
		in obj.conf objects ( )
		in objects ( )

	name parameter ( ) ( )

	NameTrans
		example of custom SAF ( )
		flow of control ( )
		requirements for SAFs ( ) ( )
		summary ( )

	native thread pools, defining in obj.conf ( )

	NativeThread parameter ( ) ( )

	net_ip2host API function ( )

	net_read API function ( )

	net_write API function ( )

	netbuf_buf2sd API function ( )

	netbuf_close API function ( )

	netbuf_getbytes API function ( )

	netbuf_getc API function ( )

	netbuf_grab API function ( )

	netbuf_open API function ( )

	network I/O routines ( )

	nondefault objects, processing ( )

	NSAPI
		alphabetical function reference ( )
		CGI environment variables ( )
		data structure reference ( )
		filter interface ( )
		function overview ( )

	NSAPI filters
		interface ( )
		methods ( )

	nsapi.h ( )

	nsapi_pvt.h ( )

	nt-console-init function ( )


O

	obj.conf
		adding directives for new SAFs ( )
		case sensitivity ( )
		Client tag ( )
		comments ( )
		directive syntax ( )
		directives ( )
		directives summary ( )
		flow of control ( )
		Object tag ( )
		order of directives ( )
		parameters for directives ( )
		predefined SAFs ( )
		processing other objects ( )
		server instructions ( )
		standard directives ( )
		syntax rules ( )
		use ( )

	Object tag ( ) ( )
		name attribute ( )
		ppath attribute ( )

	object type
		forcing ( )
		setting by file extension ( )

	objects, processing nondefault objects ( )

	ObjectType
		example of custom SAF ( )
		flow of control ( )
		requirements for SAFs ( ) ( )
		summary ( )

	opts parameter ( )

	order
		of directives in obj.conf ( )
		of filters in filter stack ( )

	Output ( )
		example of custom SAF ( )
		flow of control ( )
		requirements for SAFs ( ) ( )
		summary ( )

	output filters ( )


P

	param_create API function ( )

	param_free API function ( )

	parameter block
		manipulation routines ( )
		SAF parameter ( )

	parameters
		for obj.conf directives ( )
		for SAFs ( )

	PATH_INFO environment variable ( )

	path name, converting UNIX-style to local ( )

	path names ( )

	PATH_TRANSLATED environment variable ( )

	PathCheck
		example of custom SAF ( )
		flow of control ( )
		requirements for SAFs ( ) ( )
		summary ( )

	patterns ( )

	pb_entry NSAPI data structure ( )

	pb_param NSAPI data structure ( )

	pb SAF parameter ( )

	pblock, NSAPI data structure ( )

	pblock_copy API function ( )

	pblock_create API function ( )

	pblock_dup API function ( )

	pblock_find API function ( )

	pblock_findval API function ( )

	pblock_free API function ( )

	pblock_nninsert API function ( )

	pblock_nvinsert API function ( )

	pblock_pb2env API function ( )

	pblock_pblock2str API function ( )

	pblock_pinsert API function ( )

	pblock_remove API function ( )

	pblock_str2pblock API function ( )

	perf-init function ( )

	PERM_FREE API function ( )

	PERM_MALLOC API function ( ) ( ) ( )

	PERM_STRDUP API function ( )

	pfx2dir function ( )

	plug-ins
		compatibility issues ( ) ( )
		creating ( )
		example of new plug-ins ( ) ( )
		instructing the server to use ( )
		loading and initializing ( )
		private data structures ( )

	pool-init function ( )

	pool parameter ( )

	ppath attribute
		in obj.conf objects ( )
		in objects ( )

	predefined SAFs in obj.conf ( )

	prepare_nsapi_thread API function ( )

	private data structures ( )

	processing nondefault objects ( )

	product support ( )

	profiling parameter ( )

	protocol_dump822 API function ( )

	protocol_set_finfo API function ( )

	protocol_start_response API function ( )

	protocol_status API function ( )

	protocol_uri2url API function ( ) ( )

	protocol utility routines ( )

	pwfile parameter ( )


Q

	qos.c file ( )

	quality of service, example code ( )

	QUERY environment variable ( )

	QUERY_STRING environment variable ( )

	queueSize parameter ( )

	quotes ( )


R

	read API function ( ) ( )

	REALLOC API function ( )

	reference
		data structure ( )
		NSAPI functions ( )

	register-http-method function ( )

	relink_36plugin file ( )

	REMOTE_ADDR environment variable ( )

	REMOTE_HOST environment variable ( )

	REMOTE_IDENT environment variable ( )

	REMOTE_USER environment variable ( )

	remove API function ( ) ( )

	replace.c ( )

	REQ_ABORTED response code ( )

	REQ_EXIT response code ( )

	REQ_NOACTION response code ( )

	REQ_PROCEED response code ( )

	reqpb, field in request parameter ( )

	request
		NSAPI data structure ( )
		SAF parameter ( )

	request_get_vs API function ( )

	request-handling process ( )
		flow of control ( )
		steps ( )

	request_header API function ( )

	request headers ( )

	REQUEST_METHOD environment variable ( )

	request-response model ( )

	request_stat_path API function ( )

	request_translate_uri API function ( )

	requests
		directives for handling ( )
		how server handles ( )
		HTTP ( )
		methods ( )
		steps in handling ( )

	requirements for SAFs ( )
		AddLog ( )
		AuthTrans ( )
		Error directive ( )
		Init ( )
		Input ( )
		NameTrans ( )
		ObjectType ( )
		Output ( )
		PathCheck ( )
		Service ( )

	response headers ( )

	responses, HTTP ( )

	result codes ( )

	results caching plug-in ( )
		important functions used by ( )

	rotate-access parameter ( )

	rotate-callback parameter ( )

	rotate-error parameter ( )

	rotate-interval parameter ( )

	rotate-start parameter ( )

	rotating logs ( )

	rq->headers ( )

	rq->reqpb ( )

	rq->srvhdrs ( )

	rq->vars ( )

	rq SAF parameter ( )

	rules, for editing obj.conf ( )


S

	s ( )

	SAFs
		compiling and linking ( )
		creating ( )
		examples of custom SAFs ( )
		in magnus.conf ( )
		include directory ( )
		interface ( )
		loading and initializing ( )
		parameters ( )
		predefined ( )
		result codes ( )
		return values ( )
		signature ( )
		testing ( )

	SCRIPT_NAME environment variable ( )

	search patterns ( )

	sendfile API function ( ) ( )

	sendfiledata NSAPI data structure ( )

	separators ( )

	server
		flow of control ( )
		initialization directives in magnus.conf ( )
		instructions for using plug-ins ( )
		instructions in obj.conf ( )
		processing nondefault objects ( )
		request handling ( )

	SERVER_NAME environment variable ( )

	server-parsed HTML tags
		creating custom ( )
		more information ( )

	SERVER_PORT environment variable ( )

	SERVER_PROTOCOL environment variable ( )

	SERVER_SOFTWARE environment variable ( )

	SERVER_URL environment variable ( )

	server.xml, variables defined in ( )

	Service
		default directive ( )
		directives for new SAFs (plug-ins) ( )
		example of custom SAF ( )
		examples ( )
		flow of control ( )
		requirements for SAFs ( ) ( )
		summary ( )

	session
		defined ( )
		NSAPI data structure ( )
		resolving the IP address of ( ) ( )

	Session->client NSAPI data structure ( )

	session_dns API function ( )

	session_maxdns API function ( )

	session SAF parameter ( )

	shared library, loading ( )

	shell expression
		comparing (case-blind) to a string ( )
		comparing (case-sensitive) to a string ( ) ( )
		validating ( )

	shexp_casecmp API function ( )

	shexp_cmp API function ( )

	shexp_match API function ( )

	shexp_valid API function ( )

	shlib parameter ( ) ( )

	shmem_s NSAPI data structure ( )

	ShtmlTagInstanceLoad function ( )

	ShtmlTagInstanceUnload function ( )

	ShtmlTagPageLoadFunc function ( )

	ShtmlTagPageUnLoadFn ( )

	sn->client ( )

	sn->csd ( )

	sn SAF parameter ( )

	socket
		closing ( )
		reading from ( )
		sending a buffer to ( )
		sending file buffer to ( )
		writing to ( )

	spaces ( )

	special characters ( )

	sprintf, see util_sprintf ( )

	srvhdrs, field in request parameter ( )

	stackSize parameter ( )

	stat NSAPI data structure ( )

	stats-init function ( )

	status codes ( )

	stderr parameter ( )

	stdout parameter ( )

	STRDUP API function ( )

	streams, buffered ( )

	string, creating a copy of ( )

	Sun Java Enterprise System (JES) ( )

	Sun Java System Web Server documentation ( )

	support ( )

	syntax
		directives in obj.conf ( )
		for editing obj.conf ( )

	system_errmsg API function ( )

	system_fclose API function ( )

	system_flock API function ( )

	system_fopenRO API function ( )

	system_fopenRW API function ( )

	system_fopenWA API function ( )

	system_fread API function ( )

	system_fwrite API function ( )

	system_fwrite_atomic API function ( )

	system_gmtime API function ( )

	system_localtime API function ( )

	system_lseek API function ( )

	system_rename API function ( )

	system_ulock API function ( ) ( ) ( )

	system_unix2local API function ( )

	systhread_attach API function ( )

	systhread_current API function ( )

	systhread_getdata API function ( )

	systhread_newkey API function ( )

	systhread_setdata API function ( )

	systhread_sleep API function ( )

	systhread_start API function ( )

	systhread_timerset API function ( )


T

	tags
		Client ( )
		creating custom ( )
		Object ( )

	testing custom SAFs ( )

	thread
		allocating a key for ( )
		creating ( )
		getting a pointer to ( )
		getting data belonging to ( )
		putting to sleep ( )
		setting data belonging to ( )
		setting interrupt timer ( )

	thread-pool-init function ( )

	thread pools, defining in obj.conf ( )

	thread routines ( )

	time formats ( )

	timeout parameter ( )

	timezones parameter ( )


U

	unicode ( ) ( )

	update-interval parameter ( )

	URL, translated to file path ( )

	util_can_exec API function ( )

	util_chdir2path API function ( )

	util_cookie_find API function ( ) ( )

	util_env_find API function ( )

	util_env_free API function ( )

	util_env_replace API function ( )

	util_env_str API function ( )

	util_getline API function ( )

	util_hostname API function ( )

	util_is_mozilla API function ( )

	util_is_url API function ( )

	util_itoa API function ( )

	util_later_than API function ( )

	util_sh_escape API function ( )

	util_snprintf API function ( )

	util_sprintf API function ( )

	util_strcasecmp API function ( )

	util_strftime API function ( ) ( )

	util_strncasecmp API function ( )

	util_uri_escape API function ( )

	util_uri_is_evil API function ( )

	util_uri_parse API function ( )

	util_uri_unescape API function ( )

	util_vsnprintf API function ( )

	util_vsprintf API function ( )

	utility routines ( )


V

	vars, field in request parameter ( )

	virtual server routines ( )

	virtual-servers parameter ( )

	vs_alloc_slot API function ( )

	vs_get_data API function ( )

	vs_get_default_httpd_object API function ( )

	vs_get_doc_root API function ( )

	vs_get_httpd_objset API function ( )

	vs_get_id API function ( )

	vs_get_mime_type API function ( )

	vs_lookup_config_var API function ( )

	vs_register_cb API function ( )

	vs_set_data API function ( )

	vs_translate_uri API function ( )

	vsnprintf, see util_vsnprintf ( )

	vsprintf, see util_vsprintf ( )


W

	weekday ( )

	widths parameter ( )

	wildcard patterns ( )

	write API function ( ) ( )

	writev API function ( ) ( )