Package flumotion :: Package common :: Module keycards :: Class Keycard

Class Keycard

 twisted.spread.jelly.Jellyable --+        
                                  |        
twisted.spread.flavors.Serializable --+    
                                      |    
        twisted.spread.flavors.Copyable --+
                                          |
   twisted.spread.jelly.Unjellyable --+   |
                                      |   |
      twisted.spread.flavors.RemoteCopy --+
                                          |
                                         Keycard

Known Subclasses:

I am the base class for keycards which together with credentials are a serializable object used in authentication inside Flumotion.

Instance Methods

[hide private]

__init__(self)

source code

getData(self)
Return a dictionary of the viewable data on the keycard that can be used to identify the keycard.

source code

__repr__(self)

source code

__provides__(...)
Special descriptor for class __provides__

Inherited from twisted.spread.flavors.Copyable: getStateToCopy, getStateToCopyFor, getTypeToCopy, getTypeToCopyFor, jellyFor

Inherited from twisted.spread.flavors.Serializable: processUniqueID

Inherited from twisted.spread.jelly.Jellyable: __providedBy__, getStateFor

Inherited from twisted.spread.flavors.RemoteCopy: setCopyableState, unjellyFor

Inherited from twisted.spread.jelly.Unjellyable: setStateFor

Class Variables

[hide private]

token = ''

__implemented__ = <implementedBy flumotion.common.keycards.Key...

Instance Variables

[hide private]

str address = None
IP address of requester (optional)

str username = None
username of requester (optional)

str password = None
password of requester (optional)

str path = None
path of request (optional)

dict of str->str arguments = {}
arguments passed with request (optional)

str avatarId
avatarId preferred by requester

str bouncerName
name of the bouncer to authenticate against; set by requester

str domain
requester can pass a domain id to the bouncer

int duration
duration for which the keycard is valid, or 0 for unlimited

object id
id of keycard decided by bouncer after authenticating

str requesterId
avatarId of the requester

int state
state the keycard is in

Method Details

[hide private]

getData(self)

source code

Return a dictionary of the viewable data on the keycard that can be used to identify the keycard. It doesn't include sensitive information though.

Subclasses should override to add additional information.

provides(...)

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that
we can get declarations for objects without instance-specific
interfaces a bit quicker.

For example:

  >>> from zope.interface import Interface
  >>> class IFooFactory(Interface):
  ...     pass
  >>> class IFoo(Interface):
  ...     pass
  >>> class C(object):
  ...     implements(IFoo)
  ...     classProvides(IFooFactory)
  >>> [i.getName() for i in C.__provides__]
  ['IFooFactory']

  >>> [i.getName() for i in C().__provides__]
  ['IFoo']

Overrides: twisted.spread.jelly.Unjellyable.__provides__

Class Variable Details

[hide private]

implemented

Value:

<implementedBy flumotion.common.keycards.Keycard>