util/XmlBlasterException.h

Go to the documentation of this file.

/*------------------------------------------------------------------------------
Name:      XmlBlasterException.h
Project:   xmlBlaster.org
Copyright: xmlBlaster.org, see xmlBlaster-LICENSE file
Comment:   Basic xmlBlaster exception.
------------------------------------------------------------------------------*/

#ifndef _UTIL_XMLBLASTER_EXCEPTION_H
#define _UTIL_XMLBLASTER_EXCEPTION_H

#include <string>
// #include <util/Timestamp.h>
#include <util/ErrorCode.h>
#include <stdexcept>

namespace org { namespace xmlBlaster { namespace util {

class Dll_Export XmlBlasterException : public std::exception
{
   private:
      const std::string errorCodeStr_;
      const std::string node_;
      std::string location_;
      const std::string lang_;
      const std::string message_;
      const std::string versionInfo_;
      mutable std::string timestamp_;
      std::string stackTrace_;
      std::string embeddedMessage_;
      const std::string transactionInfo_;
      mutable std::string str_; // for what(), holds memory for const char * return

   public:

   XmlBlasterException(const std::string &errorCodeStr,
                       const std::string &node,
                       const std::string &location,
                       const std::string &lang="en",
                       const std::string &message="",
                       const std::string &versionInfo="@version@",  // is replaced by ant / build.xml to e.g. "0.85c", see org::xmlBlaster::util::Global.getVersion(),
//                       org::xmlBlaster::util::Timestamp timestamp=0,
                       const std::string &timestampStr="",
                       const std::string &stackTrace="",
                       const std::string &embeddedMessage="",
                       const std::string &transactionInfo="<transactioninfo/>");

   XmlBlasterException(const ErrorCode &errorCode,
                       const std::string &node,
                       const std::string &location,
                       const std::string &lang,
                       const std::string &versionInfo="@version@",  // is replaced by ant / build.xml to e.g. "0.85c", see org::xmlBlaster::util::Global.getVersion(),
//                       org::xmlBlaster::util::Timestamp timestamp=0,
                       const std::string &timestampStr="",
                       const std::string &stackTrace="",
                       const std::string &embeddedMessage="",
                       const std::string &transactionInfo="<transactioninfo/>");

   XmlBlasterException(const ErrorCode &errorCode,
                       const std::string &node,
                       const std::string &embeddedMessage);

   virtual ~XmlBlasterException() throw();

   std::string getErrorCodeStr() const;
   std::string getNode() const;
   void setLocation(const std::string& location) { this->location_ = location; }
   std::string getLocation() const;
   std::string getLang() const;
   std::string getMessage() const;

   std::string getRawMessage() const;

   std::string getVersionInfo() const;

   std::string getTimestamp() const;

   std::string getStackTraceStr() const;

   std::string getEmbeddedMessage() const;

   std::string getTransactionInfo() const;

   bool isInternal() const;

   bool isResource() const;

   bool isCommunication() const;

   bool isUser() const;

   bool isTransaction() const;

   const char *what() const throw();

   std::string toString() const;

   static XmlBlasterException parseFromString(std::string fromString);

   std::string toXml() const;

   static std::string getStackTrace(int maxNumOfLines=20);

};

}}} // namespaces

#endif