XSECCryptoException Class Reference
[Cryptographic Abstraction Layer]

#include <XSECCryptoException.hpp>

List of all members.

---

Detailed Description

Exception class used by the cryptographic modules.

This exception class should be used by the Cryptographic providers for reporting errors. It can be used directly or by classes which inherit from it.

It's a fairly standard exception class, with a type parameter (and associated enumerated type) and a string that can be used to provide more information to the caller.

Public Types
enum	XSECCryptoExceptionType {   None = 0,   GeneralError = 1,   MDError = 2,   Base64Error = 3,   MemoryError = 4,   X509Error = 5,   DSAError = 6,   RSAError = 7,   SymmetricError = 8,   UnsupportedError = 9,   UnsupportedAlgorithm = 10,   UnknownError = 11 }
	Defines the error type. More...
Public Member Functions
XSECCryptoExceptionType	getType (void)
	Get the error type.
Contructors and Destructors
	XSECCryptoException (XSECCryptoExceptionType eNum, const char *inMsg=NULL)
	Common constructur.
	XSECCryptoException (XSECCryptoExceptionType eNum, safeBuffer &inMsg)
	safeBuffer constructor
	XSECCryptoException (const XSECCryptoException &toCopy)
	Copy Constructor.
	~XSECCryptoException ()
Get Methods
const char *	getMsg (void)
	Get the message.

---

Member Enumeration Documentation

enum XSECCryptoException::XSECCryptoExceptionType

Defines the error type. Enumerated type that can be looked up by the receiver of the exception to determine what the error was. Can also be used as a lookup into the XSECCryptoExceptionStrings global array for a default error description Enumeration values: None  GeneralError  MDError  Base64Error  MemoryError  X509Error  DSAError  RSAError  SymmetricError  UnsupportedError  UnsupportedAlgorithm  UnknownError

---

Constructor & Destructor Documentation

XSECCryptoException::XSECCryptoException (  XSECCryptoExceptionType  eNum, const char *  inMsg = NULL )

Common constructur. Construct an exception with the given type and (possibly blank) message. Parameters: eNum  The error type inMsg  The message to be passed to the caller. If NULL this will be set to the associated value in XSECCryptoExceptionStrings

XSECCryptoException::XSECCryptoException (  XSECCryptoExceptionType  eNum, safeBuffer &  inMsg )

safeBuffer constructor As for the common constructor, but passes in a safeBuffer message Parameters: eNum  The error type inMsg  The message string to be passed to the caller.

XSECCryptoException::XSECCryptoException (  const XSECCryptoException &  toCopy  )

Copy Constructor. Parameters: toCopy  The exception to be copied into the new exception

XSECCryptoException::~XSECCryptoException (   )

---

Member Function Documentation

const char* XSECCryptoException::getMsg (  void   )

Get the message. Allows the receiver of the exception to get the error message. Returns: A pointer to the char buffer holding the error string

XSECCryptoExceptionType XSECCryptoException::getType (  void   )

Get the error type. Returns: The error type of the error that caused the exception

---

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

• XSECCryptoException.hpp

---