Bad input error, thrown when the input to an SDK API is invalid. More...

#include <src/api/mip/error.h>

Inheritance diagram for BadInputError:

[legend]

Collaboration diagram for BadInputError:

[legend]

Public Types
enum class	ErrorCode { General = 0 , FileIsTooLargeForProtection = 1 , ParameterParsing = 2 , LicenseNotTrusted = 3 , DoubleKey = 4 , FileFormatNotSupported = 5 }
	ErrorCode of bad input error. More...

Public Member Functions
void	AddDebugInfo (const std::string &key, const std::string &value, bool sensitive=false)
	Add debug info entry.

virtual std::shared_ptr< Error >	Clone () const =0
	Clone the error.

const std::map< std::string, std::string > &	GetDebugInfo () const
	Get debug info.

ErrorCode	GetErrorCode () const
	Gets the errorCode of bad input.

const std::string &	GetErrorName () const
	Get the error name.

virtual ErrorType	GetErrorType () const
	Get the error type.

const std::string &	GetMessage (bool maskPII=false) const
	Get the error message.

void	SetMessage (const std::string &msg)
	Set the error message.

char const *	what () const noexcept override
	Get the error message.

Public Attributes
std::map< std::string, std::string >	mDebugInfo

std::string	mMessage

std::string	mName

ErrorType	mType

Private Member Functions
std::string	CreateFormattedMessage (const std::string &message) const

const std::string &	GetErrorCodeString (ErrorCode code) const

Private Attributes
ErrorCode	mErrorCode

std::string	mFormattedMessage

std::string	mMaskedMessage

Detailed Description

Bad input error, thrown when the input to an SDK API is invalid.

Definition at line 247 of file error.h.

Member Enumeration Documentation

◆ ErrorCode

enum class BadInputError::ErrorCode

strong

ErrorCode of bad input error.

Enumerator
General	General bad input error
FileIsTooLargeForProtection	File is too large for protection
ParameterParsing	Parameter cannot be parsed correctly
LicenseNotTrusted	Publishing license not issued by trusted source
DoubleKey	A paremeter for double key encryption is needed and missing
FileFormatNotSupported	The input file's format is not supported

Definition at line 253 of file error.h.

                       {
    General = 0, /**< General bad input error */
    FileIsTooLargeForProtection = 1, /**< File is too large for protection */
    ParameterParsing = 2, /**< Parameter cannot be parsed correctly */
    LicenseNotTrusted = 3, /**< Publishing license not issued by trusted source */
    DoubleKey = 4, /**< A paremeter for double key encryption is needed and missing */
    FileFormatNotSupported = 5, /**<The input file's format is not supported */
  };

Member Function Documentation

◆ AddDebugInfo()

void Error::AddDebugInfo	(	const std::string &	key,
		const std::string &	value,
		bool	sensitive = false )

inlineinherited

Add debug info entry.

Parameters

key	Debug info key
value	Debug info value

Definition at line 179 of file error.h.

                                                                                          {
    if (!key.empty() && !value.empty()) {
      mDebugInfo[key] = value;
      mFormattedMessage = mFormattedMessage + ", " + key + "=" + value;
      mMaskedMessage = mMaskedMessage + ", " + key + "=" + (sensitive ? "***" : value);
    }
  }

References Error::mDebugInfo, Error::mFormattedMessage, and Error::mMaskedMessage.

Referenced by NoPermissionsExtendedError::AddExtendedErrorInfoToDebugInfo(), DelegateResponseError::DelegateResponseError(), DelegateResponseError::DelegateResponseError(), and DelegateResponseError::DelegateResponseError().

◆ Clone()

virtual std::shared_ptr< Error > Error::Clone ( ) const

pure virtualinherited

Clone the error.

Returns: a clone of the error.

Implemented in JustificationRequiredError.

◆ CreateFormattedMessage()

std::string Error::CreateFormattedMessage ( const std::string & message ) const

inlineprivateinherited

Definition at line 230 of file error.h.

                                                                   {
    auto formattedMessage = message;
 
    // Remove stray newlines
    auto isNewlineFn = [](char c) { return c == '\n' || c == '\r'; };
    formattedMessage.erase(std::remove_if(formattedMessage.begin(), formattedMessage.end(), isNewlineFn), formattedMessage.end());
 
    return formattedMessage;
  }

◆ GetDebugInfo()

const std::map< std::string, std::string > & Error::GetDebugInfo ( ) const

inlineinherited

Get debug info.

Returns: Debug info (keys/values)

Definition at line 192 of file error.h.

192{ return mDebugInfo; }

References Error::mDebugInfo.

◆ GetErrorCode()

ErrorCode BadInputError::GetErrorCode ( ) const

inline

Gets the errorCode of bad input.

Returns: ErrorCode of bad input error

Definition at line 293 of file error.h.

293{ return mErrorCode; }

