BasicAuth
Debug
Dummy
ImageMap
UserDirectory


Name:
BasicAuth

Description:
Basic authentication is not included in this distribution.

Options:

Overview
Option Default Values Short Description Example(s)
Realm + A string pattern Realm to authenticate for Realm="admin"
- in the default indicates no default
+ in the default indicates the field is mandatory

Description of Options

Realm
The realm to which this authentication applies. If the realm associated with the request is different. This authentication module will pass up handling of the request by returning PIAPI_CONTINUE.

Phase:
CHECKAUTH

Returns:
PIAPI_COMPLETED if authentication passed. INT_REDIRECT if the status was set to 401 to challenge, PIAPI_CONTINUE if this handler choose to take no action and PIAPI_ERROR if this handler was invoked for a phase other than CHECKAUTH.

Note:

Example:

	<Object>
		Name BasicAuth
		Class BasicAuthClass
	</Object>

	<Object>
		...
		Handle BasicAuth 
		...
	</Object>
	

:


Name:
Debug

Description:
This handler writes a configurable debug message to the debug log.

Options:

Overview
Option Default Values Short Description Example(s)
Pi3Expression + A Pi3Expression Expression to place in debug log Pi3Expression="$c/* value of Content-Type */"
- in the default indicates no default
+ in the default indicates the field is mandatory

Description of Options

Pi3Expression
Pi3Expression to write in the debug log.

Phase:
All phases

Returns:
PIAPI_CONTINUE

Note:

Example:

	<Object>
		Name Debug
		Class DebugClass
	</Object>

	<Object>
		...
		Handle Debug Pi3Expression="$c/* value of Content-Type */"
		...
	</Object>
	

:


Name:
Dummy

Description:
This handler does not do anything. It is useful as a template and as a substitute for handlers that are removed from distribution.

Options:

Phase:
All phases

Returns:
PIAPI_COMPLETED

Note:

Example:

	<Object>
		Name Dummy
		Class DummyClass
		Variable3 "Value3"
	</Object>

	<Object>
		...
		Handle Dummy Variable1="Value1" Variable2="Value2"
		...
	</Object>
	

:


Name:
ImageMap

Description:
Server-side image maps are not included in this configuration.

Phase:
HANDLE

Returns:
PIAPI_COMPLETED

Note:

Example:

	<Object>
		Name ImageMap
		Class ImageMapClass
	</Object>

	<Object>
		...
		Handle ImageMap 
		...
	</Object>
	

:


Name:
UserDirectory

Description:
Remap user directories. Example

	UserDirectoryRoot="/home/"
	HTMLDirectory="/public_html"

	/~jroy/hello.html --> /home/jroy/public_html/hello.html

Options:

Overview
Option Default Values Short Description Example(s)
UserDirectoryRoot + A directory path Root of user directories UserDirectoryRoot="/home/"
HTMLDirectory + A directory name User directory with web files HTMLDirectory="/public_html"
- in the default indicates no default
+ in the default indicates the field is mandatory

Phase:
MAPPING

Returns:
PIAPI_COMPLETED if the directory was mapped, otherwise PIAPI_CONTINUE.

Note:

Example:

	<Object>
		Name UserDirectory
		Class UserDirectoryClass
		UserDirectoryRoot "/home/"
		HTMLDirectory "/public_html"
	</Object>

	<Object>
		...
		Handle UserDirectory
		...
	</Object>