Package flumotion :: Package component :: Package bouncers :: Module ipbouncer :: Class IPBouncer

Class IPBouncer

             object --+            
                      |            
common.common.InitMixin --+        
                          |        
extern.log.log.Loggable --+        
                          |        
    component.BaseComponent --+    
                              |    
                bouncer.Bouncer --+
                                  |
                                 IPBouncer

Nested Classes

[hide private]

Inherited from bouncer.Bouncer: componentMediumClass

Instance Methods

[hide private]

do_setup(self)
Subclasses can implement me to set up the component before it is started.

source code

do_authenticate(self, keycard)
Must be overridden by subclasses.

source code

Inherited from bouncer.Bouncer: addKeycard, authenticate, do_expireKeycards, do_stop, do_validate, expireAllKeycards, expireKeycardId, expireKeycardIds, generateKeycardId, getDomain, getEnabled, hasKeycard, init, keepAlive, on_disabled, on_enabled, on_keycardAdded, on_keycardRemoved, removeKeycard, removeKeycardId, setDomain, setEnabled, typeAllowed

Inherited from bouncer.Bouncer (private): _addKeycard, _expire, _expireNextKeycardBlock

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

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

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

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

Class Variables

[hide private]

logCategory = 'ip-bouncer'
Implementors can provide a category to log their messages under.

tuple of flumotion.common.keycards.Keycard class objects keycardClasses = keycards.KeycardUACPCC, keycards.KeycardUACPP
tuple of all classes of keycards this bouncer can authenticate, in order of preference

Inherited from bouncer.Bouncer: KEYCARD_EXPIRE_INTERVAL

Instance Variables

[hide private]

Inherited from component.BaseComponent: medium, name, uiState

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

do_setup(self)

source code

Subclasses can implement me to set up the component before it is started. It should set up the component, possibly opening files and resources. Non-programming errors should not be raised, but returned as a failing deferred.

The return value may be a deferred.

Overrides: component.BaseComponent.do_setup: (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 REFUSED to deny the keycard or a deferred which should have the same eventual value.

FIXME: Currently, a return value of 'None' is treated as rejecting the keycard. This is unintuitive.

FIXME: in fact, for authentication sessions like challenge/response, returning a keycard with state REFUSED instead of None will not work properly and may enter in an asynchronous infinit loop.

Overrides: bouncer.Bouncer.do_authenticate: (inherited documentation)