Download Install Tutorial Docs FAQ Tools WikiLicense Team IRC Planet Involvement Shop Book

Changeset 1006

Show
Ignore:
Timestamp:
03/11/06 22:37:20
Author:
dowski
Message:

Added documentation to the book for the wsgiappfilter.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/docs/book/xml/builtinfilters.xml

    r857 r1006  
    7373        </itemizedlist> 
    7474    </section> 
     75    <section id="nsgmlsfilter"> 
     76        <title>nsgmlsfilter</title> 
     77        <para>The nsgmlsfilter parses and validates SGML responses.</para> 
     78    </section> 
     79    <section id="sessionauthfilter"> 
     80        <title>sessionauthenticatefilter</title> 
     81        <para>The sessionauthenticatefilter provides simple form-based authentication and access 
     82        control.</para> 
     83    </section> 
     84    <section id="sessionfilter"> 
     85        <title>sessionfilter</title> 
     86        <para> The Session Filter has its own section</para> 
     87    </section> 
    7588    <section id="staticfilter"> 
    7689        <title>staticfilter</title> 
     
    88101            </listitem> 
    89102        </itemizedlist> 
    90     </section> 
    91     <section id="nsgmlsfilter"> 
    92         <title>nsgmlsfilter</title> 
    93         <para>The nsgmlsfilter parses and validates SGML responses.</para> 
    94103    </section> 
    95104    <section id="tidyfilter"> 
     
    123132        </itemizedlist> 
    124133    </section> 
     134    <section id="wsgiappfilter"> 
     135        <title>wsgiappfilter</title> 
     136        <para>The wsgiappfilter allows the application developer or deployer to mount 
     137        WSGI compatible applications and middleware to locations on the CherryPy 
     138        object tree.</para> 
     139        <para>Applications can be added to the tree in the config file or by using the 
     140            wsgiappfilter.WSGIApp convenience class to directly mount applications to the 
     141            CherryPy tree.  You can also instantiate the filter in a class's _cp_filters 
     142            special attribute. 
     143        </para> 
     144        <para>The wsgiappfilter.WSGIApp and WSGIAppFilter class contsructors takes the  
     145            following parameters: 
     146        </para> 
     147        <itemizedlist> 
     148            <listitem> 
     149                <para>wsgi_app - the WSGI application callable.</para> 
     150            </listitem> 
     151            <listitem> 
     152                <para>env_update - a dictionary of parameters to update the WSGI environment with.</para> 
     153            </listitem> 
     154        </itemizedlist> 
     155        <para>If you are controlling wsgiappfilter through the config system, use the following 
     156            configuration options:</para> 
     157        <itemizedlist> 
     158            <listitem> 
     159                <para>wsgiapp_filter.on - Default is False.  Set to True to enable the filter.</para> 
     160            </listitem> 
     161            <listitem> 
     162                <para>wsgiapp_filter.app - WSGI application callable or string 'package,module.attr' 
     163                    that references a WSGI application callable. 
     164                </para> 
     165            </listitem> 
     166            <listitem> 
     167                <para>wsgiapp_filter.env_update - a dictionary of parameters to update the WSGI 
     168                    environment with. 
     169                </para> 
     170            </listitem> 
     171        </itemizedlist> 
     172    </section> 
    125173    <section id="xmlrpcfilter"> 
    126174        <title>xmlrpcfilter</title> 
     
    135183        <para>The xmlrpcfilter does not have any configuration options.</para> 
    136184    </section> 
    137     <section id="sessionauthfilter"> 
    138         <title>sessionauthenticatefilter</title> 
    139         <para>The sessionauthenticatefilter provides simple form-based authentication and access 
    140         control.</para> 
    141     </section> 
    142     <section id="sessionfilter"> 
    143         <title>sessionfilter</title> 
    144         <para> The Session Filter has its own section</para> 
    145     </section> 
    146185</section> 

Hosted by WebFaction

Log in as guest/cpguest to create tickets