XSECException Class Reference
[Main Signature API]

#include <XSECException.hpp>

List of all members.

---

Detailed Description

Exception Class.

This class is used for all Exceptions raised by the XSEC library. It holds a "type" number that can be used to find the generic type of the exception, as well as a XMLCh string that holds a description of the error

Information functions
const XMLCh *	getMsg (void)
	Get message.
XSECExceptionType	getType (void)
	Get error type.
Public Types
enum	XSECExceptionType {   None = 0,   MemoryAllocationFail = 1,   NoHashFoundInDigestValue = 2,   UnknownDSIGAttribute = 3,   ExpectedDSIGChildNotFound = 4,   UnknownTransform = 5,   TransformInputOutputFail = 6,   IDNotFoundInDOMDoc = 7,   UnsupportedXpointerExpr = 8,   XPathError = 9,   XSLError = 10,   Unsupported = 11,   LoadEmptySignature = 12,   LoadNonSignature = 13,   UnknownCanonicalization = 14,   UnknownSignatureAlgorithm = 15,   LoadEmptyX509 = 16,   LoadNonX509 = 17,   OpenSSLError = 18,   SigVfyError = 19,   LoadEmptySignedInfo = 20,   LoadNonSignedInfo = 21,   ExpectedReferenceURI = 22,   NotLoaded = 23,   CryptoProviderError = 24,   KeyInfoError = 25,   SigningError = 26,   LoadEmptyInfoName = 27,   LoadNonInfoName = 28,   UnknownKeyValue = 29,   SignatureCreationError = 30,   ErrorOpeningURI = 31,   ProviderError = 32,   InternalError = 33,   EnvelopeError = 34,   UnsupportedFunction = 35,   TransformError = 36,   SafeBufferError = 37,   HTTPURIInputStreamError = 38,   LoadEmptyXPathFilter = 39,   XPathFilterError = 40,   DNameDecodeError = 41,   EncryptedTypeError = 42,   ExpectedXENCChildNotFound = 43,   CipherDataError = 44,   CipherValueError = 45,   CipherError = 46,   AlgorithmMapperError = 47,   EncryptionMethodError = 48,   CipherReferenceError = 49,   ObjectError = 50,   XKMSError = 51,   ExpectedXKMSChildNotFound = 52,   MessageAbstractTypeError = 53,   RequestAbstractTypeError = 54,   ResultTypeError = 55,   StatusError = 56,   UnknownError = 58 }
	Type of Exception thrown. More...
Public Member Functions
Constructors and Destructors
	XSECException (XSECExceptionType eNum, const XMLCh *inMsg=NULL)
	General Constructor.
	XSECException (XSECExceptionType eNum, const char *inMsg)
	Local code page constructor.
	XSECException (const XSECException &toCopy)
	Copy Constructor.
	~XSECException ()
	Destructor.

---

Member Enumeration Documentation

enum XSECException::XSECExceptionType

Type of Exception thrown. This enumerated type is used to inform the recipient of the exception what generic error caused it to be raised. Enumeration values: None  MemoryAllocationFail  NoHashFoundInDigestValue  UnknownDSIGAttribute  ExpectedDSIGChildNotFound  UnknownTransform  TransformInputOutputFail  IDNotFoundInDOMDoc  UnsupportedXpointerExpr  XPathError  XSLError  Unsupported  LoadEmptySignature  LoadNonSignature  UnknownCanonicalization  UnknownSignatureAlgorithm  LoadEmptyX509  LoadNonX509  OpenSSLError  SigVfyError  LoadEmptySignedInfo  LoadNonSignedInfo  ExpectedReferenceURI  NotLoaded  CryptoProviderError  KeyInfoError  SigningError  LoadEmptyInfoName  LoadNonInfoName  UnknownKeyValue  SignatureCreationError  ErrorOpeningURI  ProviderError  InternalError  EnvelopeError  UnsupportedFunction  TransformError  SafeBufferError  HTTPURIInputStreamError  LoadEmptyXPathFilter  XPathFilterError  DNameDecodeError  EncryptedTypeError  ExpectedXENCChildNotFound  CipherDataError  CipherValueError  CipherError  AlgorithmMapperError  EncryptionMethodError  CipherReferenceError  ObjectError  XKMSError  ExpectedXKMSChildNotFound  MessageAbstractTypeError  RequestAbstractTypeError  ResultTypeError  StatusError  UnknownError

---

Constructor & Destructor Documentation

XSECException::XSECException (  XSECExceptionType  eNum, const XMLCh *  inMsg = NULL )

General Constructor. Generic constructor used within the library. Where inMsg == NULL, the general string for this exception type will be used. Parameters: eNum  Exception type inMsg  Msg to be used or NULL for general system message

XSECException::XSECException (  XSECExceptionType  eNum, const char *  inMsg )

Local code page constructor. Shortcut constructor to allow local code page strings to be used for the message. Strings are converted to UTF-16. Parameters: eNum  Exception type inMsg  Msg to be used or NULL for general system message

XSECException::XSECException (  const XSECException &  toCopy  )

Copy Constructor.

XSECException::~XSECException (   )

Destructor.

---

Member Function Documentation

const XMLCh* XSECException::getMsg (  void   )

Get message. Return a pointer to the XMLCh buffer holding the error message Returns: A pointer to the buffer within the exception that holds the error message

XSECExceptionType XSECException::getType (  void   )

Get error type. Returns an XSECExceptionType coding of the generic error that raised this exception Returns: The excetpion type

---

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

• XSECException.hpp

---