CIMClientHTTPErrorException Class Reference

#include <CIMClientException.h>

Inheritance diagram for CIMClientHTTPErrorException:
Exception

Public Member Functions

 CIMClientHTTPErrorException (Uint32 httpStatusCode, const String &reasonPhrase, const String &cimError, const String &cimErrorDetail)
 
 CIMClientHTTPErrorException (Uint32 httpStatusCode, const String &cimError, const String &cimErrorDetail)
 
 CIMClientHTTPErrorException (const CIMClientHTTPErrorException &httpError)
 
virtual ~CIMClientHTTPErrorException ()
 
CIMClientHTTPErrorExceptionoperator= (const CIMClientHTTPErrorException &httpError)
 
Uint32 getCode () const
 
String getCIMError () const
 
String getCIMErrorDetail () const
 
- Public Member Functions inherited from Exception
 Exception (const String &message)
 
 Exception (const Exception &exception)
 
virtual ~Exception ()
 
Exceptionoperator= (const Exception &exception)
 
virtual const StringgetMessage () const
 

Additional Inherited Members

- Protected Member Functions inherited from Exception
 Exception ()
 
- Protected Attributes inherited from Exception
ExceptionRep * _rep
 

Detailed Description

An exception of this type indicates that an HTTP error response was sent by the CIM Server.

Constructor & Destructor Documentation

◆ CIMClientHTTPErrorException() [1/3]

CIMClientHTTPErrorException::CIMClientHTTPErrorException ( Uint32  httpStatusCode,
const String reasonPhrase,
const String cimError,
const String cimErrorDetail 
)

Constructs a CIMClientHTTPErrorException with specified error details.

Parameters
httpStatusCodeThe HTTP status code in the response
reasonPhraseThe HTTP reason phrase in the response
cimErrorThe CIMError header value in the HTTP response
cimErrorDetailAdditional error detail information, if available

◆ CIMClientHTTPErrorException() [2/3]

CIMClientHTTPErrorException::CIMClientHTTPErrorException ( Uint32  httpStatusCode,
const String cimError,
const String cimErrorDetail 
)

Constructs a CIMClientHTTPErrorException with specified error details.

Parameters
httpStatusCodeThe HTTP status code in the response
cimErrorThe CIMError header value in the HTTP response
cimErrorDetailAdditional error detail information, if available

◆ CIMClientHTTPErrorException() [3/3]

CIMClientHTTPErrorException::CIMClientHTTPErrorException ( const CIMClientHTTPErrorException httpError)

Constructs a copy of an CIMClientHTTPErrorException.

Parameters
httpErrorThe object to copy

◆ ~CIMClientHTTPErrorException()

virtual CIMClientHTTPErrorException::~CIMClientHTTPErrorException ( )
virtual

Member Function Documentation

◆ getCIMError()

String CIMClientHTTPErrorException::getCIMError ( ) const

Gets the CIMError header value from the HTTP error response.

Returns
A String containing the CIMError header value

◆ getCIMErrorDetail()

String CIMClientHTTPErrorException::getCIMErrorDetail ( ) const

Gets additional error detail information from the HTTP error response.

Returns
A String containing additional error detail information from the HTTP error response, if available. Otherwise, an empty String is returned.

◆ getCode()

Uint32 CIMClientHTTPErrorException::getCode ( ) const

Gets the HTTP status code from the error response.

Returns
An integer HTTP status code

◆ operator=()

CIMClientHTTPErrorException& CIMClientHTTPErrorException::operator= ( const CIMClientHTTPErrorException httpError)

Copies an CIMClientHTTPErrorException.

Parameters
httpErrorThe object to copy

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