Mod_Rexx Configuration Apache Directives

This section lists the configuration directives the Mod_Rexx Package makes available. Most of the directives install handlers, but there are a few that affect the Rexx execution engine in other ways.



Table of Contents

RexxAccessHandler - Set the request access phase handler
RexxAuthenHandler - Set the request authentication phase handler
RexxAuthzHandler - Set the request authorization phase handler
RexxFixupHandler - Set the request fixup phase handler
RexxHandler - Set the request content phase handler
RexxHeaderParserHandler - Set the request header/parser phase handler
RexxLogHandler - Set the request log phase handler
RexxPostReadRequestHandler - Set the request post read phase handler
RexxRspCompiler - Set the RSP compiler Rexx script
RexxSetVar - Set a Rexx variable for a handler
RexxTempFileNameTemplate - Set a Rexx temporary file name template
RexxTransHandler - Set the request uri translation phase handler
RexxTypeHandler - Set the request MIME type handler




RexxAccessHandler

The access_checker phase is the first of three phases involved in authentication and authorization.

This handler is designed to do simple access control based on the browser's ip address or any other method the programmer wishes to apply that have nothing to do with the user's identity.

This directive can appear anywhere including <Directory>, <Location>, <Files> sections, or .htaccess files.

Directive Prototype


RexxAccessHandler rexxprocname

Directive Parameters

