Module xmlsec :: Class KeyReq
[frames | no frames]

Class KeyReq


Method Summary
  __init__(self, keyId, keyType, keyUsage, keyBitsSize, _obj)
Creates new key requirements information.
  __getattr__(self, name)
  __setattr__(self, name, value)
  copy(self, dst)
Copies key requirements to dst object.
  finalize(self)
Cleans the key requirements object.
  getKeyBitsSize(self)
Gets keyBitsSize member...
  initialize(self)
Initialize key requirements object.
  matchKey(self, key)
Checks whether key matches key requirements.
  matchKeyValue(self, value)
Checks whether keyValue matches key requirements keyReq.
  reset(self)
Resets key requirements object for new key search.

Method Details

__init__(self, keyId=None, keyType=None, keyUsage=None, keyBitsSize=None, _obj=None)
(Constructor)

Creates new key requirements information.
keyId       : the desired key value klass.
keyType     : the desired key type.
keyUsage    : the desired key usage.
keyBitsSize : the desired key size (in bits!).
Returns     : the newly key requirements information or None if an error
occurs.

copy(self, dst)

Copies key requirements to dst object.
dst     : the destination object.
Returns : 0 on success and a negative value if an error occurs.

finalize(self)

Cleans the key requirements object.

getKeyBitsSize(self)

Gets keyBitsSize member

initialize(self)

Initialize key requirements object. Caller is responsible for cleaning
it with finalize method.
Returns : 0 on success or a negative value if an error occurs.

matchKey(self, key)

Checks whether key matches key requirements.
key     : the key.
Returns : 1 if key matches requirements, 0 if not and a negative value
if an error occurs.

matchKeyValue(self, value)

Checks whether keyValue matches key requirements keyReq.
value   : the key value.
Returns : 1 if key value matches requirements, 0 if not and a negative
value if an error occurs.

reset(self)

Resets key requirements object for new key search.

Generated by Epydoc 2.0 on Mon Feb 9 01:09:34 2004 http://epydoc.sf.net