1 //******************************************************************
3 // Copyright 2014 Intel Mobile Communications GmbH All Rights Reserved.
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
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
11 // http://www.apache.org/licenses/LICENSE-2.0
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.
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
21 /// @file OCResourceRequest.h
23 /// @brief This file contains the declaration of classes and its members related to
26 #ifndef __OCRESOURCEREQUEST_H
27 #define __OCRESOURCEREQUEST_H
29 #include <boost/property_tree/ptree.hpp>
30 #include <boost/property_tree/json_parser.hpp>
33 #include "OCRepresentation.h"
38 * @brief OCResourceRequest provides APIs to extract details from a request URI
40 class OCResourceRequest
43 typedef std::shared_ptr<OCResourceRequest> Ptr;
48 virtual ~OCResourceRequest(void)
53 * Retrieves the type of request string for the entity handler function to operate
54 * @return std::string request type. This could be 'GET'/'PUT'/'POST'/'DELETE'
56 std::string getRequestType() const {return m_requestType;}
59 * Retrieves the query parameters from the request
60 * @return std::string query parameters in the request
62 const QueryParamsMap& getQueryParameters() const {return m_queryParameters;}
65 * Retrieves the request handler flag type. This can be either INIT flag or REQUEST flag or OBSERVE flag.
67 * INIT indicates that the vendor's entity handler should go and perform initialization operations
68 * REQUEST indicates that it is a request of certain type (GET/PUT/POST/DELETE) and entity handler needs to perform
69 * corresponding operations
70 * OBSERVE indicates that the request is of type Observe and entity handler needs to perform corresponding operations
71 * @return std::string type of request flag
73 RequestHandlerFlag getRequestHandlerFlag() const {return m_requestHandlerFlag;}
76 * Provides the entire resource attribute representation
77 * @return OCRepresentation reference containing the name value pairs representing the resource's attributes
79 const OCRepresentation& getResourceRepresentation() const {return m_representation;}
82 std::string m_requestType;
83 QueryParamsMap m_queryParameters;
84 RequestHandlerFlag m_requestHandlerFlag;
85 OCRepresentation m_representation;
88 // TODO: This is not a public API for app developers.
89 // This function will not be exposed in future
90 void setRequestType(const std::string& requestType)
92 m_requestType = requestType;
95 // TODO: This is not a public API for app developers.
96 // This function will not be exposed in future
97 void setPayload(const std::string& requestPayload)
99 AttributeMap attributeMap;
100 // TODO: The following JSON Parse implementation should be seperated into utitilites
101 // and used wherever required.
102 // e.g. parse(std::string& payload, Attributemap& attributeMap)
104 std::stringstream requestStream;
105 requestStream << requestPayload;
106 boost::property_tree::ptree root;
109 boost::property_tree::read_json(requestStream, root);
111 catch(boost::property_tree::json_parser::json_parser_error &e)
117 // TODO this expects the representation oc:{} and not oc:[{}]
118 // this representation is fine when setting for simple resource.
119 boost::property_tree::ptree payload = root.get_child("oc", boost::property_tree::ptree());
121 for(auto& item: payload)
123 std::string name = item.first.data();
124 std::string value = item.second.data();
126 attributeMap[name] = value;
129 m_representation.setAttributeMap(attributeMap);
132 // TODO: This is not a public API for app developers.
133 // This function will not be exposed in future
134 void setQueryParams(QueryParamsMap& queryParams)
136 m_queryParameters = queryParams;
139 // TODO: This is not a public API for app developers.
140 // This function will not be exposed in future
141 void setRequestHandlerFlag(RequestHandlerFlag requestHandlerFlag)
143 m_requestHandlerFlag = requestHandlerFlag;
149 #endif //__OCRESOURCEREQUEST_H