1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
//******************************************************************
//
// Copyright 2014 Intel Mobile Communications GmbH All Rights Reserved.
//
//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
/**
* @file
*
* This file contains the declaration of classes and its members related to
* ResourceRequest.
*/
#ifndef OC_RESOURCEREQUEST_H_
#define OC_RESOURCEREQUEST_H_
#include "OCApi.h"
#include "OCRepresentation.h"
void formResourceRequest(OCEntityHandlerFlag,
OCEntityHandlerRequest*,
std::shared_ptr<OC::OCResourceRequest>);
namespace OC
{
/**
* @brief OCResourceRequest provides APIs to extract details from a request URI
*/
class OCResourceRequest
{
public:
typedef std::shared_ptr<OCResourceRequest> Ptr;
OCResourceRequest():
m_requestType(""),
m_resourceUri(""),
m_queryParameters(QueryParamsMap()),
m_requestHandlerFlag(0),
m_messageID(0),
m_representation(OCRepresentation()),
m_headerOptions(HeaderOptions()),
m_requestHandle(0),
m_resourceHandle(nullptr)
{
m_observationInfo.action = ObserveAction::ObserveRegister;
m_observationInfo.obsId = 0;
m_observationInfo.connectivityType = OCConnectivityType::CT_DEFAULT;
m_observationInfo.address = "";
m_observationInfo.port = 0;
}
#if defined(_MSC_VER) && (_MSC_VER < 1900)
OCResourceRequest(OCResourceRequest&& o):
m_requestType(std::move(o.m_requestType)),
m_resourceUri(std::move(o.m_resourceUri)),
m_queryParameters(std::move(o.m_queryParameters)),
m_requestHandlerFlag(o.m_requestHandlerFlag),
m_representation(std::move(o.m_representation)),
m_observationInfo(std::move(o.m_observationInfo)),
m_headerOptions(std::move(o.m_headerOptions)),
m_requestHandle(std::move(o.m_requestHandle)),
m_resourceHandle(std::move(o.m_resourceHandle))
{
}
OCResourceRequest& operator=(OCResourceRequest&& o)
{
m_requestType = std::move(o.m_requestType);
m_resourceUri = std::move(o.m_resourceUri);
m_queryParameters = std::move(o.m_queryParameters);
m_requestHandlerFlag = o.m_requestHandlerFlag;
m_representation = std::move(o.m_representation);
m_observationInfo = std::move(o.m_observationInfo);
m_headerOptions = std::move(o.m_headerOptions);
m_requestHandle = std::move(o.m_requestHandle);
m_resourceHandle = std::move(o.m_resourceHandle);
}
#else
OCResourceRequest(OCResourceRequest&&) = default;
OCResourceRequest& operator=(OCResourceRequest&&) = default;
#endif
/**
* Virtual destructor
*/
virtual ~OCResourceRequest(void)
{
}
/**
* Retrieves the type of request string for the entity handler function to operate
* @return std::string request type. This could be 'GET'/'PUT'/'POST'/'DELETE'
*/
std::string getRequestType() const {return m_requestType;}
/**
* Retrieves the query parameters from the request
* @return std::string query parameters in the request
*/
const QueryParamsMap& getQueryParameters() const {return m_queryParameters;}
/**
* Retrieves the request handler flag type. This can be either INIT flag or
* REQUEST flag or OBSERVE flag.
* NOTE:
* INIT indicates that the vendor's entity handler should go and perform
* initialization operations
* REQUEST indicates that it is a request of certain type (GET/PUT/POST/DELETE)
* and entity handler needs to perform corresponding operations
* OBSERVE indicates that the request is of type Observe and entity handler
* needs to perform corresponding operations
* @return int type of request flag
*/
int getRequestHandlerFlag() const {return m_requestHandlerFlag;}
/**
* Provides the entire resource attribute representation
* @return OCRepresentation reference containing the name value pairs
* representing the resource's attributes
*/
const OCRepresentation& getResourceRepresentation() const {return m_representation;}
/**
* @return ObservationInfo reference provides observation information
*/
const ObservationInfo& getObservationInfo() const {return m_observationInfo;}
/**
* sets resource uri
* @param resourceUri specifies the resource uri
*/
void setResourceUri(const std::string resourceUri)
{
m_resourceUri = resourceUri;
}
/**
* gets resource uri
* @return std::string resource uri
*/
std::string getResourceUri(void)
{
return m_resourceUri;
}
/**
* This API retrieves headerOptions which was sent from a client
*
* @return std::map HeaderOptions with the header options
*/
const HeaderOptions& getHeaderOptions() const
{
return m_headerOptions;
}
/**
* This API retrieves the request handle
*
* @return OCRequestHandle
*/
const OCRequestHandle& getRequestHandle() const
{
return m_requestHandle;
}
/**
* This API retrieves the resource handle
*
* return OCResourceHandle
*/
const OCResourceHandle& getResourceHandle() const
{
return m_resourceHandle;
}
/**
* This API retrieves the request message ID
*
* @return int16_t value of message ID
*/
int16_t getMessageID() const {return m_messageID;}
private:
std::string m_requestType;
std::string m_resourceUri;
QueryParamsMap m_queryParameters;
int m_requestHandlerFlag;
int16_t m_messageID;
OCRepresentation m_representation;
ObservationInfo m_observationInfo;
HeaderOptions m_headerOptions;
OCRequestHandle m_requestHandle;
OCResourceHandle m_resourceHandle;
private:
friend void (::formResourceRequest)(OCEntityHandlerFlag, OCEntityHandlerRequest*,
std::shared_ptr<OC::OCResourceRequest>);
void setRequestType(const std::string& requestType)
{
m_requestType = requestType;
}
void setPayload(OCPayload* requestPayload);
void setQueryParams(QueryParamsMap& queryParams)
{
m_queryParameters = queryParams;
}
void setRequestHandlerFlag(int requestHandlerFlag)
{
m_requestHandlerFlag = requestHandlerFlag;
}
void setMessageID(int16_t messageID)
{
m_messageID = messageID;
}
void setObservationInfo(const ObservationInfo& observationInfo)
{
m_observationInfo = observationInfo;
}
void setHeaderOptions(const HeaderOptions& headerOptions)
{
m_headerOptions = headerOptions;
}
/**
* This API allows to set request handle
* @param requestHandle - OCRequestHandle type used to set the
* request handle
*/
void setRequestHandle(const OCRequestHandle& requestHandle)
{
m_requestHandle = requestHandle;
}
/**
* This API allows to set the resource handle
* @param resourceHandle - OCResourceHandle type used to set the
* resource handle
*/
void setResourceHandle(const OCResourceHandle& resourceHandle)
{
m_resourceHandle = resourceHandle;
}
};
}// namespace OC
#endif // OC_RESOURCEREQUEST_H_
|
