twisted.coil.app.ServiceCollection

Package twisted :: Package coil :: Module app :: Class ServiceCollection

[show private | hide private]

Class ServiceCollection

Collection --+        
             |        
   Constrained --+    
                 |    
  ConfigCollection --+
                     |
                    ServiceCollection

A collection of Service objects.

Method Summary
	`__init__(self, app)`
	`delEntity(self, name)` Remove a static reference for 'name'.
	`entityConstraint(self, entity)` A method that determines whether an entity may be added to me. (inherited from `ConfigCollection`)
	`getDynamicEntity(self, name, request)` Subclass this to generate an entity on demand. (inherited from `Collection`)
	`getEntity(self, name, request)` Retrieve an entity from me. (inherited from `Collection`)
	`getEntityType(self)`
	`getNameType(self)` (inherited from `ConfigCollection`)
	`getStaticEntity(self, name)` Get an entity that was added to me using putEntity.
	`listDynamicEntities(self, request)` A list of all name, entity that I can generate on demand. (inherited from `Collection`)
	`listDynamicNames(self)` Retrieve a list of the names of entities that I store references to. (inherited from `Collection`)
	`listEntities(self, request)` Retrieve a list of all name, entity pairs I contain. (inherited from `Collection`)
	`listNames(self, request)` Retrieve a list of all names for entities that I contain. (inherited from `Collection`)
	`listStaticEntities(self)` Retrieve a list of all name, entity pairs that I store references to.
	`listStaticNames(self)` Retrieve a list of the names of entities that I store references to. (inherited from `Collection`)
	`nameConstraint(self, name)` A method that determines whether an entity may be added to me with a given name. (inherited from `Constrained`)
	`putEntity(self, name, entity)` Store an entity if it meets both constraints. (inherited from `Constrained`)
	`reallyPutEntity(self, name, entity)`
	`removeEntity(self, name, request)` Remove an entity for 'name', based on the content of 'request'. (inherited from `Collection`)
	`storeEntity(self, name, request)` Store an entity for 'name', based on the content of 'request'. (inherited from `Collection`)

Class Variable Summary
`class`	`IService`

Method Details

delEntity(self, name)

Remove a static reference for 'name'.

Raises a KeyError if the operation fails.

Overrides:: twisted.python.roots.Collection.delEntity (inherited documentation)

getStaticEntity(self, name)

Get an entity that was added to me using putEntity.

This method will return 'None' if it fails.

Overrides:: twisted.python.roots.Collection.getStaticEntity (inherited documentation)

listStaticEntities(self)

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

See getStaticEntity.

Overrides:: twisted.python.roots.Collection.listStaticEntities (inherited documentation)

Class Variable Details

IService

IService = twisted.cred.service.IService

Generated by Epydoc 1.1 on Fri Jun 27 03:47:43 2003

http://epydoc.sf.net