error.h File Reference

A file containing the MIP SDK error types. More...

#include <algorithm>
#include <exception>
#include <map>
#include <memory>
#include <sstream>
#include <stdexcept>
#include <string>
#include <vector>
#include "mip/common_types.h"
#include "mip/mip_namespace.h"

Go to the source code of this file.

Classes
struct	ExtendedErrorInfo
class	Error
	Base class for all errors that will be reported (thrown or returned) from MIP SDK. More...
class	BadInputError
	Bad input error, thrown when the input to an SDK API is invalid. More...
class	DelegateResponseError
	Delegate Response Error. Thrown or returned in response to encountering an error in a delegate method. More...
class	InsufficientBufferError
	Insufficient buffer error. More...
class	FileIOError
	File IO error. More...
class	NetworkError
	Networking error. Caused by unexpected behavior when making network calls to service endpoints. More...
class	ProxyAuthenticationError
	Proxy authentication failure. More...
class	InternalError
	Internal error. This error is thrown when something unexpected happens during execution. More...
class	NotSupportedError
	The operation requested by the application is not supported by the SDK. More...
class	PrivilegedRequiredError
	Current label was assigned as a privileged operation (The equivalent to an administrator operation), therefore it can't be overriden. More...
class	AccessDeniedError
	The user could not get access to the content. For example, no permissions, content revoked. More...
class	NoPermissionsError
	The user could not get access to the content. For example, no permissions, content revoked. More...
class	NoPermissionsExtendedError
	The user could not get access to the content due to extended Access checks like ABAC. More...
class	NoAuthTokenError
	The user could not get access to the content due to missing authentication token. More...
class	ServiceDisabledError
	The user could not get access to the content due to a service being disabled. More...
class	ConsentDeniedError
	An operation that required consent from user was not granted consent. More...
class	NoPolicyError
	Tenant policy is not configured for classification/labels. More...
class	OperationCancelledError
	Operation was cancelled. More...
class	AdhocProtectionRequiredError
	Adhoc protection should be set to complete the action on the file. More...
class	DeprecatedApiError
	Caller invoked a deprecated API. More...
class	TemplateNotFoundError
	Template ID is not recognized by RMS service. More...
class	TemplateArchivedError
	Template ID is archived and unavailable for protection. More...
class	ContentFormatNotSupportedError
	Content Format is not supported. More...
class	LabelNotFoundError
	Label ID is not recognized. More...
class	LicenseNotRegisteredError
	License is not registered. More...
class	LabelDisabledError
	Label is disabled or inactive. More...
class	CustomerKeyUnavailableError
	Bring your own encryption key needed and unavailable. More...

Enumerations
enum class	ErrorType : unsigned int {   BAD_INPUT_ERROR , INSUFFICIENT_BUFFER_ERROR , FILE_IO_ERROR , NETWORK_ERROR ,   INTERNAL_ERROR , JUSTIFICATION_REQUIRED , NOT_SUPPORTED_OPERATION , PRIVILEGED_REQUIRED ,   ACCESS_DENIED , CONSENT_DENIED , NO_PERMISSIONS , NO_AUTH_TOKEN ,   DISABLED_SERVICE , PROXY_AUTH_ERROR , NO_POLICY , OPERATION_CANCELLED ,   ADHOC_PROTECTION_REQUIRED , DEPRECATED_API , TEMPLATE_NOT_FOUND , LABEL_NOT_FOUND ,   LABEL_DISABLED , DOUBLE_KEY_DISABLED , LICENSE_NOT_REGISTERED , CONTENT_FORMAT_NOT_SUPPORTED ,   TEMPLATE_ARCHIVED , CUSTOMER_KEY_UNAVAILABLE , DELEGATE_RESPONSE , COUNT }

Detailed Description

A file containing the MIP SDK error types.

Enumeration Type Documentation

ErrorType

enum class ErrorType : unsigned int

strong

Enumerator
BAD_INPUT_ERROR	Caller passed bad input.
INSUFFICIENT_BUFFER_ERROR	Caller passed a buffer that was too small.
FILE_IO_ERROR	General File IO error.
NETWORK_ERROR	General network issues; for example, unreachable service.
INTERNAL_ERROR	Internal unexpected errors.
JUSTIFICATION_REQUIRED	Justification should be provided to complete the action on the file.
NOT_SUPPORTED_OPERATION	The requested operation is not yet supported.
PRIVILEGED_REQUIRED	Can't override privileged label when new label method is standard.
ACCESS_DENIED	The user could not get access to services.
CONSENT_DENIED	An operation that required consent from user was not granted consent.
NO_PERMISSIONS	The user could not get access to the content. For example, no permissions, content revoked
NO_AUTH_TOKEN	The user could not get access to the content due to an empty auth token.
DISABLED_SERVICE	The user could not get access to the content due to the service being disabled
PROXY_AUTH_ERROR	Proxy authentication failed.
NO_POLICY	No policy is configured for user/tenant
OPERATION_CANCELLED	Operation cancelled
ADHOC_PROTECTION_REQUIRED	Adhoc protection should be set to complete the action on the file
DEPRECATED_API	Caller invoked a deprecated API
TEMPLATE_NOT_FOUND	Template ID is not recognized
LABEL_NOT_FOUND	Label ID is not recognized
LABEL_DISABLED	Label is disabled or inactive
DOUBLE_KEY_DISABLED	The double key feature has not been enabled
LICENSE_NOT_REGISTERED	License not registered for tracking and revocation
CONTENT_FORMAT_NOT_SUPPORTED	Content format is not supported
TEMPLATE_ARCHIVED	Template has been archived and is unavailable for protection
CUSTOMER_KEY_UNAVAILABLE	Customer key not available when attempting to fetch for Bring Your Own Key Protection
DELEGATE_RESPONSE	Error generated from delegated response
COUNT	Last element in this enum. Used to keep track of the number of mip::ErrorTypes