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 #ifndef OC_RESOURCEHANDLER_H
22 #define OC_RESOURCEHANDLER_H
25 #include "ocstackinternal.h"
26 #include "ocserverrequest.h"
29 * Common JSON string components used by the stack to build JSON strings.
30 * These details are exposed in ocstackconfig.h file in the form of documentation.
31 * Remember to update the documentation there if these are changed.
33 #define OC_JSON_PREFIX "{\"oic\":["
34 #define OC_JSON_PREFIX_LEN (sizeof(OC_JSON_PREFIX) - 1)
35 #define OC_JSON_SUFFIX "]}"
36 #define OC_JSON_SUFFIX_LEN (sizeof(OC_JSON_SUFFIX) - 1)
37 #define OC_JSON_SEPARATOR ','
38 #define OC_JSON_SEPARATOR_STR ","
39 #define OC_KEY_VALUE_DELIMITER "="
42 * Static values for various JSON attributes.
44 #define OC_RESOURCE_OBSERVABLE 1
45 #define OC_RESOURCE_SECURE 1
48 * OIC Virtual resources supported by every OIC device.
64 /** "/oic/res/d/type" .*/
65 OC_RESOURCE_TYPES_URI,
72 /** Max items in the list */
73 OC_MAX_VIRTUAL_RESOURCES //<s Max items in the list
77 * The type of query a request/response message is.
81 STACK_RES_DISCOVERY_NOFILTER = 0,
82 STACK_RES_DISCOVERY_IF_FILTER,
83 STACK_RES_DISCOVERY_RT_FILTER,
84 STACK_DEVICE_DISCOVERY_DI_FILTER,
85 STACK_DEVICE_DISCOVERY_DN_FILTER
89 * The type of handling required to handle a request.
93 OC_RESOURCE_VIRTUAL = 0,
94 OC_RESOURCE_NOT_COLLECTION_WITH_ENTITYHANDLER,
95 OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER,
96 OC_RESOURCE_COLLECTION_WITH_ENTITYHANDLER,
97 OC_RESOURCE_COLLECTION_DEFAULT_ENTITYHANDLER,
98 OC_RESOURCE_DEFAULT_DEVICE_ENTITYHANDLER,
99 OC_RESOURCE_NOT_SPECIFIED
103 * Default entity handler (ie. callback) to be used for resources with
106 OCEntityHandlerResult defaultResourceEHandler(OCEntityHandlerFlag flag,
107 OCEntityHandlerRequest * request, void* callbackParam);
110 * Find and retrieve pointer to a resource associated with a specific resource
112 * @return pointer to found resource
114 OCResource *FindResourceByUri(const char* resourceUri);
117 * This function checks whether the specified resource URI aligns with a pre-existing
118 * virtual resource; returns false otherwise.
119 * @return true or false.
121 bool IsVirtualResource(const char* resourceUri);
124 * Parameter @ref handling returns by-reference the type of resource handling
125 * required by the internal stack based on the specified @ref request.
126 * @return ::OC_STACK_OK for Success, otherwise some error value
128 OCStackResult DetermineResourceHandling (const OCServerRequest *request,
129 ResourceHandling *handling,
130 OCResource **resource);
133 * Processes the specified @ref request based on the type of resource handling
135 * @return ::OC_STACK_OK for Success, otherwise some error value.
137 OCStackResult ProcessRequest(ResourceHandling resHandling,
138 OCResource *resource,
139 OCServerRequest *request);
142 * Internal API used to save all of the platform's information for use in platform
143 * discovery requests.
144 * @return ::OC_STACK_OK for Success, otherwise some error value.
146 OCStackResult SavePlatformInfo(OCPlatformInfo info);
149 * Internal API used to save all of the device's information for use in platform
150 * discovery requests.
151 * @param info Device name is received from the application.
152 * DeviceID, spec version and data model version are initialized by the stack.
153 * @return ::OC_STACK_OK for Success, otherwise some error value.
155 OCStackResult SaveDeviceInfo(OCDeviceInfo info);
158 * Internal API used to clear the platform information.
160 void DeletePlatformInfo();
163 * Internal API used to clear the device information.
165 void DeleteDeviceInfo();
168 * Prepare payload for resource representation.
170 OCStackResult BuildResponseRepresentation(const OCResource *resourcePtr,
171 OCRepPayload** payload);
174 * Prepares a Payload for response.
176 OCStackResult BuildVirtualResourceResponse(const OCResource *resourcePtr,
177 OCDiscoveryPayload* payload,
178 OCDevAddr *endpoint);
181 * A helper function that Maps an @ref OCEntityHandlerResult type to an
182 * @ref OCStackResult type.
184 OCStackResult EntityHandlerCodeToOCStackCode(OCEntityHandlerResult ehResult);
186 #endif //OC_RESOURCEHANDLER_H