Arena  1.0
A content management system
 All Classes Files Functions Variables Pages
Library.IO.HTTP.Requests.AnHTTPRequest Class Reference

This class consolidates the various variables related to an HTTP request. More...

+ Inheritance diagram for Library.IO.HTTP.Requests.AnHTTPRequest:

Public Member Functions

def __init__
 Constructor.
 
def init
 Initializer.
 
def __del__
 Destructor.
 
def get
 Gets the values of the HTTP request from the environment. More...
 
def toString
 Construct a string representation of the HTTP request. More...
 
def __getitem__
 Returns the named attribute. More...
 
def __contains__
 Determine whether the named attribute exists. More...
 
- Public Member Functions inherited from Library.Base.Classwork.AnObject
def init
 Initialize a new object instance. More...
 
def __init__
 Construct and initialize a new instance of AnObject. More...
 
def __del__
 Destroy the object instance. More...
 
def displayName
 Construct a "pretty" display name for the class instance, based on the name of its class. More...
 
def implements
 Determine whether the class instance is related to the specified class. More...
 
def toString
 Return a string representation of the class, suitable for output to a console or text-based device. More...
 
def __str__
 Return a string representation of the class. More...
 
def classname
 Return the name of the class from which the instance was created. More...
 
def name
 Return the name of the class. More...
 

Detailed Description

This class consolidates the various variables related to an HTTP request.

It can retrieve these from the environment and can print them to a stream.

Member Function Documentation

def Library.IO.HTTP.Requests.AnHTTPRequest.__contains__ (   Self,
  key 
)

Determine whether the named attribute exists.

This method is provided for convenience; it allows access to the AnHTTPRequest.query attribute, which is filled using the keys and values provided in AnHTTPRequest.queryString.

def Library.IO.HTTP.Requests.AnHTTPRequest.__getitem__ (   Self,
  key 
)

Returns the named attribute.

This method is provided for convenience; it allows access to the AnHTTPRequest.query attribute, which is filled using the keys and values provided in AnHTTPRequest.queryString.

Note that this routine disallows retrieving non-existent keys from the query attributes list.

def Library.IO.HTTP.Requests.AnHTTPRequest.get (   Self)

Gets the values of the HTTP request from the environment.

This method assumes that the script is being run as part of a CGI application. It queries the appropriate environment variables and stores the values within the class instance attributes.

def Library.IO.HTTP.Requests.AnHTTPRequest.toString (   Self)

Construct a string representation of the HTTP request.

This representation will be suitable for inclusion in the HTTP headers sent to a web server.


The documentation for this class was generated from the following file: