service/resource-encapsulation/include/RCSRequest.h

   1 //******************************************************************
   2 //
   3 // Copyright 2015 Samsung Electronics All Rights Reserved.
   4 //
   5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
   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 /**
  22  * @file
  23  *
  24  * This file contains the declaration of classes and its members related to RCSRequest
  25  */
  26 #ifndef SERVERBUILDER_PRIMITIVEREQUEST_H
  27 #define SERVERBUILDER_PRIMITIVEREQUEST_H
  28
  29 #include <memory>
  30 #include <map>
  31
  32 namespace OC
  33 {
  34     class OCResourceRequest;
  35 }
  36
  37 namespace OIC
  38 {
  39     namespace Service
  40     {
  41         class RCSResourceObject;
  42
  43         /**
  44         * This class describes the request.
  45         *
  46         */
  47         class RCSRequest
  48         {
  49         public:
  50             RCSRequest() = default;
  51
  52             /**
  53             * Constructor to set resource URI.
  54             *
  55             * @param resourceUri URI of the resource for which the request is generated.
  56             */
  57             explicit RCSRequest(const std::string& resourceUri);
  58
  59             RCSRequest(const std::shared_ptr< RCSResourceObject >&,
  60                     const std::shared_ptr< OC::OCResourceRequest >&);
  61
  62             /**
  63              * @return the resource object which receives this request.
  64              */
  65             std::weak_ptr< RCSResourceObject > getResourceObject() const noexcept;
  66
  67             /**
  68             * @return the URI of the request.
  69             *
  70             */
  71             std::string getResourceUri() const;
  72
  73             /**
  74              * @return the OCResourceRequest.
  75              */
  76             std::shared_ptr< OC::OCResourceRequest > getOCRequest() const noexcept;
  77
  78             /**
  79              * @return the query parameters of the request.
  80              */
  81             const std::map< std::string, std::string >& getQueryParams() const;
  82
  83             /**
  84              * @return the interface of the request.
  85              */
  86             std::string getInterface() const;
  87
  88         private:
  89             std::weak_ptr< RCSResourceObject > m_resourceObject;
  90             std::shared_ptr< OC::OCResourceRequest > m_ocRequest;
  91         };
  92
  93     }
  94 }
  95
  96 #endif // SERVERBUILDER_PRIMITIVEREQUEST_H