Return to CIMClientException.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Client

BUG#: 7767
TITLE: Clean up CIMClient interface documentation
DESCRIPTION: Rework API documentation and address doxygen warnings.

//%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_ClientException_h
#define Pegasus_ClientException_h

#include <Pegasus/Common/Config.h>
#include <Pegasus/Common/String.h>
#include <Pegasus/Common/Exception.h>
#include <Pegasus/Client/Linkage.h>

PEGASUS_NAMESPACE_BEGIN

/**
    An exception of this type indicates that the HTTP response from the CIM
    Server was improperly formed.
*/
class PEGASUS_CLIENT_LINKAGE CIMClientMalformedHTTPException
    : public Exception
{
public:
    /**
        Constructs a CIMClientMalformedHTTPException with a specified message.
        @param message The exception message
    */
    CIMClientMalformedHTTPException(const String& message);
};

/**
    An exception of this type indicates that an HTTP error response was sent
    by the CIM Server.
*/
class PEGASUS_CLIENT_LINKAGE CIMClientHTTPErrorException : public Exception
{
public:
    /**
        Constructs a CIMClientHTTPErrorException with specified error details.
        @param httpStatusCode The HTTP status code in the response
        @param reasonPhrase The HTTP reason phrase in the response
        @param cimError The CIMError header value in the HTTP response
        @param cimErrorDetail Additional error detail information, if available
    */
    CIMClientHTTPErrorException(
        Uint32 httpStatusCode,
        const String& reasonPhrase,
        const String& cimError,
        const String& cimErrorDetail);

    /**
        Constructs a CIMClientHTTPErrorException with specified error details.
        @param httpStatusCode The HTTP status code in the response
        @param cimError The CIMError header value in the HTTP response
        @param cimErrorDetail Additional error detail information, if available
    */
    CIMClientHTTPErrorException(
        Uint32 httpStatusCode,
        const String& cimError,
        const String& cimErrorDetail);

    /**
        Constructs a copy of an CIMClientHTTPErrorException.
        @param httpError The object to copy
    */
    CIMClientHTTPErrorException(const CIMClientHTTPErrorException& httpError);

    /**
        Destructs an CIMClientHTTPErrorException.
    */
    virtual ~CIMClientHTTPErrorException();

    /**
        Copies an CIMClientHTTPErrorException.
        @param httpError The object to copy
    */
    CIMClientHTTPErrorException& operator=(
        const CIMClientHTTPErrorException& httpError);

    /**
        Gets the HTTP status code from the error response.
        @return An integer HTTP status code
    */
    Uint32 getCode() const;

    /**
        Gets the CIMError header value from the HTTP error response.
        @return A String containing the CIMError header value
    */
    String getCIMError() const;

    /**
        Gets additional error detail information from the HTTP error response.
        @return A String containing additional error detail information from
            the HTTP error response, if available.  Otherwise, an empty String
            is returned.
    */
    String getCIMErrorDetail() const;
};

/**
    An exception of this type indicates that the CIM response sent by the
    CIM Server could not be decoded from XML.
*/
class PEGASUS_CLIENT_LINKAGE CIMClientXmlException : public Exception
{
public:
    /**
        Constructs a CIMClientXmlException with a specified message.
        @param message The exception message
    */
    CIMClientXmlException(const String& message);
};

/**
    An exception of this type indicates that the CIM response sent by the
    CIM Server contained unexpected data.
*/
class PEGASUS_CLIENT_LINKAGE CIMClientResponseException
    : public Exception
{
public:
    /**
        Constructs a CIMClientResponseException with a specified message.
        @param message The exception message
    */
    CIMClientResponseException(const String& message);
};

PEGASUS_NAMESPACE_END

#endif /* Pegasus_ClientException_h */