rexxprocname
The name of the Rexx procedure file to be executed for this handler. If the rexxprocname contains embedded blanks then it should be enclosed within a set of double-quotes(").

Example


RexxAccessHandler "c:/handlers/acshandlr.rex"





RexxAuthenHandler

The authentication phase is called when the file is password protected.

This handler checks a user's identity and credentials, usually by checking the username and password against a database.

This directive can appear anywhere including <Directory>, <Location>, <Files> sections, or .htaccess files.

Directive Prototype


RexxAuthenHandler rexxprocname

Directive Parameters

rexxprocname
The name of the Rexx procedure file to be executed for this handler. If the rexxprocname contains embedded blanks then it should be enclosed within a set of double-quotes(").

Example


RexxAuthenHandler "c:/handlers/athhandlr.rex"





RexxAuthzHandler

Once the user's identity has been verified in the authentication phase, this handler determines whether the the user is authorized the requested URI.

This directive can appear anywhere including <Directory>, <Location>, <Files> sections, or .htaccess files.

Directive Prototype


RexxAuthzHandler rexxprocname

Directive Parameters

rexxprocname
The name of the Rexx procedure file to be executed for this handler. If the rexxprocname contains embedded blanks then it should be enclosed within a set of double-quotes(").

Example


RexxAuthzHandler "c:/handlers/athhandlr.rex"





RexxFixupHandler

After the type_checker phase but before content handling the fixup is called. Here you can make any last minute changes to the transaction before the response document is sent.

This directive can appear anywhere including <Directory>, <Location>, <Files> sections, or .htaccess files.

Directive Prototype


RexxFixupHandler rexxprocname

Directive Parameters

rexxprocname
The name of the Rexx procedure file to be executed for this handler. If the rexxprocname contains embedded blanks then it should be enclosed within a set of double-quotes(").

Example


RexxFixupHandler "c:/handlers/fixhandlr.rex"





RexxHandler

This handler is used to provide a special content handler for the transaction response. Usually used with the Apache SetHandler or AddHandler directive.

This directive can appear anywhere including <Directory>, <Location>, <Files> sections, or .htaccess files.

Directive Prototype


RexxHandler rexxprocname

Directive Parameters

rexxprocname
The name of the Rexx procedure file to be executed for this handler. If the rexxprocname contains embedded blanks then it should be enclosed within a set of double-quotes(").

Example


RexxHandler "c:/handlers/cnthandlr.rex"





RexxHeaderParserHandler

After the URI translation phase Apache give you another chance to examine the request headers and take special actions in the header_parser phase.

This handler phase is free to change request fields in the HTTP header or abort the transaction entirely.

This directive can appear in the <Directory>, <Location>, <Files> sections, or .htaccess files.

Directive Prototype


RexxHeaderParserHandler rexxprocname

Directive Parameters

rexxprocname
The name of the Rexx procedure file to be executed for this handler. If the rexxprocname contains embedded blanks then it should be enclosed within a set of double-quotes(").

Example


RexxHeaderParserHandler "c:/handlers/hdphandlr.rex"





RexxLogHandler

This phase is called after the transaction is either aborted or completed. You can perform any special logging for the transaction during this phase.

This directive can appear in the <Directory>, <Location>, <Files> sections, or .htaccess files.

Directive Prototype


RexxLogHandler rexxprocname

Directive Parameters

rexxprocname
The name of the Rexx procedure file to be executed for this handler. If the rexxprocname contains embedded blanks then it should be enclosed within a set of double-quotes(").

Example


RexxLogHandler "c:/handlers/loghandlr.rex"





RexxPostReadRequestHandler

The post_read_request handler is called every time an Apache process receives an incomming request. At the point this handler is invoked the incomming request's data has been read and the HTTP header fields have been parsed, but the server has not translated the URI to a filename.

This handler phase is usually used to perform processing which must be done for each incomming transaction

This directive can appear in the main configuration file and within virtual host sections, but not within <Directory>, <Location>, <Files> sections, or .htaccess files.

Directive Prototype


RexxPostReadRequestHandler rexxprocname

Directive Parameters

rexxprocname
The name of the Rexx procedure file to be executed for this handler. If the rexxprocname contains embedded blanks then it should be enclosed within a set of double-quotes(").

Example


RexxPostReadRequestHandler "c:/handlers/prrhandlr.rex"





RexxRspCompiler

This specifies the Rexx script to be used to compile an RSP file into a Rexx program.

You only need to specify this directive if you want to override the default location (in the PATH) or the name (rspcomp.rex).

This directive can appear anywhere including <Directory>, <Location>, <Files> sections, or .htaccess files.

Directive Prototype


RexxRspCompiler rspcomp

Directive Parameters

rspcomp
The name of the Rexx procedure file to be used to create the temporary Rexx program version of an RSP file. If this is specified without a leading directory path specification then Rexx will try to locate the script in the current PATH.

If the directive is not found in Apache's configuration file then Mod_Rexx will look for the file "rspcomp.rex" in the PATH.

Example


RexxRspCompiler "c:/WINNT/rspcomp.rex"





RexxSetVar

Initializes a Rexx variable prior to the handler being executed. This directive is only valid when used with one of the Mod_Rexx handler directives.

Directive Prototype


RexxSetVar varname varvalue

Directive Parameters

varname
The name of the Rexx variable to be initialized.
varvalue
The value to be assigned to the Rexx variable. If the value contains embedded blanks then it should be enclosed within a set of double-quotes(").

Example


RexxSetVar config_file "c:/Apache/my_app/conf.txt"





RexxTempFileNameTemplate

This directive specifies the location and pattern to be used when the RSP compilation process creates temporary files. This directive is required when the Apache document tree contains RSP files.

This directive can appear anywhere including <Directory>, <Location>, <Files> sections, or .htaccess files.

Directive Prototype


RexxTempFileNameTemplate location_template

Directive Parameters

location_template
This template is used by Mod_Rexx to create a temporary file to hold the compiled version of the RSP file. The format of this template should conform to the Rexx rexxutil library external function SysTempFileName(). See your Rexx reference documentation for more information on the required format of the template. The '?' character is the only valid filter character for this directive and the template can contain a maximum of 5 filter characters.

Be sure that Apache has write access to the location you specify.

Example


RexxTempFileNameTemplate "c:/temp/execrsp?????.rex"





RexxTransHandler

The uri_translate handler is called after Apache has parsed out the request. This handler is responsible for translating the partial URI into filename. The handler can also alter the URI itself or to change the request method.

This handler phase is usually used to recognize and handle proxy requests.

This directive can appear in the main configuration file and within virtual host sections, but not within <Directory>, <Location>, <Files> sections, or .htaccess files.

Directive Prototype


RexxTransHandler rexxprocname

Directive Parameters

rexxprocname
The name of the Rexx procedure file to be executed for this handler. If the rexxprocname contains embedded blanks then it should be enclosed within a set of double-quotes(").

Example


RexxTransHandler "c:/handlers/transhandlr.rex"





RexxTypeHandler

After all the access and authentication phases, the type_checker phase assigns a MIME type to the requested document.

This directive can appear anywhere including <Directory>, <Location>, <Files> sections, or .htaccess files.

Directive Prototype


RexxTypeHandler rexxprocname

Directive Parameters

rexxprocname
The name of the Rexx procedure file to be executed for this handler. If the rexxprocname contains embedded blanks then it should be enclosed within a set of double-quotes(").

Example


RexxTypeHandler "c:/handlers/typhandlr.rex"

Valid XHTML 1.0! Copyright (C) W. David Ashley 2004. All Rights Reserved.