cimerror.h

Pegasus is an open-source implementationof the DMTF CIM and WBEM standards. It is designed to be por

//%2006////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
// IBM Corp.; EMC Corporation, The Open Group.
// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
// EMC Corporation; VERITAS Software Corporation; The Open Group.
// Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
// EMC Corporation; Symantec Corporation; The Open Group.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
//==============================================================================
//
//%/////////////////////////////////////////////////////////////////////////////

#ifndef Pegasus_CIMError_h
#define Pegasus_CIMError_h

#include <Pegasus/Common/String.h>
#include <Pegasus/Common/Array.h>
#include <Pegasus/Common/CIMInstance.h>

PEGASUS_NAMESPACE_BEGIN

/** CIMError is a specialized class that contains information about the
    severity, cause, recommended actions and other data related to the failure
    of a CIM Operation.  This class is defined in the DMTF Interop schema.
    Instances of this type MAY be included by a CIMServer as part of the
    response to a CIM Operation as part of an ERROR entity.  CIMErrors like
    CIM_Indications do not persist, and therefore do not have keys.
    Currently, this is only allowed by defining a concrete class with the
    Indication qualifier.  Until the CIM Specification is modified to allow
    other concrete classes without keys, the CIMError class MUST be qualified
    by both Indication and Exception.  After this, the Indication qualifier
    can be removed.  This class is implemented as a Pegasus CIMInstance but
    becasue of the special nature of the usage of CIMError this class provides
    specific accessors and modifiersfor each property in the class.

    Because CIMError is implemented as a facade for a CIMInstance it
    uses a shared representation model for the data. More information about
    the effects of using this model are in the CIMInstance documentation.

    NOTE: In the  only a single public constructor is provided that
    requires setting all of the required properties in any constructed
    CIMError class.  This class also provides specific enumerations for
    those properties in the CIM_Error class that are mof enumerations
    (values and valuemaps).
*/

class PEGASUS_COMMON_LINKAGE CIMError { public:

    /** Enumeration of the possible values in the
        ErrorType Property of the CIM_Error Class
    */
    enum ErrorTypeEnum
    {
        ERROR_TYPE_UNKNOWN = 0,
        ERROR_TYPE_OTHER = 1,
        ERROR_TYPE_COMMUNICATIONS_ERROR = 2,
        ERROR_TYPE_QUALITY_OF_SERVICE_ERROR = 3,
        ERROR_TYPE_SOFTWARE_ERROR = 4,
        ERROR_TYPE_HARDWARE_ERROR = 5,
        ERROR_TYPE_ENVIRONMENTAL_ERROR = 6,
        ERROR_TYPE_SECURITY_ERROR = 7,
        ERROR_TYPE_OVERSUBSCRIPTION_ERROR = 8,
        ERROR_TYPE_UNAVAILABLE_RESOURCE_ERROR = 9,
        ERROR_TYPE_UNSUPPORTED_OPERATION_ERROR = 10
    };

    /** Enumeration of the possiblle values in the
        Perceived Severity Property of the CIM_Error Class
    */
    enum PerceivedSeverityEnum
    {
        PERCEIVED_SEVERITY_UNKNOWN = 0,
        PERCEIVED_SEVERITY_UNUSED_1 = 1,
        PERCEIVED_SEVERITY_LOW = 2,
        PERCEIVED_SEVERITY_MEDIUM = 3,
        PERCEIVED_SEVERITY_HIGH = 4,
        PERCEIVED_SEVERITY_FATAL = 5
    };

