BigBrotherBot v1.8.0
System Development Information for the BigBrotherBot project.

b3::lib::beaker::session::CookieSession Class Reference

Inheritance diagram for b3::lib::beaker::session::CookieSession:
b3::lib::beaker::session::Session

List of all members.

Public Member Functions

def __init__
def created
def id
def save
def expire
def delete
def invalidate

Public Attributes

 request
 key
 timeout
 cookie_expires
 encrypt_key
 validate_key
 secure
 cookie
 is_new
 accessed_dict

Properties

 created = property(created)
 id = property(id)
 domain = property(_get_domain, _set_domain)
 path = property(_get_path, _set_path)

Private Member Functions

def _set_domain
def _get_domain
def _set_path
def _get_path
def _encrypt_data
def _decrypt_data
def _make_id
def _create_cookie

Private Attributes

 _domain
 _path

Detailed Description

Pure cookie-based session

Options recognized when using cookie-based sessions are slightly
more restricted than general sessions.

``key``
    The name the cookie should be set to.
``timeout``
    How long session data is considered valid. This is used 
    regardless of the cookie being present or not to determine
    whether session data is still valid.
``encrypt_key``
    The key to use for the session encryption, if not provided the
    session will not be encrypted.
``validate_key``
    The key used to sign the encrypted session
``cookie_domain``
    Domain to use for the cookie.
``secure``
    Whether or not the cookie should only be sent over SSL.


Constructor & Destructor Documentation

def b3::lib::beaker::session::CookieSession::__init__ (   self,
  request,
  key = 'beaker.session.id',
  timeout = None,
  cookie_expires = True,
  cookie_domain = None,
  encrypt_key = None,
  validate_key = None,
  secure = False,
  kwargs 
)

Member Function Documentation

def b3::lib::beaker::session::CookieSession::_create_cookie (   self) [private]
def b3::lib::beaker::session::CookieSession::_decrypt_data (   self) [private]
Bas64, decipher, then un-serialize the data for the session
dict
def b3::lib::beaker::session::CookieSession::_encrypt_data (   self) [private]
Serialize, encipher, and base64 the session dict
def b3::lib::beaker::session::CookieSession::_get_domain (   self) [private]

Reimplemented from b3::lib::beaker::session::Session.

def b3::lib::beaker::session::CookieSession::_get_path (   self) [private]

Reimplemented from b3::lib::beaker::session::Session.

def b3::lib::beaker::session::CookieSession::_make_id (   self) [private]
def b3::lib::beaker::session::CookieSession::_set_domain (   self,
  domain 
) [private]

Reimplemented from b3::lib::beaker::session::Session.

def b3::lib::beaker::session::CookieSession::_set_path (   self,
  path 
) [private]

Reimplemented from b3::lib::beaker::session::Session.

def b3::lib::beaker::session::CookieSession::created (   self)

Reimplemented from b3::lib::beaker::session::Session.

def b3::lib::beaker::session::CookieSession::delete (   self)
Delete the cookie, and clear the session

Reimplemented from b3::lib::beaker::session::Session.

def b3::lib::beaker::session::CookieSession::expire (   self)
Delete the 'expires' attribute on this Session, if any.
def b3::lib::beaker::session::CookieSession::id (   self)
def b3::lib::beaker::session::CookieSession::invalidate (   self)
Clear the contents and start a new session

Reimplemented from b3::lib::beaker::session::Session.

def b3::lib::beaker::session::CookieSession::save (   self,
  accessed_only = False 
)
Saves the data for this session to persistent storage

Reimplemented from b3::lib::beaker::session::Session.


Member Data Documentation


Property Documentation

b3::lib::beaker::session::CookieSession::created = property(created) [static]

Reimplemented from b3::lib::beaker::session::Session.

b3::lib::beaker::session::CookieSession::domain = property(_get_domain, _set_domain) [static]

Reimplemented from b3::lib::beaker::session::Session.

b3::lib::beaker::session::CookieSession::id = property(id) [static]

Reimplemented from b3::lib::beaker::session::Session.

b3::lib::beaker::session::CookieSession::path = property(_get_path, _set_path) [static]

Reimplemented from b3::lib::beaker::session::Session.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Properties