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         /**
  42         * This class describes the request.
  43         *
  44         */
  45         class RCSRequest
  46         {
  47             public:
  48                 /**
  49                 * Constructor to set resource URI.
  50                 *
  51                 * @param resourceUri URI of the resource for which the request is generated.
  52                 */
  53                 explicit RCSRequest(const std::string& resourceUri);
  54
  55                 explicit RCSRequest(const std::shared_ptr< OC::OCResourceRequest >&);
  56
  57                 RCSRequest &operator=(RCSRequest &) = delete;
  58
  59                 /**
  60                 * @return Returns the URI of the request.
  61                 *
  62                 */
  63                 std::string getResourceUri() const;
  64
  65                 const std::shared_ptr< OC::OCResourceRequest >& getOCRequest() const;
  66
  67                 const std::map< std::string, std::string >& getQueryParams() const;
  68
  69                 std::string getInterface() const;
  70
  71             private:
  72                 const std::shared_ptr< OC::OCResourceRequest > m_ocRequest;
  73         };
  74
  75     }
  76 }
  77
  78 #endif // SERVERBUILDER_PRIMITIVEREQUEST_H