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

`Servlet factory for unknown file types.`

Modules

``

WebKit.HTTPExceptions | os |  |

Classes

``

MiscUtils.Configurable.Configurable(__builtin__.object)
  UnknownFileTypeServlet(WebKit.HTTPServlet.HTTPServlet, MiscUtils.Configurable.Configurable)
WebKit.HTTPServlet.HTTPServlet(WebKit.Servlet.Servlet)
  UnknownFileTypeServlet(WebKit.HTTPServlet.HTTPServlet, MiscUtils.Configurable.Configurable)
WebKit.ServletFactory.ServletFactory(__builtin__.object)
  UnknownFileTypeServletFactory

class UnknownFileTypeServlet(WebKit.HTTPServlet.HTTPServlet, MiscUtils.Configurable.Configurable)

``

`Servlet for unknown file types.
Normally this class is just a "private" utility class for WebKit's
purposes. However, you may find it useful to subclass on occasion,
such as when the server side file path is determined by something
other than a direct correlation to the URL. Here is such an example:
from WebKit.AppServer import globalAppServer
from WebKit.UnknownFileTypeServlet import UnknownFileTypeServlet
import os
class Image(UnknownFileTypeServlet):
imageDir = '/var/images'
def filename(self, trans):
filename = trans.request().field('i')
filename = os.path.join(self.imageDir, filename)
return filename
`

Method resolution order:
  UnknownFileTypeServlet
  WebKit.HTTPServlet.HTTPServlet
  WebKit.Servlet.Servlet
  MiscUtils.Configurable.Configurable
  __builtin__.object

Methods defined here:

__init__(self, application=None)

canBeReused(self)

configFilename(self)

defaultConfig(self)
  `Get the default config.
  Taken from Application's 'UnknownFileTypes' default setting.`

filename(self, trans)
  `Return the filename to be served.
  A subclass could override this in order to serve files from other
  disk locations based on some logic.`

lastModified(self, trans)

respondToGet(self, trans)
  `Respond to GET request.
  Responds to the transaction by invoking foo() for foo is
  specified by the 'Technique' setting.`

respondToHead = respondToGet(self, trans)

respondToPost(self, trans)
  `Respond to POST request.
  Invoke respondToGet().
  Since posts are usually accompanied by data, this might not be
  the best policy. However, a POST would most likely be for a CGI,
  which currently no one is mixing in with their WebKit-based web sites.`

serveContent(self, trans)

shouldCacheContent(self)
  `Return whether the content should be cached or not.
  Returns a boolean that controls whether or not the content served
  through this servlet is cached. The default behavior is to return
  the CacheContent setting. Subclasses may override to always True
  or False, or incorporate some other logic.`

userConfig(self)
  `Get the user config.
  Taken from Application's 'UnknownFileTypes' user setting.`

Static methods defined here:

redirectSansAdapter(trans)
  `Redirect to web server.
  Sends a redirect to a URL that doesn't contain the adapter name.
  Under the right configuration, this will cause the web server to
  then be responsible for the URL rather than the app server.
  This has only been test with "*.[f]cgi" adapters.
  Keep in mind that links off the target page will *not* include
  the adapter in the URL.`

validTechniques()

Methods inherited from WebKit.HTTPServlet.HTTPServlet:

respond(self, trans)
  `Respond to a request.
  Invokes the appropriate respondToSomething() method depending on the
  type of request (e.g., GET, POST, PUT, ...).`

Static methods inherited from WebKit.HTTPServlet.HTTPServlet:

notImplemented(trans)

Methods inherited from WebKit.Servlet.Servlet:

awake(self, trans)
  `Send the awake message.
  This message is sent to all objects that participate in the
  request-response cycle in a top-down fashion, prior to respond().
  Subclasses must invoke super.`

close(self)

log(self, message)
  `Log a message.
  This can be invoked to print messages concerning the servlet.
  This is often used by self to relay important information back
  to developers.`

name(self)
  `Return the name which is simple the name of the class.
  Subclasses should *not* override this method.
  It is used for logging and debugging.`

open(self)

runMethodForTransaction(self, trans, method, *args, **kw)

serverSidePath(self, path=None)
  `Return the filesystem path of the page on the server.`

setFactory(self, factory)

sleep(self, trans)
  `Send the sleep message.`

Static methods inherited from WebKit.Servlet.Servlet:

canBeThreaded()
  `Return whether the servlet can be multithreaded.
  This value should not change during the lifetime of the object.
  The default implementation returns False.
  Note: This is not currently used.`

runTransaction(trans)

Data descriptors inherited from WebKit.Servlet.Servlet:

__dict__
  `dictionary for instance variables (if defined)`

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

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.`

configReplacementValues(self)
  `Return a dictionary for substitutions in the config file.
  This must be a dictionary suitable for use with "string % dict"
  that should be used on the text in the config file.
  If an empty dictionary (or None) is returned, then no substitution
  will be attempted.`

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.`

setting(self, name, default=<class 'MiscUtils.NoDefault'>)
  `Return the value of a particular setting in the configuration.`

class UnknownFileTypeServletFactory(WebKit.ServletFactory.ServletFactory)
`` | `The servlet factory for unknown file types. I.e. all files other than .py, .psp, .kid and the other types we support.`

Method resolution order:
  UnknownFileTypeServletFactory
  WebKit.ServletFactory.ServletFactory
  __builtin__.object

Methods defined here:

extensions(self)

flushCache(self)

servletForTransaction(self, transaction)

uniqueness(self)

Methods inherited from WebKit.ServletFactory.ServletFactory:

__init__(self, application)
  `Create servlet factory.
  Stores a reference to the application in self._app, because
  subclasses may or may not need to talk back to the application
  to do their work.`

importAsPackage(self, transaction, serverSidePathToImport)
  `Import requested module.
  Imports the module at the given path in the proper package/subpackage
  for the current request. For example, if the transaction has the URL
  http://localhost/WebKit.cgi/MyContextDirectory/MySubdirectory/MyPage
  and path = 'some/random/path/MyModule.py' and the context is configured
  to have the name 'MyContext' then this function imports the module at
  that path as MyContext.MySubdirectory.MyModule . Note that the context
  name may differ from the name of the directory containing the context,
  even though they are usually the same by convention.
  Note that the module imported may have a different name from the
  servlet name specified in the URL. This is used in PSP.`

loadClass(self, transaction, path)
  `Load the appropriate class.
  Given a transaction and a path, load the class for creating these
  servlets. Caching, pooling, and threadsafeness are all handled by
  servletForTransaction. This method is not expected to be threadsafe.`

name(self)
  `Return the name of the factory.
  This is a convenience for the class name.`

returnServlet(self, servlet)
  `Return servlet to the pool.
  Called by Servlet.close(), which returns the servlet
  to the servlet pool if necessary.`

Data descriptors inherited from WebKit.ServletFactory.ServletFactory:

__dict__
  `dictionary for instance variables (if defined)`

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

Data
`` |  | debug = 0 fileCache = {}