WebStack

docs/developing.html

732:7f1f02b485f8
2007-11-12 paulb [project @ 2007-11-12 00:50:03 by paulb] Introduced base classes for common authentication activities. Made cookie usage "safe" for usernames containing ":" characters. Added support for OpenID signatures.
     1 <?xml version="1.0" encoding="iso-8859-1"?>     2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">     3 <html xmlns="http://www.w3.org/1999/xhtml"><head>     4   <meta content="text/html;charset=ISO-8859-1" http-equiv="Content-Type" />     5   <title>Developing a WebStack Application</title>     6   <link href="styles.css" rel="stylesheet" type="text/css" /></head>     7 <body>     8 <h1>Developing a WebStack Application</h1>     9 <p>Many different topics are involved in the development of WebStack    10 applications; below is a map of each of the topics covered in this    11 documentation (with related example material found in the <code>examples/Common</code> directory given beside certain topics):</p>    12 <ul>    13   <li><a href="resources.html">Applications and Resources</a> (<code>VerySimple</code> example)</li>    14   <li><a href="resource-creation.html">How Resources are Created</a></li>    15   <li><a href="design.html">Application Design Considerations</a></li>    16 <ul>    17     <li><a href="paths.html">URLs and Paths</a></li><li><a href="path-strategies.html">Path Processing Strategies</a></li>    18 <li><a href="path-info.html">Paths To and Within Applications</a></li><li><a href="path-design.html">Path Design and Interpretation</a></li><ul>    19       <li><a href="paths-filesystem.html">Treating the Path Like a Filesystem</a> (<code>DemoApp</code> example, <code>Calendar</code> example)</li><li><a href="paths-services.html">Treating the Path Mostly Like a Filesystem</a></li><li><a href="paths-opaque.html">Using the Path as an Opaque Reference into an Application</a></li><ul>    20       </ul><li><a href="path-value-encoding.html">Encoding and Decoding Path Values</a></li><li><a href="path-manipulation.html">Manipulating Paths</a></li>    21         <li><a href="path-info-support.html">Path Info Support in Server Environments</a></li>    22       </ul><li><a href="methods.html">Request Methods</a></li>    23     <li><a href="parameters.html">Request Parameters and Uploads</a> (<code>Form</code> example)</li>    24     <ul>    25         <li><a href="parameters-headers.html">Request Header Parameters</a></li>    26         <li><a href="parameters-body.html">Request Body Parameters</a></li>    27     </ul><li><a href="headers.html">Request Headers</a></li>    28     <li><a href="responses.html">Responses and Presentation</a> (<code>Unicode</code> example)</li><ul><li><a href="redirection.html">Redirection</a></li></ul>    29     <li><a href="state.html">Cookies, Sessions, Users and Persistent Information</a></li>    30     <ul>    31       <li><a href="cookies.html">Cookies</a> (<code>Cookies</code> example)</li>    32       <li><a href="sessions.html">Sessions and Persistent Information</a></li>    33 <ul>    34           <li><a href="sessions-usage.html">Using Sessions</a> (<code>Sessions</code> example)</li>    35           <li><a href="sessions-servers.html">Server Environment Support for Sessions</a></li><li>(<a href="directory-repository.html">DirectoryRepository - Simple Access to Files in a Directory</a>)</li>    36       </ul><li><a href="users.html">Users and Authentication</a> (<code>Auth</code> example)</li>    37     </ul><li><a href="attributes.html">Transaction Attributes</a></li>    38   </ul><li><a href="securing.html">Securing a WebStack Application</a></li><ul><li><a href="authenticators.html">Application-Wide Authenticators</a></li><li><a href="login-redirect.html">LoginRedirect and Login Modules</a> (<code>SimpleWithLogin</code> example, <code>Login</code> example)</li></ul><li><a href="integrating.html">Integrating with Other Systems</a></li>    39 </ul><p>The following topic is referenced in many locations and should    40 be reviewed when encountering problems with input and output text:</p>    41 <ul><li><a href="encodings.html">Character Encodings</a></li></ul>    42 <h2>Deployment</h2><p>The following topics (illustrated by the programs found in the other subdirectories of the <code>examples</code> directory) describe how WebStack applications may be deployed in server environments:</p><ul><li><a href="supported-frameworks.html">Supported Frameworks</a></li><li><a href="deploying.html">Deploying a WebStack Application</a></li><ul><li><a href="writing-adapters.html">Writing Adapters</a></li><li><a href="pythonpath.html">Getting PYTHONPATH Right</a></li><li><a href="deploying-applications.html">Deploying an Application</a></li><ul><li><a href="BaseHTTPRequestHandler/NOTES.txt">BaseHTTPRequestHandler</a> (see <code>examples/BaseHTTPRequestHandler</code>)</li><li><a href="CGI/NOTES.txt">CGI</a> (see <code>examples/CGI</code>)</li><li><a href="Django/NOTES.txt">Django</a> (see <code>examples/Django</code>)</li><li><a href="JavaServlet/NOTES.txt">Java Servlet</a> (see <code>examples/JavaServlet</code>)</li><li><a href="ModPython/NOTES.txt">mod_python</a> (see <code>examples/ModPython</code>)</li><li><a href="Twisted/NOTES.txt">Twisted</a> (see <code>examples/Twisted</code>)</li><li><a href="Webware/NOTES.txt">Webware</a> (see <code>examples/Webware</code>)</li><li><a href="WSGI/NOTES.txt">WSGI</a> (see <code>examples/WSGI</code>)</li><li><a href="Zope/NOTES.txt">Zope</a> (see <code>examples/Zope</code>)</li></ul></ul><li>Technical note: <a href="features.html">Support for WebStack    43 Features in Server Environments</a></li></ul>    44 <h2>Useful Additions</h2><p>WebStack    45 provides a number of potentially useful modules either providing    46 resource classes for direct use in applications, or providing other    47 kinds of classes and functions which may be used to perform particular    48 activities.</p><p>The following resources are provided for direct use in applications:</p><ul><li><a href="login-redirect.html">LoginRedirect and Login Modules</a></li><li><a href="resource-map.html">ResourceMap - Simple Mappings from Names to Resources</a></li><li><a href="directory-resource.html">DirectoryResource - Serving Static Content</a></li><li><a href="file-resource.html">FileResource - Serving Individual Files</a></li><li><a href="selectors.html">Selectors - Components for Dispatching to Resources</a></li></ul><p>WebStack also provides modules which provide session-like access to different kinds of repositories:</p><ul><li><a href="directory-repository.html">DirectoryRepository - Simple Access to Files in a Directory</a></li></ul></body></html>