twisted.web.vhost.NameVirtualHost

Package twisted :: Package web :: Module vhost :: Class NameVirtualHost

Class NameVirtualHost

Collection --+            
             |            
   Constrained --+        
                 |        
  ConfigCollection --+    
                     |    
              Resource --+
                         |
                        NameVirtualHost

I am a resource which represents named virtual hosts.

Method Summary
	`__init__(self)` Initialize.
	`_getResourceForRequest(self, request)` (Internal) Get the appropriate resource for the given host.
	`addHost(self, name, resrc)` Add a host to this virtual host.
	`getChild(self, path, request)` Implementation of resource.Resource's getChild method.
	`getStaticEntity(self, name)` Get an entity that was added to me using putEntity.
	`listStaticEntities(self)` Retrieve a list of all name, entity pairs that I store references to.
	`removeHost(self, name)` Remove a host.
	`render(self, request)` Implementation of resource.Resource's render method.
Inherited from Resource
	`delEntity(self, name)` Remove a static reference for 'name'.
	`getChildForRequest(self, request)` (internal) Get a child of mine dependant on a particular request.
	`getChildWithDefault(self, path, request)` Retrieve a static or dynamically generated child resource from me.
	`getDynamicEntity(self, name, request)` Subclass this to generate an entity on demand.
	`listDynamicEntities(self, request)` A list of all name, entity that I can generate on demand.
	`listDynamicNames(self)` Retrieve a list of the names of entities that I store references to.
	`listEntities(self)`
	`listNames(self)`
	`listStaticNames(self)` Retrieve a list of the names of entities that I store references to.
	`putChild(self, path, child)` Register a static child.
	`reallyPutEntity(self, name, entity)`
Inherited from ConfigCollection
	`entityConstraint(self, entity)` A method that determines whether an entity may be added to me.
	`getEntityType(self)`
	`getNameType(self)`
Inherited from Constrained
	`nameConstraint(self, name)` A method that determines whether an entity may be added to me with a given name.
	`putEntity(self, name, entity)` Store an entity if it meets both constraints.
Inherited from Collection
	`getEntity(self, name, request)` Retrieve an entity from me.
	`removeEntity(self, name, request)` Remove an entity for 'name', based on the content of 'request'.
	`storeEntity(self, name, request)` Store an entity for 'name', based on the content of 'request'.

Class Variable Summary
`NoneType`	`default` = None
Inherited from Resource
`tuple`	`__implements__` = `(<class twisted.web.resource.IResource ...`
`int`	`isLeaf` = 0
`NoneType`	`server` = None

Method Details

init(self)
(Constructor)

Initialize.

Overrides:: twisted.web.resource.Resource.__init__

_getResourceForRequest(self, request)

(Internal) Get the appropriate resource for the given host.

addHost(self, name, resrc)

Add a host to this virtual host.

This will take a host named `name', and map it to a resource `resrc'. For example, a setup for our virtual hosts would be:

   nvh.addHost('divunal.com', divunalDirectory)
   nvh.addHost('www.divunal.com', divunalDirectory)
   nvh.addHost('twistedmatrix.com', twistedMatrixDirectory)
   nvh.addHost('www.twistedmatrix.com', twistedMatrixDirectory)

getChild(self, path, request)

Implementation of resource.Resource's getChild method.

Overrides:: twisted.web.resource.Resource.getChild

getStaticEntity(self, name)

Get an entity that was added to me using putEntity.

This method will return 'None' if it fails.

Overrides:: twisted.web.resource.Resource.getStaticEntity (inherited documentation)

listStaticEntities(self)

Retrieve a list of all name, entity pairs that I store references to.

See getStaticEntity.

Overrides:: twisted.web.resource.Resource.listStaticEntities (inherited documentation)

removeHost(self, name)

Remove a host.

render(self, request)

Implementation of resource.Resource's render method.

Overrides:: twisted.web.resource.Resource.render

Class Variable Details

default

Type:: NoneType
Value:: None

Generated by Epydoc 2.0 on Sat Sep 13 04:20:49 2003

http://epydoc.sf.net