xmltooling::CredentialCriteria Class Reference

Class for specifying criteria by which a CredentialResolver should resolve credentials. More...

#include <xmltooling/security/CredentialCriteria.h>

List of all members.

Public Types

enum  keyinfo_extraction_t { KEYINFO_EXTRACTION_KEY = 1, KEYINFO_EXTRACTION_KEYNAMES = 2 }
 Bitmask constants controlling the kinds of criteria set automatically based on a KeyInfo object.

Public Member Functions

 CredentialCriteria ()
 Default constructor.
virtual bool matches (const Credential &credential) const
 Determines whether the supplied Credential matches this CredentialCriteria.
unsigned int getUsage () const
 Get key usage criteria.
void setUsage (unsigned int usage)
 Set key usage criteria.
const char * getPeerName () const
 Get the peer name criteria.
void setPeerName (const char *peerName)
 Set the peer name criteria.
const char * getKeyAlgorithm () const
 Get the key algorithm criteria.
void setKeyAlgorithm (const char *keyAlgorithm)
 Set the key algorithm criteria.
unsigned int getKeySize () const
 Get the key size criteria.
void setKeySize (unsigned int keySize)
 Set the key size criteria.
unsigned int getMaxKeySize () const
 Get the maximum key size criteria.
void setMaxKeySize (unsigned int keySize)
 Set the maximum key size criteria.
void setXMLAlgorithm (const XMLCh *algorithm)
 Set the key algorithm and size criteria based on an XML algorithm specifier.
const std::set< std::string > & getKeyNames () const
 Gets key name criteria.
std::set< std::string > & getKeyNames ()
 Gets key name criteria.
virtual XSECCryptoKey * getPublicKey () const
 Returns the public key criteria.
void setPublicKey (XSECCryptoKey *key)
 Sets the public key criteria.
const xmlsignature::KeyInfogetKeyInfo () const
 Gets the KeyInfo criteria.
virtual void setKeyInfo (const xmlsignature::KeyInfo *keyInfo, int extraction=0)
 Sets the KeyInfo criteria.
DSIGKeyInfoList * getNativeKeyInfo () const
 Gets the native KeyInfo criteria.
virtual void setNativeKeyInfo (DSIGKeyInfoList *keyInfo, int extraction=0)
 Sets the KeyInfo criteria.
void setSignature (const xmlsignature::Signature &sig, int extraction=0)
 Sets the KeyInfo criteria from an XML Signature.
virtual void reset ()
 Resets object to a default state.


Detailed Description

Class for specifying criteria by which a CredentialResolver should resolve credentials.

Constructor & Destructor Documentation

xmltooling::CredentialCriteria::CredentialCriteria (  ) 

Default constructor.


Member Function Documentation

virtual bool xmltooling::CredentialCriteria::matches ( const Credential credential  )  const [virtual]

Determines whether the supplied Credential matches this CredentialCriteria.

Parameters:
credential the Credential to evaluate
Returns:
true iff the Credential is consistent with this criteria

unsigned int xmltooling::CredentialCriteria::getUsage (  )  const

Get key usage criteria.

Returns:
the usage mask

void xmltooling::CredentialCriteria::setUsage ( unsigned int  usage  ) 

Set key usage criteria.

Parameters:
usage the usage mask to set

const char* xmltooling::CredentialCriteria::getPeerName (  )  const

Get the peer name criteria.

Returns:
the peer name

void xmltooling::CredentialCriteria::setPeerName ( const char *  peerName  ) 

Set the peer name criteria.

Parameters:
peerName peer name to set

const char* xmltooling::CredentialCriteria::getKeyAlgorithm (  )  const

Get the key algorithm criteria.

Returns:
the key algorithm

void xmltooling::CredentialCriteria::setKeyAlgorithm ( const char *  keyAlgorithm  ) 

Set the key algorithm criteria.

Parameters:
keyAlgorithm the key algorithm to set

unsigned int xmltooling::CredentialCriteria::getKeySize (  )  const

Get the key size criteria.

If a a maximum size is also set, this is treated as a minimum.

Returns:
the key size, or 0

void xmltooling::CredentialCriteria::setKeySize ( unsigned int  keySize  ) 

Set the key size criteria.

If a a maximum size is also set, this is treated as a minimum.

Parameters:
keySize key size to set

unsigned int xmltooling::CredentialCriteria::getMaxKeySize (  )  const

Get the maximum key size criteria.

Returns:
the maximum key size, or 0

void xmltooling::CredentialCriteria::setMaxKeySize ( unsigned int  keySize  ) 

Set the maximum key size criteria.

Parameters:
keySize maximum key size to set

void xmltooling::CredentialCriteria::setXMLAlgorithm ( const XMLCh *  algorithm  ) 

Set the key algorithm and size criteria based on an XML algorithm specifier.

Parameters:
algorithm XML algorithm specifier

const std::set<std::string>& xmltooling::CredentialCriteria::getKeyNames (  )  const

Gets key name criteria.

Returns:
an immutable set of key names

std::set<std::string>& xmltooling::CredentialCriteria::getKeyNames (  ) 

Gets key name criteria.

Returns:
a mutable set of key names

virtual XSECCryptoKey* xmltooling::CredentialCriteria::getPublicKey (  )  const [virtual]

Returns the public key criteria.

Returns:
a public key

void xmltooling::CredentialCriteria::setPublicKey ( XSECCryptoKey *  key  ) 

Sets the public key criteria.

The lifetime of the key MUST extend for the lifetime of this object.

Parameters:
key a public key

const xmlsignature::KeyInfo* xmltooling::CredentialCriteria::getKeyInfo (  )  const

Gets the KeyInfo criteria.

Returns:
the KeyInfo criteria

virtual void xmltooling::CredentialCriteria::setKeyInfo ( const xmlsignature::KeyInfo keyInfo,
int  extraction = 0 
) [virtual]

Sets the KeyInfo criteria.

Parameters:
keyInfo the KeyInfo criteria
extraction bitmask of criteria to auto-extract from KeyInfo

DSIGKeyInfoList* xmltooling::CredentialCriteria::getNativeKeyInfo (  )  const

Gets the native KeyInfo criteria.

Returns:
the native KeyInfo criteria

virtual void xmltooling::CredentialCriteria::setNativeKeyInfo ( DSIGKeyInfoList *  keyInfo,
int  extraction = 0 
) [virtual]

Sets the KeyInfo criteria.

Parameters:
keyInfo the KeyInfo criteria
extraction bitmask of criteria to auto-extract from KeyInfo

void xmltooling::CredentialCriteria::setSignature ( const xmlsignature::Signature sig,
int  extraction = 0 
)

Sets the KeyInfo criteria from an XML Signature.

Parameters:
sig the Signature containing KeyInfo criteria
extraction bitmask of criteria to auto-extract from KeyInfo


The documentation for this class was generated from the following file:

Generated on Tue Jul 21 02:08:56 2015 for xmltooling by  doxygen 1.5.6