    /**  Enumeration of the possible values in the
         ProbableCause Property of hte CIM_Error Class
    */
    enum ProbableCauseEnum
    {
        PROBABLE_CAUSE_UNKNOWN = 0,
        PROBABLE_CAUSE_OTHER = 1,
        PROBABLE_CAUSE_ADAPTER_CARD_ERROR = 2,
        PROBABLE_CAUSE_APPLICATION_SUBSYSTEM_FAILURE = 3,
        PROBABLE_CAUSE_BANDWIDTH_REDUCED = 4,
        PROBABLE_CAUSE_CONNECTION_ESTABLISHMENT_ERROR = 5,
        PROBABLE_CAUSE_COMMUNICATIONS_PROTOCOL_ERROR = 6,
        PROBABLE_CAUSE_COMMUNICATIONS_SUBSYSTEM_FAILURE = 7,
        PROBABLE_CAUSE_CONFIGURATION_CUSTOMIZATION_ERROR = 8,
        PROBABLE_CAUSE_CONGESTION = 9,
        PROBABLE_CAUSE_CORRUPT_DATA = 10,
        PROBABLE_CAUSE_CPU_CYCLES_LIMIT_EXCEEDED = 11,
        PROBABLE_CAUSE_DATASET_MODEM_ERROR = 12,
        PROBABLE_CAUSE_DEGRADED_SIGNAL = 13,
        PROBABLE_CAUSE_DTE_DCE_INTERFACE_ERROR = 14,
        PROBABLE_CAUSE_ENCLOSURE_DOOR_OPEN = 15,
        PROBABLE_CAUSE_EQUIPMENT_MALFUNCTION = 16,
        PROBABLE_CAUSE_EXCESSIVE_VIBRATION = 17,
        PROBABLE_CAUSE_FILE_FORMAT_ERROR = 18,
        PROBABLE_CAUSE_FIRE_DETECTED = 19,
        PROBABLE_CAUSE_FLOOD_DETECTED = 20,
        PROBABLE_CAUSE_FRAMING_ERROR = 21,
        PROBABLE_CAUSE_HVAC_PROBLEM = 22,
        PROBABLE_CAUSE_HUMIDITY_UNACCEPTABLE = 23,
        PROBABLE_CAUSE_I_O_DEVICE_ERROR = 24,
        PROBABLE_CAUSE_INPUT_DEVICE_ERROR = 25,
        PROBABLE_CAUSE_LAN_ERROR = 26,
        PROBABLE_CAUSE_NON_TOXIC_LEAK_DETECTED = 27,
        PROBABLE_CAUSE_LOCAL_NODE_TRANSMISSION_ERROR = 28,
        PROBABLE_CAUSE_LOSS_OF_FRAME = 29,
        PROBABLE_CAUSE_LOSS_OF_SIGNAL = 30,
        PROBABLE_CAUSE_MATERIAL_SUPPLY_EXHAUSTED = 31,
        PROBABLE_CAUSE_MULTIPLEXER_PROBLEM = 32,
        PROBABLE_CAUSE_OUT_OF_MEMORY = 33,
        PROBABLE_CAUSE_OUTPUT_DEVICE_ERROR = 34,
        PROBABLE_CAUSE_PERFORMANCE_DEGRADED = 35,
        PROBABLE_CAUSE_POWER_PROBLEM = 36,
        PROBABLE_CAUSE_PRESSURE_UNACCEPTABLE = 37,
        PROBABLE_CAUSE_PROCESSOR_PROBLEM__INTERNAL_MACHINE_ERROR_ = 38,
        PROBABLE_CAUSE_PUMP_FAILURE = 39,
        PROBABLE_CAUSE_QUEUE_SIZE_EXCEEDED = 40,
        PROBABLE_CAUSE_RECEIVE_FAILURE = 41,
        PROBABLE_CAUSE_RECEIVER_FAILURE = 42,
        PROBABLE_CAUSE_REMOTE_NODE_TRANSMISSION_ERROR = 43,
        PROBABLE_CAUSE_RESOURCE_AT_OR_NEARING_CAPACITY = 44,
        PROBABLE_CAUSE_RESPONSE_TIME_EXCESSIVE = 45,
        PROBABLE_CAUSE_RETRANSMISSION_RATE_EXCESSIVE = 46,
        PROBABLE_CAUSE_SOFTWARE_ERROR = 47,
        PROBABLE_CAUSE_SOFTWARE_PROGRAM_ABNORMALLY_TERMINATED = 48,
        PROBABLE_CAUSE_SOFTWARE_PROGRAM_ERROR__INCORRECT_RESULTS_ = 49,
        PROBABLE_CAUSE_STORAGE_CAPACITY_PROBLEM = 50,
        PROBABLE_CAUSE_TEMPERATURE_UNACCEPTABLE = 51,
        PROBABLE_CAUSE_THRESHOLD_CROSSED = 52,
        PROBABLE_CAUSE_TIMING_PROBLEM = 53,
        PROBABLE_CAUSE_TOXIC_LEAK_DETECTED = 54,
        PROBABLE_CAUSE_TRANSMIT_FAILURE = 55,
        PROBABLE_CAUSE_TRANSMITTER_FAILURE = 56,
        PROBABLE_CAUSE_UNDERLYING_RESOURCE_UNAVAILABLE = 57,
        PROBABLE_CAUSE_VERSION_MISMATCH = 58,
        PROBABLE_CAUSE_PREVIOUS_ALERT_CLEARED = 59,
        PROBABLE_CAUSE_LOGIN_ATTEMPTS_FAILED = 60,
        PROBABLE_CAUSE_SOFTWARE_VIRUS_DETECTED = 61,
        PROBABLE_CAUSE_HARDWARE_SECURITY_BREACHED = 62,
        PROBABLE_CAUSE_DENIAL_OF_SERVICE_DETECTED = 63,
        PROBABLE_CAUSE_SECURITY_CREDENTIAL_MISMATCH = 64,
        PROBABLE_CAUSE_UNAUTHORIZED_ACCESS = 65,
        PROBABLE_CAUSE_ALARM_RECEIVED = 66,
        PROBABLE_CAUSE_LOSS_OF_POINTER = 67,
        PROBABLE_CAUSE_PAYLOAD_MISMATCH = 68,
        PROBABLE_CAUSE_TRANSMISSION_ERROR = 69,
        PROBABLE_CAUSE_EXCESSIVE_ERROR_RATE = 70,
        PROBABLE_CAUSE_TRACE_PROBLEM = 71,
        PROBABLE_CAUSE_ELEMENT_UNAVAILABLE = 72,
        PROBABLE_CAUSE_ELEMENT_MISSING = 73,
        PROBABLE_CAUSE_LOSS_OF_MULTI_FRAME = 74,
        PROBABLE_CAUSE_BROADCAST_CHANNEL_FAILURE = 75,
        PROBABLE_CAUSE_INVALID_MESSAGE_RECEIVED = 76,
        PROBABLE_CAUSE_ROUTING_FAILURE = 77,
        PROBABLE_CAUSE_BACKPLANE_FAILURE = 78,
        PROBABLE_CAUSE_IDENTIFIER_DUPLICATION = 79,
        PROBABLE_CAUSE_PROTECTION_PATH_FAILURE = 80,
        PROBABLE_CAUSE_SYNC_LOSS_OR_MISMATCH = 81,
        PROBABLE_CAUSE_TERMINAL_PROBLEM = 82,
        PROBABLE_CAUSE_REAL_TIME_CLOCK_FAILURE = 83,
        PROBABLE_CAUSE_ANTENNA_FAILURE = 84,
        PROBABLE_CAUSE_BATTERY_CHARGING_FAILURE = 85,
        PROBABLE_CAUSE_DISK_FAILURE = 86,
        PROBABLE_CAUSE_FREQUENCY_HOPPING_FAILURE = 87,
        PROBABLE_CAUSE_LOSS_OF_REDUNDANCY = 88,
        PROBABLE_CAUSE_POWER_SUPPLY_FAILURE = 89,
        PROBABLE_CAUSE_SIGNAL_QUALITY_PROBLEM = 90,
        PROBABLE_CAUSE_BATTERY_DISCHARGING = 91,
        PROBABLE_CAUSE_BATTERY_FAILURE = 92,
        PROBABLE_CAUSE_COMMERCIAL_POWER_PROBLEM = 93,
        PROBABLE_CAUSE_FAN_FAILURE = 94,
        PROBABLE_CAUSE_ENGINE_FAILURE = 95,
        PROBABLE_CAUSE_SENSOR_FAILURE = 96,
        PROBABLE_CAUSE_FUSE_FAILURE = 97,
        PROBABLE_CAUSE_GENERATOR_FAILURE = 98,
        PROBABLE_CAUSE_LOW_BATTERY = 99,
        PROBABLE_CAUSE_LOW_FUEL = 100,
        PROBABLE_CAUSE_LOW_WATER = 101,
        PROBABLE_CAUSE_EXPLOSIVE_GAS = 102,
        PROBABLE_CAUSE_HIGH_WINDS = 103,
        PROBABLE_CAUSE_ICE_BUILDUP = 104,
        PROBABLE_CAUSE_SMOKE = 105,
        PROBABLE_CAUSE_MEMORY_MISMATCH = 106,
        PROBABLE_CAUSE_OUT_OF_CPU_CYCLES = 107,
        PROBABLE_CAUSE_SOFTWARE_ENVIRONMENT_PROBLEM = 108,
        PROBABLE_CAUSE_SOFTWARE_DOWNLOAD_FAILURE = 109,
        PROBABLE_CAUSE_ELEMENT_REINITIALIZED = 110,
        PROBABLE_CAUSE_TIMEOUT = 111,
        PROBABLE_CAUSE_LOGGING_PROBLEMS = 112,
        PROBABLE_CAUSE_LEAK_DETECTED = 113,
        PROBABLE_CAUSE_PROTECTION_MECHANISM_FAILURE = 114,
        PROBABLE_CAUSE_PROTECTING_RESOURCE_FAILURE = 115,
        PROBABLE_CAUSE_DATABASE_INCONSISTENCY = 116,
        PROBABLE_CAUSE_AUTHENTICATION_FAILURE = 117,
        PROBABLE_CAUSE_BREACH_OF_CONFIDENTIALITY = 118,
        PROBABLE_CAUSE_CABLE_TAMPER = 119,
        PROBABLE_CAUSE_DELAYED_INFORMATION = 120,
        PROBABLE_CAUSE_DUPLICATE_INFORMATION = 121,
        PROBABLE_CAUSE_INFORMATION_MISSING = 122,
        PROBABLE_CAUSE_INFORMATION_MODIFICATION = 123,
        PROBABLE_CAUSE_INFORMATION_OUT_OF_SEQUENCE = 124,
        PROBABLE_CAUSE_KEY_EXPIRED = 125,
        PROBABLE_CAUSE_NON_REPUDIATION_FAILURE = 126,
        PROBABLE_CAUSE_OUT_OF_HOURS_ACTIVITY = 127,
        PROBABLE_CAUSE_OUT_OF_SERVICE = 128,
        PROBABLE_CAUSE_PROCEDURAL_ERROR = 129,
        PROBABLE_CAUSE_UNEXPECTED_INFORMATION = 130
    };

    /** Enumeration of the possible values for the
        ErrorSourceFormat Property of the CIM_Error Class
    */
    enum ErrorSourceFormatEnum
    {
        ERROR_SOURCE_FORMAT_UNKNOWN = 0,
        ERROR_SOURCE_FORMAT_OTHER = 1,
        ERROR_SOURCE_FORMAT_CIM_OBJECT_HANDLE = 2
    };