dali/devel-api/adaptor-framework/web-engine-request-interceptor.h

   1 #ifndef DALI_WEB_ENGINE_REQUEST_INTERCEPTOR_H
   2 #define DALI_WEB_ENGINE_REQUEST_INTERCEPTOR_H
   3
   4 /*
   5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <string>
  23
  24 namespace Dali
  25 {
  26 /**
  27  * @brief A class WebEngineRequestInterceptor for intercepting http request.
  28  */
  29 class WebEngineRequestInterceptor
  30 {
  31 public:
  32   /**
  33    * @brief Constructor.
  34    */
  35   WebEngineRequestInterceptor() = default;
  36
  37   /**
  38    * @brief Destructor.
  39    */
  40   virtual ~WebEngineRequestInterceptor() = default;
  41
  42   /**
  43    * @brief Returns request url.
  44    *
  45    * @return url on success or empty on failure
  46    */
  47   virtual std::string GetUrl() const = 0;
  48
  49   /**
  50    * @brief Ignores request.
  51    *
  52    * @return true on success or false on failure
  53    */
  54   virtual bool Ignore() = 0;
  55
  56   /**
  57    * @brief Sets status code and status text of response for intercepted request.
  58    *
  59    * @param[in] statusCode Status code of response
  60    * @param[in] customStatusText Status code of response
  61    *
  62    * @return true if succeeded or false if failed
  63    */
  64   virtual bool SetResponseStatus(int statusCode, const std::string& customStatusText) = 0;
  65
  66   /**
  67    * @brief Adds HTTP header to response for intercepted request.
  68    *
  69    * @param[in] fieldName Key of response header
  70    * @param[in] fieldValue Value of response header
  71    *
  72    * @return true if succeeded or false if failed
  73    */
  74   virtual bool AddResponseHeader(const std::string& fieldName, const std::string& fieldValue) = 0;
  75
  76   /**
  77    * @brief Writes whole response body at once.
  78    *
  79    * @param[in] body Contents of response
  80    * @param[in] length Length of Contents of response
  81    *
  82    * @return true if succeeded or false if failed
  83    */
  84   virtual bool AddResponseBody(const std::string& body, uint32_t length) = 0;
  85 };
  86
  87 } // namespace Dali
  88
  89 #endif // DALI_WEB_ENGINE_REQUEST_INTERCEPTOR_H