Package flumotion :: Package component :: Package bouncers :: Module bouncer :: Class ChallengeResponseBouncer
[show private | hide private]
[frames | no frames]

Type ChallengeResponseBouncer

object --+            
         |            
   GObject --+        
             |        
object --+   |        
         |   |        
 InitMixin --+        
             |        
  Loggable --+        
             |        
 BaseComponent --+    
                 |    
           Bouncer --+
                     |
                    ChallengeResponseBouncer


A base class for Challenge-Response bouncers
Method Summary
  _requestAvatarIdCallback(self, PossibleAvatarId, keycard)
  _requestAvatarIdErrback(self, failure, keycard)
  addUser(self, user, salt, *args)
  do_authenticate(self, keycard)
Must be overridden by subclasses.
  init(self)
A subclass should do as little as possible in its init method.
  setChecker(self, checker)
    Inherited from Bouncer
  addKeycard(self, keycard)
  authenticate(self, keycard)
  expireAllKeycards(self)
  expireKeycardId(self, id)
  getDomain(self)
  hasKeycard(self, keycard)
  removeKeycard(self, keycard)
  removeKeycardId(self, id)
  setDomain(self, name)
  setEnabled(self, enabled)
  typeAllowed(self, keycard)
Verify if the keycard is an instance of a Keycard class specified in the bouncer's keycardClasses variable.
    Inherited from BaseComponent
  __init__(self)
Subclasses should not override __init__ at all.
  addMessage(self, message)
Add a message to the component.
  adminCallRemote(self, methodName, *args, **kwargs)
Call a remote method on all admin client views on this component.
  do_check(self)
Subclasses can implement me to run any checks before the component performs setup.
  do_setup(self)
Subclasses can implement me to set up the component before it is started.
  do_start(self, *args, **kwargs)
BaseComponent vmethod for starting up.
  do_stop(self)
BaseComponent vmethod for stopping.
  emit(self, name, *args)
  fixRenamedProperties(self, properties, list)
Fix properties that have been renamed from a previous version, and add a warning for them.
int getMood(self)
Gets the mood on the component.
  getName(self)
  getWorkerName(self)
  setMedium(self, medium)
  setMood(self, mood)
Set the given mood on the component if it's different from the current one.
  setShutdownHook(self, shutdownHook)
Set the shutdown hook for this component (replacing any previous hook).
  setup(self, config, *args, **kwargs)
Sets up the component with the given config.
  setWorkerName(self, workerName)
  start(self, *args, **kwargs)
Tell the component to start.
  stop(self)
Tell the component to stop.
  _setConfig(self, config)
  _updateCPUUsage(self)
    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.
    Inherited from GObject
  __cmp__(x, y)
x.__cmp__(y) <==> cmp(x,y)
  __gobject_init__(...)
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __repr__(x)
x.__repr__() <==> repr(x)
  chain(...)
  connect(...)
  connect_after(...)
  connect_object(...)
  connect_object_after(...)
  disconnect(...)
  disconnect_by_func(...)
  emit_stop_by_name(...)
  freeze_notify(...)
  get_data(...)
  get_property(...)
  handler_block(...)
  handler_block_by_func(...)
  handler_disconnect(...)
  handler_is_connected(...)
  handler_unblock(...)
  handler_unblock_by_func(...)
  notify(...)
  set_data(...)
  set_property(...)
  stop_emission(...)
  thaw_notify(...)
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Instance Variable Summary
    Inherited from BaseComponent
BaseComponentMedium medium: the component's medium
string name: the name of the component

Class Variable Summary
tuple challengeResponseClasses = ()
    Inherited from Bouncer
tuple of flumotion.common.keycards.Keycard class objects keycardClasses: tuple of all classes of keycards this bouncer can authenticate, in order of preference
str logCategory: Implementors can provide a category to log their messages under.
    Inherited from BaseComponent
GType __gtype__ = <GType flumotion+component+component+BaseCom...
    Inherited from Loggable
Implements __implemented__ = <implementedBy flumotion.common.log.Lo...
ClassProvides __providedBy__ = <zope.interface.declarations.ClassProvi...
ClassProvides __provides__ = <zope.interface.declarations.ClassProvide...
    Inherited from GObject
str __gdoc__ = 'Object GObject\n\nSignals from GObject:\n  n...
getset_descriptor __grefcount__ = <attribute '__grefcount__' of 'gobject.G...
GProps props = <gobject.GProps object at 0x407983d0>

Method Details

do_authenticate(self, keycard)

Must be overridden by subclasses.

Authenticate the given keycard. Return the keycard with state AUTHENTICATED to authenticate, with state REQUESTING to continue the authentication process, or None to deny the keycard, or a deferred which should have the same eventual value.
Overrides:
flumotion.component.bouncers.bouncer.Bouncer.do_authenticate (inherited documentation)

init(self)

A subclass should do as little as possible in its init method. In particular, it should not try to access resources.

Failures during init are marshalled back to the manager through the worker's remote_create method, since there is no component state proxied to the manager yet at the time of init.
Overrides:
flumotion.component.bouncers.bouncer.Bouncer.init (inherited documentation)

Class Variable Details

challengeResponseClasses

Type:
tuple
Value:
()                                                                     

Generated by Epydoc 2.1 on Sat Apr 14 13:20:45 2007 http://epydoc.sf.net