Package flumotion :: Package component :: Package base :: Module http :: Class HTTPAuthentication
[show private | hide private]
[frames | no frames]

Class HTTPAuthentication

Loggable --+
           |
          HTTPAuthentication


Mixin for handling HTTP authentication for twisted.web Resources, using issuers and bouncers.
Method Summary
  __init__(self, component)
  authenticate(self, request)
Returns: a deferred returning a keycard or None
  authenticateKeycard(self, bouncerName, keycard)
  cleanupAuth(self, fd)
  cleanupKeycard(self, bouncerName, keycard)
  clientDone(self, fd)
  expireKeycard(self, keycardId)
Expire a client's connection associated with the keycard Id.
  setBouncerName(self, bouncerName)
  setDefaultDuration(self, defaultDuration)
  setDomain(self, domain)
Set a domain name on the resource, used in HTTP auth challenges and on the keycard.
  setIssuerClass(self, issuerClass)
  setRequesterId(self, requesterId)
  startAuthentication(self, request)
    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
int __reserve_fds__ = 50                                                                    
str logCategory: Implementors can provide a category to log their messages under.
    Inherited from Loggable
Implements __implemented__ = <implementedBy flumotion.common.log.Lo...
ClassProvides __providedBy__ = <zope.interface.declarations.ClassProvi...
ClassProvides __provides__ = <zope.interface.declarations.ClassProvide...

Method Details

authenticate(self, request)

Returns: a deferred returning a keycard or None

expireKeycard(self, keycardId)

Expire a client's connection associated with the keycard Id.

setDomain(self, domain)

Set a domain name on the resource, used in HTTP auth challenges and on the keycard.
Parameters:
domain
           (type=string)

Class Variable Details

__reserve_fds__

Type:
int
Value:
50                                                                    

logCategory

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

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