The user could not get access to the content. For example, no permissions, content revoked. More...

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

Inheritance diagram for NoPermissionsError:

[legend]

Collaboration diagram for NoPermissionsError:

[legend]

Public Types
enum class	Category { Unknown = 0 , UserNotFound = 1 , AccessDenied = 2 , AccessExpired = 3 , InvalidEmail = 4 , UnknownTenant = 5 , NotOwner = 6 , NotPremiumLicenseUser = 7 , ClientVersionNotSupported = 8 }
	Category of no permissions 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.

Category	GetCategory () const
	Gets the category of no permissions failure.

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

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.

std::string	GetOwner () const
	Gets the owner of the document.

std::string	GetReferrer () const
	Gets the contact in case of missing rights to the document.

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 &	GetCategoryString (Category category) const

Private Attributes
Category	mCategory

std::string	mFormattedMessage

std::string	mMaskedMessage

std::string	mOwner

std::string	mReferrer

Detailed Description

The user could not get access to the content. For example, no permissions, content revoked.

Definition at line 672 of file error.h.

Member Enumeration Documentation

◆ Category

enum class NoPermissionsError::Category

strong

Category of no permissions error.

Enumerator
Unknown	Unknown no permissions failure
UserNotFound	Requested user was not found failure
AccessDenied	Access to content or action was not permitted
AccessExpired	Access to content or action has expired
InvalidEmail
UnknownTenant
NotOwner	User needs to be owner to perform action
NotPremiumLicenseUser	User needs to be a premium license holder to perform action. Tracking and Revocation for example
ClientVersionNotSupported	User needs to update their client in order to support features used within this document >

Definition at line 677 of file error.h.

                      {
    Unknown = 0, /**< Unknown no permissions failure */
    UserNotFound = 1,           /**< Requested user was not found failure */
    AccessDenied = 2,           /**< Access to content or action was not permitted */
    AccessExpired = 3,          /**< Access to content or action has expired */
    InvalidEmail = 4,
    UnknownTenant = 5,
    NotOwner = 6,               /**< User needs to be owner to perform action */
    NotPremiumLicenseUser = 7,  /**< User needs to be a premium license holder to perform action. Tracking and Revocation for example */
    ClientVersionNotSupported = 8, /**< User needs to update their client in order to support features used within this document >*/
  };

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;
  }

◆ GetCategory()

Category NoPermissionsError::GetCategory ( ) const

inline

Gets the category of no permissions failure.

Returns: Category of no permissions failure

Definition at line 755 of file error.h.

755{ return mCategory; }

NoPermissionsError::mCategory

Category mCategory

Definition error.h:758

References mCategory.

◆ GetCategoryString()

const std::string & NoPermissionsError::GetCategoryString ( Category category ) const

inlineprivate

Definition at line 762 of file error.h.

                                                              {
    static const std::string kUnrecognized = "UNRECOGNIZED";
    static const std::map<Category, std::string> kCategories = {
        { Category::Unknown,                    "Unknown" },
        { Category::UserNotFound,               "UserNotFound" },
        { Category::AccessDenied,               "AccessDenied" },
        { Category::AccessExpired,              "AccessExpired" },
        { Category::InvalidEmail,               "InvalidEmail" },
        { Category::UnknownTenant,              "UnknownTenant" },
        { Category::NotOwner,                   "NotOwner" },
        { Category::NotPremiumLicenseUser,      "NotPremiumLicenseUser" },
        { Category::ClientVersionNotSupported,  "ClientVersionNotSupported" }
    };
    return kCategories.count(category) ? kCategories.at(category) : kUnrecognized;
  }

References AccessDenied, AccessExpired, ClientVersionNotSupported, InvalidEmail, NotOwner, NotPremiumLicenseUser, Unknown, UnknownTenant, and UserNotFound.

◆ 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.

◆ 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.

◆ GetOwner()

std::string NoPermissionsError::GetOwner ( ) const

inline

Gets the owner of the document.

Returns: Document owner

Definition at line 748 of file error.h.

748{ return mOwner; }

NoPermissionsError::mOwner

std::string mOwner

Definition error.h:760

References mOwner.

◆ GetReferrer()

std::string NoPermissionsError::GetReferrer ( ) const

inline

Gets the contact in case of missing rights to the document.

Returns: The contact in case of missing rights to the document.

Definition at line 741 of file error.h.

741{ return mReferrer; }

NoPermissionsError::mReferrer

std::string mReferrer

Definition error.h:759

References mReferrer.

◆ 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

◆ mCategory

Category NoPermissionsError::mCategory

private

Definition at line 758 of file error.h.

Referenced by GetCategory().

◆ 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().

◆ 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().

◆ mOwner

std::string NoPermissionsError::mOwner

private

Definition at line 760 of file error.h.

Referenced by GetOwner().

◆ mReferrer

std::string NoPermissionsError::mReferrer

private

Definition at line 759 of file error.h.

Referenced by GetReferrer().

◆ 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

◆ Category

Member Function Documentation

◆ AddDebugInfo()

◆ Clone()

◆ CreateFormattedMessage()

◆ GetCategory()

◆ GetCategoryString()

◆ GetDebugInfo()

◆ GetErrorName()

◆ GetErrorType()

◆ GetMessage()

◆ GetOwner()

◆ GetReferrer()

◆ SetMessage()

◆ what()

Member Data Documentation

◆ mCategory

◆ mDebugInfo

◆ mFormattedMessage

◆ mMaskedMessage

◆ mMessage

◆ mName

◆ mOwner

◆ mReferrer

◆ mType