BadInputError::mErrorCode

ErrorCode mErrorCode

Definition error.h:296

References mErrorCode.

◆ GetErrorCodeString()

const std::string & BadInputError::GetErrorCodeString ( ErrorCode code ) const

inlineprivate

Definition at line 298 of file error.h.

                                                            {
    static const std::string kUnrecognized = "UNRECOGNIZED";
    static const std::map<ErrorCode, std::string> kCodes = {
        { ErrorCode::General,                       "General" },
        { ErrorCode::FileIsTooLargeForProtection,   "FileIsTooLargeForProtection" },
        { ErrorCode::ParameterParsing,              "ParameterParsing" },
        { ErrorCode::LicenseNotTrusted,             "LicenseNotTrusted" },
        { ErrorCode::DoubleKey,                     "DoubleKey" },
        { ErrorCode::FileFormatNotSupported,        "FileFormatNotSupported"},
    };
    return kCodes.count(code) ? kCodes.at(code) : kUnrecognized;
  }

References DoubleKey, FileFormatNotSupported, FileIsTooLargeForProtection, General, LicenseNotTrusted, and ParameterParsing.

◆ GetErrorName()

const std::string & Error::GetErrorName ( ) const

inlineinherited

Get the error name.

Returns: the error name.

Definition at line 144 of file error.h.

144{ return mName; }

Error::mName

std::string mName

Definition error.h:226

References Error::mName.

◆ GetErrorType()

virtual ErrorType Error::GetErrorType ( ) const

inlinevirtualinherited

Get the error type.

Returns: the error type.

Definition at line 137 of file error.h.

137{ return mType; }

Error::mType

ErrorType mType

Definition error.h:227

References Error::mType.

◆ GetMessage()

const std::string & Error::GetMessage ( bool maskPII = false ) const

inlineinherited

Get the error message.

Returns: the error message.

Definition at line 151 of file error.h.

                                                          {
    return maskPII ? mMaskedMessage : mFormattedMessage;
  }

References Error::mFormattedMessage, and Error::mMaskedMessage.

◆ SetMessage()

void Error::SetMessage ( const std::string & msg )

inlineinherited

Set the error message.

Parameters

msg	the error message.

Definition at line 160 of file error.h.

                                        {
    std::string* targetStrings[] = { &mFormattedMessage, &mMaskedMessage };
    for (auto* targetString : targetStrings) {
      size_t pos = targetString->find(mMessage);
      if (pos != std::string::npos) {
        targetString->replace(pos, mMessage.length(), msg);
      } else {
        targetString->replace(0, 0, msg);
      }
    }
    mMessage = msg;
  }

References Error::mFormattedMessage, Error::mMaskedMessage, and Error::mMessage.

◆ what()

char const * Error::what ( ) const

inlineoverridenoexceptinherited

Get the error message.

Returns: the error message

Definition at line 121 of file error.h.

                                             {
    return mFormattedMessage.c_str();
  }

References Error::mFormattedMessage.

Member Data Documentation

◆ mDebugInfo

std::map<std::string, std::string> Error::mDebugInfo

inherited

Definition at line 225 of file error.h.

Referenced by Error::AddDebugInfo(), and Error::GetDebugInfo().

◆ mErrorCode

ErrorCode BadInputError::mErrorCode

private

Definition at line 296 of file error.h.

Referenced by GetErrorCode().

◆ mFormattedMessage

std::string Error::mFormattedMessage

privateinherited

Definition at line 240 of file error.h.

Referenced by Error::AddDebugInfo(), Error::GetMessage(), Error::SetMessage(), and Error::what().

◆ mMaskedMessage

std::string Error::mMaskedMessage

privateinherited

Definition at line 241 of file error.h.

Referenced by Error::AddDebugInfo(), Error::GetMessage(), and Error::SetMessage().

◆ mMessage

std::string Error::mMessage

inherited

Definition at line 224 of file error.h.

Referenced by DelegateResponseError::DelegateResponseError(), and Error::SetMessage().

◆ mName

std::string Error::mName

inherited

Definition at line 226 of file error.h.

Referenced by Error::GetErrorName().

◆ mType

ErrorType Error::mType

inherited

Definition at line 227 of file error.h.

Referenced by Error::GetErrorType().

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

src/api/mip/error.h

Public Types

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ ErrorCode

Member Function Documentation

◆ AddDebugInfo()

◆ Clone()

◆ CreateFormattedMessage()

◆ GetDebugInfo()

◆ GetErrorCode()

◆ GetErrorCodeString()

◆ GetErrorName()

◆ GetErrorType()

◆ GetMessage()

◆ SetMessage()

◆ what()

Member Data Documentation

◆ mDebugInfo

◆ mErrorCode

◆ mFormattedMessage

◆ mMaskedMessage

◆ mMessage

◆ mName

◆ mType