IDHTTPRequest.h

//========================================================================================
// 
// $File$
// 
// Owner: Mainak Biswas
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// ADOBE CONFIDENTIAL
// 
// Copyright 2015 Adobe Systems Incorporated. All Rights Reserved.
// 
// NOTICE: All information contained herein is, and remains
// the property of Adobe Systems Incorporated and its suppliers,
// if any. The intellectual and technical concepts contained
// herein are proprietary to Adobe Systems Incorporated and its
// suppliers and are protected by all applicable intellectual property
// laws, including trade secret and copyright laws.
// Dissemination of this information or reproduction of this material
// is strictly forbidden unless prior written permission is obtained
// from Adobe Systems Incorporated.
// 
// 
// Description:
// This class provides a wrapper over traditional uxtech::network:HTTPRequest implementation. The benefit of using this class is that any additional setup, like setting up 
// request to communicate over authenticated proxy is automatically taken care of.

// Currently This class only takes care of proxy related setup. Internally proxy credentials are shared between Adobe applications and this class uses the same internal 
// mechanism to setup proxy credentials without exposing the credentials to users of this implementation.
// 
// Currently this class provides very limited functionality. All network related API (like setting headers, reading response received etc) will be incrementally exposed via this 
// implementation. 
//
// TODO: Expose more networking API from this class to make it more usable.
// 
//========================================================================================

#ifndef __IDHTTPREQUEST_H__
#define __IDHTTPREQUEST_H__

#include <uxtech/common/functional.hpp>
#include <uxtech/network/async_http.hpp>
#include <uxtech/thread/queue.hpp>

class IDHTTPRequest
{
public:
 typedef std::function<void(IDHTTPRequest& request, uxtech::network::HttpResult result)> AsyncIDHttpRequestNotifier;

 IDHTTPRequest();
 virtual ~IDHTTPRequest();

 virtual void SetUrl(const std::string url) { mUrl = url; }

 virtual void SetMethod(const std::string method) { mMethod = method; }

 virtual std::string GetUrl() { return mUrl; };

 virtual std::string GetMethod() { return mMethod; };

 virtual void ExecuteAsync(const AsyncIDHttpRequestNotifier& notifier, const uxtech::thread::QueuePtr& threadqueue);

 virtual uxtech::network::HttpResult ExecuteSync();

 // Private use - called during application shutdown explicitly to clean up any statically allocated IMSConnectionManager object references.
 static void CleanupOnShutdown();

private:
 std::string mUrl;
 std::string mMethod;
 uxtech::network::HttpRequestPtr mRequest;
 AsyncIDHttpRequestNotifier mNotifier;

 void AsyncUxtechHTTPResponseHandler(const uxtech::network::AsyncHttpRequestPtr& task, uxtech::network::HttpResult httpResult, const uxtech::network::HttpRequestPtr& request);
};

#endif