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

`The Application singleton.
`Application` and `AppServer` work together to setup up and dispatch requests.
The distinction between the two is largely historical, but AppServer
communicates directly with Adapters (or speaks protocols like HTTP), and
Application receives the (slightly) processed input from AppServer and turns
it into `Transaction`, `HTTPRequest`, `HTTPResponse`, and `Session`.
Application is a singleton, which belongs to the AppServer. You can get access
through the Transaction object (`transaction.application()`), or you can do::
from AppServer import globalAppServer
application = globalAppServer.application()
Settings for Application are taken from ``Configs/Application.config``,
which is used for many global settings, even if they aren't closely tied
to the Application object itself.`

Modules

``

WebKit.URLParser | os | sys |

Classes

``

WebKit.ConfigurableForServerSidePath.ConfigurableForServerSidePath(MiscUtils.Configurable.Configurable)
  Application
exceptions.Exception(exceptions.BaseException)
  EndResponse

class Application(WebKit.ConfigurableForServerSidePath.ConfigurableForServerSidePath)
`` | `The Application singleton. Purpose and usage are explained in the module docstring.`

Method resolution order:
  Application
  WebKit.ConfigurableForServerSidePath.ConfigurableForServerSidePath
  MiscUtils.Configurable.Configurable
  __builtin__.object

Methods defined here:

__init__(self, server, useSessionSweeper=True)
  `Called only by `AppServer`, sets up the Application.`

addContext(self, name, path)
  `Add a context by named `name`, rooted at `path`.
  This gets imported as a package, and the last directory
  of `path` does not have to match the context name.
  (The package will be named `name`, regardless of `path`).
  Delegated to `URLParser.ContextParser`.`

addShutDownHandler(self, func)
  `Add a shutdown handler.
  Functions added through `addShutDownHandler` will be called when
  the AppServer is shutting down. You can use this hook to close
  database connections, clean up resources, save data to disk, etc.`

callMethodOfServlet(self, trans, url, method, *args, **kw)
  `Call method of another servlet.
  Call a method of the servlet referred to by the URL. Calls sleep()
  and awake() before and after the method call. Or, if the servlet
  defines it, then `runMethodForTransaction` is used (analogous to the
  use of `runTransaction` in `forward`).
  The entire process is similar to `forward`, except that instead of
  `respond`, `method` is called (`method` should be a string, `*args`
  and `**kw` are passed as arguments to that method).`

configFilename(self)

configReplacementValues(self)

contexts(self)
  `Return a dictionary of context-name: context-path.`

createSessionForTransaction(self, trans)
  `Get the session object for the transaction.
  If the session already exists, returns that, otherwise creates
  a new session.
  Finding the session ID is done in `Transaction.sessionId`.`

createSessionWithID(self, trans, sessionID)
  `Create a session object with our session ID.`

defaultConfig(self)
  `The default Application.config.`

dispatchRawRequest(self, requestDict, strmOut)
  `Dispatch a raw request.
  Dispatch a request as passed from the Adapter through the AppServer.
  This method creates the request, response, and transaction object,
  then runs (via `runTransaction`) the transaction. It also catches any
  exceptions, which are then passed on to `handleExceptionInTransaction`.`

errorPage(self, errorClass)
  `Get the error page url corresponding to an error class.`

forward(self, trans, url)
  `Forward the request to a different (internal) URL.
  The transaction's URL is changed to point to the new servlet,
  and the transaction is simply run again.
  Output is _not_ accumulated, so if the original servlet had any output,
  the new output will _replace_ the old output.
  You can change the request in place to control the servlet you are
  forwarding to -- using methods like `HTTPRequest.setField`.`

handleException(self)
  `Handle exceptions.
  This should only be used in cases where there is no transaction object,
  for example if an exception occurs when attempting to save a session
  to disk.`

handleExceptionInTransaction(self, excInfo, trans)
  `Handle exception with info.
  Handles exception `excInfo` (as returned by `sys.exc_info()`)
  that was generated by `transaction`. It may display the exception
  report, email the report, etc., handled by
  `ExceptionHandler.ExceptionHandler`.`

handleMissingPathSession(self, trans)
  `Redirect requests without session info in the path.
  If UseAutomaticPathSessions is enabled in Application.config
  we redirect the browser to an absolute url with SID in path
  http://gandalf/a/_SID_=2001080221301877755/Examples/
  _SID_ is extracted and removed from path in HTTPRequest.py
  This is for convinient building of webapps that must not
  depend on cookie support.
  Note that we create an absolute URL with scheme and hostname
  because otherwise IIS will only cause an internal redirect.`

