Package twisted :: Package popsicle :: Module mailsicle :: Class MailsicleService
[frames | no frames]

Class MailsicleService

      Accessor --+        
                 |        
     Versioned --+        
                 |        
ApplicationService --+    
                     |    
               Service --+
                         |
                        MailsicleService


A twisted.cred service that's persistent in a Mailsicle database.

NOTE: such services must have a unique serviceName for the mailsicle they are persistent in. There is currently no checking.

TODO: this should be generalized to load Perspectives from any data-source that implements a certain Repository interface.
Method Summary
  __init__(self, msicle, serviceName, serviceParent, authorizer)
  __getstate__(self)
  __setstate__(self, dct)
  createPerspective(self, name)
Create a perspective from self.perspectiveClass and add it to this service.
  getPerspectiveNamed(self, name)
Return a perspective that represents a user for this service.
  stopService(self)
This call is made before shutdown.
    Inherited from Service
  addPerspective(self, perspective)
Add a perspective to this Service.
  cachePerspective(self, perspective)
Cache a perspective loaded from an external data source.
  getPerspectiveForIdentity(self, name, identity)
A hook to use if the identity is required when getting the perspective.
  getPerspectiveRequest(self, name)
Return a Deferred which is a request for a perspective on this service.
  getServiceName(self)
The name of this service.
  getServiceType(self)
Get a string describing the type of this service.
Deferred Perspective loadPerspective(self, name)
Load a perspective from an external data-source.
  setServiceParent(self, parent)
  uncachePerspective(self, perspective)
Uncache a perspective loaded from an external data source.
    Inherited from ApplicationService
  disownServiceParent(self)
Have my parent disown me.
  get_application(self)
  set_application(self, application)
  setApplication(self, application)
  startService(self)
This call is made as a service starts up.
  upgradeToVersion1(self)
    Inherited from Accessor
  __delattr__(self, k)
  __getattr__(self, k)
  __setattr__(self, k, v)
  reallyDel(self, k)
*actually* del self.k without incurring side-effects.
  reallySet(self, k, v)
*actually* set self.k to v without incurring side-effects.
    Inherited from Versioned
  versionUpgrade(self)
(internal) Do a version upgrade.

Class Variable Summary
    Inherited from Service
NoneType serviceName = None                                                                  
NoneType serviceType = None                                                                  
    Inherited from ApplicationService
int persistenceVersion = 1                                                                     
NoneType serviceParent = None                                                                  
int serviceRunning = 0                                                                     
    Inherited from Versioned
tuple persistenceForgets = ()

Method Details

createPerspective(self, name)

Create a perspective from self.perspectiveClass and add it to this service.
Overrides:
twisted.cred.service.Service.createPerspective (inherited documentation)

getPerspectiveNamed(self, name)

Return a perspective that represents a user for this service. (DEPRECATED)

Raises a KeyError if no such user exists. Override this method to provide dynamic instantiation of perspectives. It is only deprecated to call this method directly, not to override it; when you need to get a Perspective, call getPerspectiveRequest.
Overrides:
twisted.cred.service.Service.getPerspectiveNamed (inherited documentation)

stopService(self)

This call is made before shutdown.
Overrides:
twisted.internet.app.ApplicationService.stopService (inherited documentation)

Generated by Epydoc 2.0 on Sat Sep 13 04:20:40 2003 http://epydoc.sf.net