Package flumotion :: Package twisted :: Module portal :: Class BouncerPortal
[show private | hide private]
[frames | no frames]

Class BouncerPortal

Loggable --+
           |
          BouncerPortal

Known Subclasses:
ProxyManagerBouncerPortal

I am a portal for an FPB server using a bouncer to decide on FPB client access.
Method Summary
  __init__(self, realm, bouncer)
Create a BouncerPortal to a twisted.cred.portal.IRealm.
defer.Deferred firing list of str getKeycardClasses(self)
Return the Keycard interfaces supported by this portal's bouncer.
  login(self, keycard, mind, *ifaces)
Log in the keycard to the portal using the bouncer.
  _authenticateCallback(self, result, mind, *ifaces)
    Inherited from Loggable
  debug(self, *args)
Log a debug message.
dict doLog(self, level, where, format, *args, **kwargs)
Log a message at the given level, with the possibility of going higher up in the stack.
  error(self, *args)
Log an error.
  info(self, *args)
Log an informational message.
  log(self, *args)
Log a log message.
  logFunction(self, *args)
Overridable log function.
  logObjectName(self)
Overridable object name function.
  warning(self, *args)
Log a warning.
  warningFailure(self, failure, swallow)
Log a warning about a Failure.

Class Variable Summary
Implements __implemented__ = <implementedBy flumotion.twisted.porta...
ClassProvides __provides__ = <zope.interface.declarations.ClassProvide...
str logCategory: Implementors can provide a category to log their messages under.
    Inherited from Loggable
ClassProvides __providedBy__ = <zope.interface.declarations.ClassProvi...

Method Details

__init__(self, realm, bouncer)
(Constructor)

Create a BouncerPortal to a twisted.cred.portal.IRealm.
Parameters:
realm - an implementor of twisted.cred.portal.IRealm
bouncer - a bouncer to use for authentication
           (type=flumotion.component.bouncers.bouncer.Bouncer)

getKeycardClasses(self)

Return the Keycard interfaces supported by this portal's bouncer.
Returns:
defer.Deferred firing list of str

login(self, keycard, mind, *ifaces)

Log in the keycard to the portal using the bouncer.
Parameters:
keycard - the keycard used to login
           (type=flumotion.common.keycards.Keycard)
mind - a reference to the client-side requester
           (type=twisted.spread.pb.RemoteReference)
ifaces - a list of interfaces for the perspective that the mind wishes to attach to
Returns:
a deferred, which will fire a tuple of (interface, avatarAspect, logout) or None.

Class Variable Details

__implemented__

Type:
Implements
Value:
<implementedBy flumotion.twisted.portal.BouncerPortal>                 

__provides__

Type:
ClassProvides
Value:
<zope.interface.declarations.ClassProvides object at 0x305b3130>       

logCategory

Implementors can provide a category to log their messages under.
Type:
str
Value:
'BouncerPortal'                                                        

Generated by Epydoc 2.1 on Fri May 18 09:35:52 2007 http://epydoc.sf.net