handlePathSession(self, trans)
  `Handle the session identifier that has been found in the path.`

handleUnnecessaryPathSession(self, trans)
  `Redirect request with unnecessary session info in the path.
  This is called if it has been determined that the request has a path
  session, but also cookies. In that case we redirect to eliminate the
  unnecessary path session.`

hasContext(self, name)
  `Checks whether context `name` exist.`

hasSession(self, sessionId)
  `Check whether session `sessionId` exists.`

includeURL(self, trans, url)
  `Include another servlet.
  Include the servlet given by the URL. Like `forward`,
  except control is ultimately returned to the servlet.`

initErrorPage(self)
  `Initialize the error page related attributes.`

initSessions(self)
  `Initialize all session related attributes.`

initVersions(self)
  `Get and store versions.
  Initialize attributes that store the Webware and WebKit versions as
  both tuples and strings. These are stored in the Properties.py files.`

makeDirs(self)
  `Make sure some standard directories are always available.`

rootURLParser(self)
  `Accessor: the Rool URL parser.
  URL parsing (as defined by subclasses of `URLParser.URLParser`)
  starts here. Other parsers are called in turn by this parser.`

runTransaction(self, trans)
  `Run transation.
  Executes the transaction, handling HTTPException errors.
  Finds the servlet (using the root parser, probably
  `URLParser.ContextParser`, to find the servlet for the
  transaction, then calling `runTransactionViaServlet`.
  Called by `dispatchRawRequest`.`

server(self)
  `Acessor: the AppServer`

serverSidePath(self, path=None)
  `Get the server-side path.
  Returns the absolute server-side path of the WebKit application.
  If the optional path is passed in, then it is joined with the
  server side directory to form a path relative to the app server.`

session(self, sessionId, default=<class 'MiscUtils.NoDefault'>)
  `The session object for `sessionId`.
  Raises `KeyError` if session not found and no default is given.`

sessionCookiePath(self, trans)
  `Get the cookie path for this transaction.
  If not path is specified in the configuration setting,
  the servlet path is used for security reasons, see:
  http://www.net-security.org/dl/articles/cookie_path.pdf`

sessionName(self, trans)
  `Get the name of the field holding the session ID.
  Overwrite to make this transaction dependent.`

sessionPrefix(self, trans)
  `Get the prefix string for the session ID.
  Overwrite to make this transaction dependent.`

sessionTimeout(self, trans)
  `Get the timeout (in seconds) for a user session.
  Overwrite to make this transaction dependent.`

sessions(self)
  `A dictionary of all the session objects.`

shutDown(self)
  `Shut down the application.
  Called by AppServer when it is shuting down. The `__del__` function
  of Application probably won't be called due to circular references.`

startSessionSweeper(self)
  `Start session sweeper.
  Starts the session sweeper, `WebKit.Tasks.SessionTask`, which deletes
  session objects (and disk copies of those objects) that have expired.`

taskManager(self)
  `Accessor: `TaskKit.Scheduler` instance.`

webKitPath(self)
  `The Path of the ``Webware/WebKit/`` directory.`

webKitVersion(self)
  `Return the WebKit version as a tuple.`

webKitVersionString(self)
  `Return the WebKit version as a printable string.`

webwarePath(self)
  `The path of the ``Webware/`` directory.`

webwareVersion(self)
  `Return the Webware version as a tuple.`

webwareVersionString(self)
  `Return the Webware version as a printable string.`

writeActivityLog(self, trans)
  `Write an entry to the activity log.
  Writes an entry to the script log file. Uses settings
  ``ActivityLogFilename`` and ``ActivityLogColumns``.`

writeExceptionReport(self, handler)
  `Write extra information to the exception report.
  See `WebKit.ExceptionHandler` for more information.`

Static methods defined here:

addServletFactory(factory)
  `Add a ServletFactory.
  Delegated to the `URLParser.ServletFactoryManager` singleton.`

createRequestForDict(requestDict)
  `Create request object for a given dictionary.
  Create a request object (subclass of `Request`) given the raw
  dictionary as passed by the adapter.
  The class of the request may be based on the contents of the
  dictionary (though only `HTTPRequest` is currently created),
  and the request will later determine the class of the response.
  Called by `dispatchRawRequest`.`

name()
  `The name by which this was started. Usually `AppServer`.`

removePathSession(trans)
  `Remove a possible session identifier from the path.`

