Home | Trees | Indices | Help |
|
---|
|
object --+ | interface.OpenIDStore --+ | SQLStore
This is the parent class for the SQL stores, which contains the logic common to all of the SQL stores.
The table names used are determined by the class variables settings_table
, associations_table
, and nonces_table
. To change the name of the tables
used, pass new table names into the constructor.
To create the tables with the proper schema, see the createTables
method.
This class shouldn't be used directly. Use one of its subclasses instead, as those contain the code necessary to use a specific database.
All methods other than__init__
and createTables
should be considered implementation
details.
|
|||
__init__(self,
conn,
settings_table=None,
associations_table=None,
nonces_table=None) This creates a new SQLStore instance. |
|||
createTables(self,
*args,
**kwargs) This method creates the database tables necessary for this store to work. |
|||
blobDecode(self,
blob) Convert a blob as returned by the SQL engine into a str object. |
|||
blobEncode(self,
s) Convert a str object into the necessary object for storing in the database as a blob. |
|||
__getattr__(self, attr) | |||
txn_createTables(self) This method creates the database tables necessary for this store to work. |
|||
txn_storeAssociation(self,
server_url,
association) Set the association for the server URL. |
|||
NoneType
|
storeAssociation(self,
*args,
**kwargs) Set the association for the server URL. |
||
txn_getAssociation(self,
server_url,
handle=None) Get the most recent association that has been set for this server URL and handle. |
|||
Association or NoneType
|
getAssociation(self,
*args,
**kwargs) Get the most recent association that has been set for this server URL and handle. |
||
txn_removeAssociation(self,
server_url,
handle) Remove the association for the given server URL and handle, returning whether the association existed at all. |
|||
bool or int
|
removeAssociation(self,
*args,
**kwargs) Remove the association for the given server URL and handle, returning whether the association existed at all. |
||
txn_useNonce(self,
server_url,
timestamp,
salt) Return whether this nonce is present, and if it is, then remove it from the set. |
|||
bool
|
useNonce(self,
*args,
**kwargs) Return whether this nonce is present, and if it is, then remove it from the set. |
||
txn_cleanupNonces(self) | |||
int |
cleanupNonces(self,
*args,
**kwargs) Remove expired nonces from the store. |
||
txn_cleanupAssociations(self) | |||
int |
cleanupAssociations(self,
*args,
**kwargs) Remove expired associations from the store. |
||
Inherited from Inherited from |
|
|||
settings_table = 'oid_settings' This is the default name of the table to keep this store's settings in. |
|||
associations_table = 'oid_associations' This is the default name of the table to keep associations in |
|||
nonces_table = 'oid_nonces' This is the default name of the table to keep nonces in. |
|
|||
Inherited from |
|
This creates a new SQLStore instance. It requires an established database connection be given to it, and it allows overriding the default table names.
|
This method creates the database tables necessary for this store to work. It should not be called if the tables already exist. |
Convert a blob as returned by the SQL engine into a str object. str -> str |
Convert a str object into the necessary object for storing in the database as a blob. |
|
This method creates the database tables necessary for this store to work. It should not be called if the tables already exist. |
Set the association for the server URL. Association -> NoneType |
Set the association for the server URL. Association -> NoneType
|
Get the most recent association that has been set for this server URL and handle. str -> NoneType or Association |
Get the most recent association that has been set for this server URL and handle. str -> NoneType or Association
|
Remove the association for the given server URL and handle, returning whether the association existed at all. (str, str) -> bool |
Remove the association for the given server URL and handle, returning whether the association existed at all. (str, str) -> bool
|
Return whether this nonce is present, and if it is, then remove it from the set. str -> bool |
Return whether this nonce is present, and if it is, then remove it from the set. str -> bool
|
|
Remove expired nonces from the store. Discards any nonce from storage that is old enough that its timestamp would not pass useNonce. This method is not called in the normal operation of the library. It provides a way for store admins to keep their storage from filling up with expired data.
|
|
Remove expired associations from the store. This method is not called in the normal operation of the library. It provides a way for store admins to keep their storage from filling up with expired data.
|
|
settings_tableThis is the default name of the table to keep this store's settings in.
|
associations_tableThis is the default name of the table to keep associations in
|
nonces_tableThis is the default name of the table to keep nonces in.
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0alpha3 on Fri Jun 22 21:41:46 2007 | http://epydoc.sourceforge.net |