WebKit.Transaction | index /usr/local/share/webware/WebKit/Transaction.py

Modules

``

WebUtils os | sys time | traceback |

Classes

``

WebKit.Object.Object(__builtin__.object, MiscUtils.NamedValueAccess.NamedValueAccess)
  Transaction

class Transaction(WebKit.Object.Object)

``

`The Transaction container.
A transaction serves as:
* A container for all objects involved in the transaction. The
objects include application, request, response, session and
servlet.
* A message dissemination point. The messages include awake(),
respond() and sleep().
When first created, a transaction has no session. However, it will
create or retrieve one upon being asked for session().
The life cycle of a transaction begins and ends with Application's
dispatchRequest().
`

Method resolution order:
  Transaction
  WebKit.Object.Object
  __builtin__.object
  MiscUtils.NamedValueAccess.NamedValueAccess

Methods defined here:

__init__(self, application, request=None)

__repr__(self)

application(self)

awake(self)
  `Sends awake() to the session (if there is one) and the servlet.
  Currently, the request and response do not partake in the
  awake()-respond()-sleep() cycle. This could definitely be added
  in the future if any use was demonstrated for it.`

die(self)
  `End of transaction.
  This method should be invoked when the entire transaction is
  finished with. Currently, this is invoked by AppServer. This method
  removes references to the different objects in the transaction,
  breaking cyclic reference chains and allowing either older versions
  of Python to collect garbage, or newer versions to collect it faster.`

dump(self, file=None)
  `Dumps debugging info to stdout.`

duration(self)
  `Return the duration, in seconds, of the transaction.
  This is basically the response end time minus the request start time.`

errorOccurred(self)

hasSession(self)
  `Returns true if the transaction has a session.`

request(self)

respond(self)

response(self)

servlet(self)
  `Return the current servlet that is processing.
  Remember that servlets can be nested.`

session(self)
  `Return the session for the transaction.
  A new transaction is created if necessary. Therefore, this method
  never returns None. Use hasSession() if you want to find out if
  there one already exists.`

setErrorOccurred(self, flag)
  `Set error occured flag.
  Invoked by the application if an exception is raised to the
  application level.`

setResponse(self, response)

setServlet(self, servlet)

setSession(self, session)

sleep(self)
  `Sends sleep() to the session and the servlet.
  Note that sleep() is sent in reverse order as awake()
  (which is typical for shutdown/cleanup methods).`

writeExceptionReport(self, handler)

Data and other attributes defined here:

attrNames = ('application', 'request', 'response', 'session', 'servlet', 'errorOccurred')

exceptionReportAttrNames = ('application', 'request', 'response', 'session', 'servlet')

Methods inherited from WebKit.Object.Object:

deprecated(self, method)
  `Output a deprecation warning.
  The implementation of WebKit sometimes invokes this method which prints
  a warning that the method you are using has been deprecated.
  This method expects that deprecated methods say so at the beginning of
  their doc string and terminate that msg with @. For example:
  DEPRECATED: Class.foo() on 01/24/01 in ver 0.5. Use Class.bar() instead. @
  Putting this information in the doc string is important for accuracy
  in the generated docs.
  Example call:
  deprecated(self.foo)`

Data and other attributes inherited from WebKit.Object.Object:

__dict__ = <dictproxy object>
  `dictionary for instance variables (if defined)`

__weakref__ = <attribute '__weakref__' of 'Object' objects>
  `list of weak references to the object (if defined)`

Methods inherited from MiscUtils.NamedValueAccess.NamedValueAccess:

hasValueForKey(self, key)
  `Returns true if the key is available, although that does not
  guarantee that there will not be errors caused by retrieving the key.`

hasValueForName(self, keysString)

resetKeyBindings(self)

setValueForKey(self, key, value)
  `Suppose key is 'foo'. This method sets the value with the following precedence:
  1. Public attributes before private attributes
  2. Methods before non-methods
  More specifically, this method then uses one of the following:
  @@ 2000-03-04 ce: fill in
  ...or invokes handleUnknownSetKey().`

valueForKey(self, key, default=<class MiscUtils.NoDefault>)
  `Suppose key is 'foo'. This method returns the value with the following precedence:
  1. Methods before non-methods
  2. Public attributes before private attributes
  More specifically, this method then returns one of the following:
  * foo()
  * _foo()
  * self.foo
  * self._foo
  ...or default, if it was specified,
  otherwise invokes and returns result of valueForUnknownKey().
  Note that valueForUnknownKey(), normally returns an exception.
  See valueForName() which is a more advanced version of this method that allows
  multiple, qualified keys.`

valueForKeySequence(self, listOfKeys, default=None)

valueForName(self, keysString, default=None)
  `Returns the value for the given keysString. This is the more advanced version of
  valueForKey(), which can only handle single names. This method can handle
  'foo', 'foo1.foo2', 'a.b.c.d', etc. It will traverse dictionaries if needed.`

valueForUnknownKey(self, key, default)
  `# Errors`

valuesForNames(self, keys, default=None, defaults=None, forgive=0, includeNames=0)
  `Returns a list of values that match the given keys, each of which is passed
  through valueForName() and so could be of the form 'a.b.c'.
  keys is a sequence. default is any kind of object. defaults is a sequence.
  forgive and includeNames is a flag.
  If default is not None, then it is substituted when a key is not found.
  Otherwise, if defaults is not None, then it's corresponding/parallel value
  for the current key is substituted when a key is not found.
  Otherwise, if forgive=1, then unknown keys simply don't produce any values.
  Otherwise, if default and defaults are None, and forgive=0, then the unknown
  keys will probably raise an exception through valueForUnknownKey() although
  that method can always return a final, default value.
  if keys is None, then None is returned. If keys is an empty list, then None
  is returned.
  Often these last four arguments are specified by key.
  Examples:
  names = ['origin.x', 'origin.y', 'size.width', 'size.height']
  obj.valuesForNames(names)
  obj.valuesForNames(names, default=0.0)
  obj.valuesForNames(names, defaults=[0.0, 0.0, 100.0, 100.0])
  obj.valuesForNames(names, forgive=0)
  @@ 2000-03-04 ce: includeNames is only supported when forgive=1.
  It should be supported for the other cases.
  It should be documented.
  It should be included in the test cases.`

Functions

``

StringIO(...)
  `StringIO([s]) -- Return a StringIO-like stream for reading or writing`