OW_HTTPClient.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2001-2004 Vintela, Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of source code must retain the above copyright notice,
*    this list of conditions and the following disclaimer.
*
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this list of conditions and the following disclaimer in the documentation
*    and/or other materials provided with the distribution.
*
*  - Neither the name of Vintela, Inc. nor the names of its
*    contributors may be used to endorse or promote products derived from this
*    software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL Vintela, Inc. OR THE CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/

#ifndef OW_HTTPCLIENT_HPP_
#define OW_HTTPCLIENT_HPP_
#include "OW_config.h"
#include "OW_Socket.hpp"
#include "OW_AutoPtr.hpp"
#include "OW_Map.hpp"
#include "OW_HTTPUtils.hpp"
#include "OW_CIMProtocolIFC.hpp"
#include "OW_URL.hpp"
#include "OW_CommonFwd.hpp"

#if defined(GOOD)
#undef GOOD
#endif

namespace OW_NAMESPACE
{

// TODO: Rewrite this class. It's way too big and convoluted. 
// Take a look at Apache's HttpClient library: http://jakarta.apache.org/commons/httpclient/index.html

class OW_HTTP_API HTTPClient : public CIMProtocolIFC
{
public:
   HTTPClient(const String& url, const SSLClientCtxRef& sslCtx = SSLClientCtxRef());
   virtual ~HTTPClient();
   virtual Reference<std::iostream> beginRequest(
         const String& methodName, const String& cimObject);

   virtual CIMProtocolIStreamIFCRef endRequest(
      const Reference<std::iostream>& request,
      const String& methodName,
      const String& cimObject,
      ERequestType requestType,
      const String& cimProtocolVersion);

   virtual CIMFeatures getFeatures();
   SocketAddress getLocalAddress() const;
   SocketAddress getPeerAddress()  const;
   void setHTTPPath(const String& newPath);

   void assumeBasicAuth();

   virtual void close();

   void addCustomHeader(const String& name, const String& value);

   bool getResponseHeader(const String& hdrName, String& valueOut) const;

   static const int INFINITE_TIMEOUT = -1;
   virtual void setReceiveTimeout(int seconds);
   virtual int getReceiveTimeout() const;
   virtual void setSendTimeout(int seconds);
   virtual int getSendTimeout() const;
   virtual void setConnectTimeout(int seconds);
   virtual int getConnectTimeout() const;
   virtual void setTimeouts(int seconds);

private:
   /*
    * @throws SocketException If an SSL connection was requested, but support for SSL is not available.
    */
   void setUrl();

   void cleanUpIStreams();
   void receiveAuthentication();
   void sendAuthorization();
   bool receiveOptions( void );

#ifdef OW_WIN32
#pragma warning (push)
#pragma warning (disable: 4251)
#endif
   
   String m_sAuthorization;
   String m_sRealm;
   
#ifndef OW_DISABLE_DIGEST
   String m_sDigestNonce;
   String m_sDigestCNonce;
   UInt8 m_iDigestNonceCount;
   String m_sDigestSessionKey;
   String m_sDigestResponse;
#endif
   enum Resp_t
   {
      FATAL,
      RETRY,
      GOOD,
      CONTINUE
   };
   SocketAddress m_serverAddress;
   URL m_url;
   HTTPHeaderMap m_responseHeaders;
   // Persistant headers remain for the life of the
   // HTTPClient.  They are included in each request
   Array<String> m_requestHeadersPersistent;
   // Common headers are used for only a single request,
   // but are reused if the request must be repeated (with
   // new authentication credentials, for instance).
   Array<String> m_requestHeadersCommon;
   // New headers are replaced each time the client repeats
   // a request (with new auth credentials, for instance).
   Array<String> m_requestHeadersNew;
   CIMProtocolIStreamIFCRef m_pIstrReturn;
   SSLClientCtxRef m_sslCtx;
   mutable Socket m_socket;
   String m_requestMethod;
   bool m_authRequired;
   std::istream& m_istr;
   std::ostream& m_ostr;
   bool m_doDeflateOut;
   int m_retryCount;
   String m_httpPath;
   bool m_uselocalAuthentication;
   String m_localNonce;
   String m_localCookieFile;
   String m_statusLine;

#ifdef OW_WIN32
#pragma warning (pop)
#endif

   bool headerHasKey(const String& key)
   {
      return HTTPUtils::headerHasKey(m_responseHeaders, key);
   }
   String getHeaderValue(const String& key)
   {
      return HTTPUtils::getHeaderValue(m_responseHeaders, key);
   }
   void addHeaderCommon(const String& key, const String& value)
   {
      HTTPUtils::addHeader(m_requestHeadersCommon, key, value);
   }
   void addHeaderPersistent(const String& key, const String& value)
   {
      HTTPUtils::addHeader(m_requestHeadersPersistent, key, value);
   }
   void addHeaderNew(const String& key, const String& value)
   {
      HTTPUtils::addHeader(m_requestHeadersNew, key, value);
   }
   void sendHeaders(const String& method,
      const String& prot);
   Resp_t processHeaders(String& reasonPhrase);
   CIMProtocolIStreamIFCRef convertToFiniteStream();
   void prepareForRetry();
   void handleAuth(); // process authorization
   void checkConnection();
   String checkResponse(Resp_t& rt);
   void prepareHeaders();
   void sendDataToServer( const Reference<TempFileStream>& tfs, const String& methodName, const String& cimObject, ERequestType requestType );
   void getCredentialsIfNecessary();
   void copyStreams(std::ostream& ostr, std::istream& istr);
   void getStatusLine();

   enum EStatusLineSummary
   {
      E_STATUS_GOOD,
      E_STATUS_ERROR
   };
   EStatusLineSummary checkAndExamineStatusLine();



   // unimplemented
   HTTPClient(const HTTPClient&);
   HTTPClient& operator=(const HTTPClient&);
};

typedef IntrusiveReference<HTTPClient> HTTPClientRef;

} // end namespace OW_NAMESPACE

#endif

---