resolveInternalRelativePath(trans, url)
  `Return the absolute internal path.
  Given a URL, return the absolute internal URL.
  URLs are assumed relative to the current URL.
  Absolute paths are returned unchanged.`

returnServlet(servlet)
  `Return the servlet to its pool.`

runTransactionViaServlet(servlet, trans)
  `Execute the transaction using the servlet.
  This is the `awake`/`respond`/`sleep` sequence of calls, or if
  the servlet supports it, a single `runTransaction` call (which is
  presumed to make the awake/respond/sleep calls on its own). Using
  `runTransaction` allows the servlet to override the basic call
  sequence, or catch errors from that sequence.
  Called by `runTransaction`.`

Methods inherited from WebKit.ConfigurableForServerSidePath.ConfigurableForServerSidePath:

setting(self, name, default=<class 'MiscUtils.NoDefault'>)
  `Return setting, using the server side path when indicated.
  Returns the setting, filtered by serverSidePath(),
  if the name ends with ``Filename`` or ``Dir``.`

Methods inherited from MiscUtils.Configurable.Configurable:

commandLineConfig(self)
  `Return the settings that came from the command-line.
  These settings come via addCommandLineSetting().`

config(self)
  `Return the configuration of the object as a dictionary.
  This is a combination of defaultConfig() and userConfig().
  This method caches the config.`

configName(self)
  `Return the name of the configuration file without the extension.
  This is the portion of the config file name before the '.config'.
  This is used on the command-line.`

hasSetting(self, name)
  `Check whether a configuration setting has been changed.`

printConfig(self, dest=None)
  `Print the configuration to the given destination.
  The default destination is stdout. A fixed with font is assumed
  for aligning the values to start at the same column.`

setSetting(self, name, value)
  `Set a particular configuration setting.`

userConfig(self)
  `Return the user config overrides.
  These settings can be found in the optional config file.
  Returns {} if there is no such file.
  The config filename is taken from configFilename().`

Data descriptors inherited from MiscUtils.Configurable.Configurable:

__dict__
  `dictionary for instance variables (if defined)`

__weakref__
  `list of weak references to the object (if defined)`

class EndResponse(exceptions.Exception)
`` | `End response exception. Used to prematurely break out of the awake()/respond()/sleep() cycle without reporting a traceback. During servlet processing, if this exception is caught during awake() or respond() then sleep() is called and the response is sent. If caught during sleep(), processing ends and the response is sent.`

Method resolution order:
  EndResponse
  exceptions.Exception
  exceptions.BaseException
  __builtin__.object

Data descriptors defined here:

__weakref__
  `list of weak references to the object (if defined)`

Methods inherited from exceptions.Exception:

__init__(...)
  `x.__init__(...) initializes x; see help(type(x)) for signature`

Data and other attributes inherited from exceptions.Exception:

__new__ = <built-in method __new__ of type object>
  `T.__new__(S, ...) -> a new object with type S, a subtype of T`

Methods inherited from exceptions.BaseException:

__delattr__(...)
  `x.__delattr__('name') <==> del x.name`

__getattribute__(...)
  `x.__getattribute__('name') <==> x.name`

__getitem__(...)
  `x.__getitem__(y) <==> x[y]`

__getslice__(...)
  `x.__getslice__(i, j) <==> x[i:j]
  Use of negative indices is not supported.`

__reduce__(...)

__repr__(...)
  `x.__repr__() <==> repr(x)`

__setattr__(...)
  `x.__setattr__('name', value) <==> x.name = value`

__setstate__(...)

__str__(...)
  `x.__str__() <==> str(x)`

__unicode__(...)

Data descriptors inherited from exceptions.BaseException:

__dict__

args

message

Data

``

debug = False
defaultConfig = {'ActivityLogColumns': ['request.remoteAddress', 'request.method', 'request.uri', 'response.size', 'servlet.name', 'request.timeStamp', 'transaction.duration', 'transaction.errorOccurred'], 'ActivityLogFilename': 'Logs/Activity.csv', 'AlwaysSaveSessions': True, 'CacheDir': 'Cache', 'Contexts': {'Admin': 'Admin', 'Docs': 'Docs', 'Examples': 'Examples', 'Testing': 'Testing', 'default': 'Examples'}, 'Debug': {'Sessions': False}, 'DirectoryFile': ['index', 'Index', 'main', 'Main'], 'EmailErrorReportAsAttachment': False, 'EmailErrors': False, 'EnterDebuggerOnException': False, ...}