Package flumotion :: Package component :: Package bouncers :: Module bouncer :: Class Bouncer
[hide private]

Class Bouncer

source code

             object --+        
                      |        
common.common.InitMixin --+    
                          |    
extern.log.log.Loggable --+    
                          |    
    component.BaseComponent --+
                              |
                             Bouncer
Known Subclasses:

I am the base class for all bouncers.

Nested Classes [hide private]
child class of BaseComponentMedium componentMediumClass
the medium class to use for this component
Instance Methods [hide private]
 
init(self)
A subclass should do as little as possible in its init method.
source code
 
setDomain(self, name) source code
 
getDomain(self) source code
 
typeAllowed(self, keycard)
Verify if the keycard is an instance of a Keycard class specified in the bouncer's keycardClasses variable.
source code
 
setEnabled(self, enabled) source code
 
getEnabled(self) source code
 
do_stop(self)
BaseComponent vmethod for stopping.
source code
 
_expire(self) source code
 
authenticate(self, keycard) source code
 
do_authenticate(self, keycard)
Must be overridden by subclasses.
source code
 
hasKeycard(self, keycard) source code
 
generateKeycardId(self) source code
 
addKeycard(self, keycard) source code
 
removeKeycard(self, keycard) source code
 
removeKeycardId(self, keycardId) source code
 
keepAlive(self, issuerName, ttl) source code
 
expireAllKeycards(self) source code
 
expireKeycardId(self, keycardId) source code

Inherited from component.BaseComponent: __init__, addMessage, adminCallRemote, check_properties, do_check, do_setup, fixRenamedProperties, getMood, getName, getWorkerName, setMedium, setMood, setShutdownHook, setWorkerName, setup, setup_completed, stop, waitForHappy

Inherited from component.BaseComponent (private): _pollCPU, _pollMemory

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Inherited from extern.log.log.Loggable: __providedBy__, debug, doLog, error, info, log, logFunction, logObjectName, warning, warningFailure, writeMarker

Class Variables [hide private]
tuple of flumotion.common.keycards.Keycard class objects keycardClasses = ()
tuple of all classes of keycards this bouncer can authenticate, in order of preference
  logCategory = 'bouncer'
Implementors can provide a category to log their messages under.
  KEYCARD_EXPIRE_INTERVAL = 120

Inherited from extern.log.log.Loggable: __implemented__, __provides__

Instance Variables [hide private]

Inherited from component.BaseComponent: medium, name, uiState

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

init(self)

source code 

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: component.BaseComponent.init
(inherited documentation)

do_stop(self)

source code 

BaseComponent vmethod for stopping. The component should do any cleanup it needs, but must not set the component's mood to sleeping.

Returns:
twisted.internet.defer.Deferred
Overrides: component.BaseComponent.do_stop
(inherited documentation)

do_authenticate(self, keycard)

source code 

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.