Return to HTTPMessage.h CVS log

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

HP-RK Define an HTTP error message to be returned to the CIMClient when an HTTP error response is returned.  Add a method to parse the status line of an HTTP response.

//%////////-*-c++-*-////////////////////////////////////////////////////////////
//
// Copyright (c) 2000, 2001 BMC Software, Hewlett-Packard Company, IBM, 
// The Open Group, Tivoli Systems
//
// 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.
//
//==============================================================================
//
// Author: Mike Brasher (mbrasher@bmc.com)
//
// Modified By: Nag Boranna, Hewlett-Packard Company (nagaraja_boranna@hp.com)
//              Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com)
//
//%/////////////////////////////////////////////////////////////////////////////

#ifndef Pegasus_HTTPMessage_h
#define Pegasus_HTTPMessage_h

#include <iostream>
#include <Pegasus/Common/Config.h>
#include <Pegasus/Common/MessageQueue.h>
#include <Pegasus/Common/Pair.h>
#include <Pegasus/Common/String.h>
#include <Pegasus/Common/Message.h>
#include <Pegasus/Common/Array.h>
#include <Pegasus/Common/Monitor.h>
#include <Pegasus/Common/AuthenticationInfo.h>

PEGASUS_NAMESPACE_BEGIN

typedef Pair<String, String> HTTPHeader;

/** This message is sent from a connection to its output queue when
    a complete HTTP message is received.
*/
class PEGASUS_COMMON_LINKAGE HTTPMessage : public Message
{
   public:
  
      typedef Message Base;
      
      HTTPMessage(const Array<Sint8>& message_, Uint32 queueId_ = 0);

      HTTPMessage(HTTPMessage & msg);
    
      Array<Sint8> message;
      Uint32 queueId;
      AuthenticationInfo* authInfo;

      void parse(
	 String& startLine,
	 Array<HTTPHeader>& headers,
	 Uint32& contentLength) const;

      void printAll(PEGASUS_STD(ostream)& os) const;

      static Boolean lookupHeader(
	 Array<HTTPHeader>& headers,
	 const String& fieldName,
	 String& fieldValue,
	 Boolean wildCardMatch = false);

      static Boolean parseRequestLine(
	 const String& startLine,
	 String& methodName,
	 String& requestUri,
	 String& httpVersion);

      static Boolean parseStatusLine(
	 const String& statusLine,
	 String& httpVersion,
	 Uint32& statusCode,
	 String& reasonPhrase);
};

PEGASUS_NAMESPACE_END

/** This message is sent from the response decoder back to the client to turn
    it into an Exception.
*/
class PEGASUS_COMMON_LINKAGE HTTPErrorMessage : public Message
{
   public:
      typedef Message Base;

      HTTPErrorMessage(
         Uint32 httpStatusCode_,
         const String& cimError_,
         const String& pegasusError_)
         : Message(HTTP_ERROR_MESSAGE),
           httpStatusCode(httpStatusCode_),
           cimError(cimError_),
           pegasusError(pegasusError_)
      { }


      HTTPErrorMessage(HTTPErrorMessage & msg)
         : Base(msg)
      {
         if( this != &msg)
         {
            httpStatusCode = msg.httpStatusCode;
            const_cast<String &>(cimError) = msg.cimError;
            const_cast<String &>(pegasusError) = msg.pegasusError;
         }
      }

      virtual ~HTTPErrorMessage()
      {
      }

      Uint32 httpStatusCode;
      const String cimError;
      const String pegasusError;
};

#endif /* Pegasus_HTTPMessage_h */