orthanc: OrthancFramework/Sources/HttpClient.h comparison

comparison OrthancFramework/Sources/HttpClient.h @ 4044:d25f4c0fa160 framework

splitting code into OrthancFramework and OrthancServer

author	Sebastien Jodogne <s.jodogne@gmail.com>
date	Wed, 10 Jun 2020 20:30:34 +0200
parents	Core/HttpClient.h@05a363186da6
children	bf7b9edf6b81

comparison

equal deleted inserted replaced

-:6c6239aec462
+:d25f4c0fa160
+/**
+* Orthanc - A Lightweight, RESTful DICOM Store
+* Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
+* Department, University Hospital of Liege, Belgium
+* Copyright (C) 2017-2020 Osimis S.A., Belgium
+*
+* This program is free software: you can redistribute it and/or
+* modify it under the terms of the GNU General Public License as
+* published by the Free Software Foundation, either version 3 of the
+* License, or (at your option) any later version.
+*
+* In addition, as a special exception, the copyright holders of this
+* program give permission to link the code of its release with the
+* OpenSSL project's "OpenSSL" library (or with modified versions of it
+* that use the same license as the "OpenSSL" library), and distribute
+* the linked executables. You must obey the GNU General Public License
+* in all respects for all of the code used other than "OpenSSL". If you
+* modify file(s) with this exception, you may extend this exception to
+* your version of the file(s), but you are not obligated to do so. If
+* you do not wish to do so, delete this exception statement from your
+* version. If you delete this exception statement from all source files
+* in the program, then also delete it here.
+*
+* This program is distributed in the hope that it will be useful, but
+* WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+* General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with this program. If not, see <http://www.gnu.org/licenses/>.
+**/
+#pragma once
+#include "Enumerations.h"
+#include "OrthancFramework.h"
+#include "WebServiceParameters.h"
+#include <string>
+#include <boost/noncopyable.hpp>
+#include <boost/shared_ptr.hpp>
+#include <json/json.h>
+#if !defined(ORTHANC_ENABLE_CURL)
+#  error The macro ORTHANC_ENABLE_CURL must be defined
+#endif
+#if ORTHANC_ENABLE_CURL != 1
+#  error Support for curl is disabled, cannot use this file
+#endif
+#if !defined(ORTHANC_ENABLE_SSL)
+#  error The macro ORTHANC_ENABLE_SSL must be defined
+#endif
+#if !defined(ORTHANC_ENABLE_PKCS11)
+#  error The macro ORTHANC_ENABLE_PKCS11 must be defined
+#endif
+namespace Orthanc
+{
+class ORTHANC_PUBLIC HttpClient : public boost::noncopyable
+{
+public:
+typedef std::map<std::string, std::string>  HttpHeaders;
+class IRequestBody : public boost::noncopyable
+{
+public:
+virtual ~IRequestBody()
+{
+}
+virtual bool ReadNextChunk(std::string& chunk) = 0;
+};
+class IAnswer : public boost::noncopyable
+{
+public:
+virtual ~IAnswer()
+{
+}
+virtual void AddHeader(const std::string& key,
+const std::string& value) = 0;
+virtual void AddChunk(const void* data,
+size_t size) = 0;
+};
+private:
+class CurlHeaders;
+class CurlRequestBody;
+class CurlAnswer;
+class DefaultAnswer;
+class GlobalParameters;
+struct PImpl;
+boost::shared_ptr<PImpl> pimpl_;
+std::string url_;
+std::string credentials_;
+HttpMethod method_;
+HttpStatus lastStatus_;
+std::string body_;  // This only makes sense for POST and PUT requests
+bool isVerbose_;
+long timeout_;
+std::string proxy_;
+bool verifyPeers_;
+std::string caCertificates_;
+std::string clientCertificateFile_;
+std::string clientCertificateKeyFile_;
+std::string clientCertificateKeyPassword_;
+bool pkcs11Enabled_;
+bool headersToLowerCase_;
+bool redirectionFollowed_;
+void Setup();
+void operator= (const HttpClient&);  // Assignment forbidden
+HttpClient(const HttpClient& base);  // Copy forbidden
+bool ApplyInternal(CurlAnswer& answer);
+bool ApplyInternal(std::string& answerBody,
+HttpHeaders* answerHeaders);
+bool ApplyInternal(Json::Value& answerBody,
+HttpHeaders* answerHeaders);
+public:
+HttpClient();
+HttpClient(const WebServiceParameters& service,
+const std::string& uri);
+~HttpClient();
+void SetUrl(const char* url)
+{
+url_ = std::string(url);
+}
+void SetUrl(const std::string& url)
+{
+url_ = url;
+}
+const std::string& GetUrl() const
+{
+return url_;
+}
+void SetMethod(HttpMethod method)
+{
+method_ = method;
+}
+HttpMethod GetMethod() const
+{
+return method_;
+}
+void SetTimeout(long seconds)
+{
+timeout_ = seconds;
+}
+long GetTimeout() const
+{
+return timeout_;
+}
+void SetBody(const std::string& data);
+std::string& GetBody()
+{
+return body_;
+}
+const std::string& GetBody() const
+{
+return body_;
+}
+void SetBody(IRequestBody& body);
+void ClearBody();
+void SetVerbose(bool isVerbose);
+bool IsVerbose() const
+{
+return isVerbose_;
+}
+void AddHeader(const std::string& key,
+const std::string& value);
+void ClearHeaders();
+bool Apply(IAnswer& answer);
+bool Apply(std::string& answerBody)
+{
+return ApplyInternal(answerBody, NULL);
+}
+bool Apply(Json::Value& answerBody)
+{
+return ApplyInternal(answerBody, NULL);
+}
+bool Apply(std::string& answerBody,
+HttpHeaders& answerHeaders)
+{
+return ApplyInternal(answerBody, &answerHeaders);
+}
+bool Apply(Json::Value& answerBody,
+HttpHeaders& answerHeaders)
+{
+return ApplyInternal(answerBody, &answerHeaders);
+}
+HttpStatus GetLastStatus() const
+{
+return lastStatus_;
+}
+void SetCredentials(const char* username,
+const char* password);
+void SetProxy(const std::string& proxy)
+{
+proxy_ = proxy;
+}
+void SetHttpsVerifyPeers(bool verify)
+{
+verifyPeers_ = verify;
+}
+bool IsHttpsVerifyPeers() const
+{
+return verifyPeers_;
+}
+void SetHttpsCACertificates(const std::string& certificates)
+{
+caCertificates_ = certificates;
+}
+const std::string& GetHttpsCACertificates() const
+{
+return caCertificates_;
+}
+void SetClientCertificate(const std::string& certificateFile,
+const std::string& certificateKeyFile,
+const std::string& certificateKeyPassword);
+void SetPkcs11Enabled(bool enabled)
+{
+pkcs11Enabled_ = enabled;
+}
+bool IsPkcs11Enabled() const
+{
+return pkcs11Enabled_;
+}
+const std::string& GetClientCertificateFile() const
+{
+return clientCertificateFile_;
+}
+const std::string& GetClientCertificateKeyFile() const
+{
+return clientCertificateKeyFile_;
+}
+const std::string& GetClientCertificateKeyPassword() const
+{
+return clientCertificateKeyPassword_;
+}
+void SetConvertHeadersToLowerCase(bool lowerCase)
+{
+headersToLowerCase_ = lowerCase;
+}
+bool IsConvertHeadersToLowerCase() const
+{
+return headersToLowerCase_;
+}
+void SetRedirectionFollowed(bool follow)
+{
+redirectionFollowed_ = follow;
+}
+bool IsRedirectionFollowed() const
+{
+return redirectionFollowed_;
+}
+static void GlobalInitialize();
+static void GlobalFinalize();
+static void InitializePkcs11(const std::string& module,
+const std::string& pin,
+bool verbose);
+static void ConfigureSsl(bool httpsVerifyPeers,
+const std::string& httpsCACertificates);
+static void SetDefaultVerbose(bool verbose);
+static void SetDefaultProxy(const std::string& proxy);
+static void SetDefaultTimeout(long timeout);
+void ApplyAndThrowException(IAnswer& answer);
+void ApplyAndThrowException(std::string& answerBody);
+void ApplyAndThrowException(Json::Value& answerBody);
+void ApplyAndThrowException(std::string& answerBody,
+HttpHeaders& answerHeaders);
+void ApplyAndThrowException(Json::Value& answerBody,
+HttpHeaders& answerHeaders);
+static void ThrowException(HttpStatus status);
+};
+}

Mercurial > hg > orthanc

comparison OrthancFramework/Sources/HttpClient.h @ 4044:d25f4c0fa160 framework