Merge branch 'master' into resource-manipulation
[platform/upstream/iotivity.git] / resource / csdk / stack / include / internal / ocresourcehandler.h
1 //******************************************************************
2 //
3 // Copyright 2014 Intel Mobile Communications GmbH 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 #ifndef OC_RESOURCEHANDLER_H
22 #define OC_RESOURCEHANDLER_H
23
24 #include "ocstack.h"
25 #include "ocstackinternal.h"
26 #include "ocserverrequest.h"
27
28 /**
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.
32  */
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             "="
40
41 /**
42  * Static values for various JSON attributes.
43  */
44 #define OC_RESOURCE_OBSERVABLE   1
45 #define OC_RESOURCE_SECURE       1
46
47 /**
48  * The type of query a request/response message is.
49  */
50 typedef enum
51 {
52     STACK_RES_DISCOVERY_NOFILTER = 0,
53     STACK_RES_DISCOVERY_IF_FILTER,
54     STACK_RES_DISCOVERY_RT_FILTER,
55     STACK_DEVICE_DISCOVERY_DI_FILTER,
56     STACK_DEVICE_DISCOVERY_DN_FILTER
57 } StackQueryTypes;
58
59 /**
60  * The type of handling required to handle a request.
61  */
62 typedef enum
63 {
64     OC_RESOURCE_VIRTUAL = 0,
65     OC_RESOURCE_NOT_COLLECTION_WITH_ENTITYHANDLER,
66     OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER,
67     OC_RESOURCE_COLLECTION_WITH_ENTITYHANDLER,
68     OC_RESOURCE_COLLECTION_DEFAULT_ENTITYHANDLER,
69     OC_RESOURCE_DEFAULT_DEVICE_ENTITYHANDLER,
70     OC_RESOURCE_NOT_SPECIFIED
71 } ResourceHandling;
72
73 /**
74  * Default entity handler (ie. callback) to be used for resources with
75  * no entity handler.
76  */
77 OCEntityHandlerResult defaultResourceEHandler(OCEntityHandlerFlag flag,
78         OCEntityHandlerRequest * request, void* callbackParam);
79
80 /**
81  * Get string value associated with a virtual resource type.
82  */
83 const char * GetVirtualResourceUri(OCVirtualResources resource);
84
85 /**
86  * Find and retrieve pointer to a resource associated with a specific resource
87  * URI.
88  */
89 OCResource *FindResourceByUri(const char* resourceUri);
90
91 /**
92  * Returns true if the specificed resource URI aligns with a pre-existing
93  * virtual resource; returns false otherwise.
94  */
95 bool IsVirtualResource(const char* resourceUri);
96
97 /**
98  * Parameter @ref handling returns by-reference the type of resource handling
99  * required by the internal stack based on the specified @ref request.
100  */
101 OCStackResult DetermineResourceHandling (const OCServerRequest *request,
102                                          ResourceHandling *handling,
103                                          OCResource **resource);
104
105 /**
106  * Processes the specified @ref request based on the type of resource handling
107  * @ref resHandling.
108  */
109 OCStackResult ProcessRequest(ResourceHandling resHandling,
110                              OCResource *resource,
111                              OCServerRequest *request);
112
113 /**
114  * Internal API used to save all of the platform's information for use in platform
115  * discovery requests.
116  */
117 OCStackResult SavePlatformInfo(OCPlatformInfo info);
118
119 /**
120  * Internal API used to save all of the device's information for use in platform
121  * discovery requests.
122  * The device name is received from the appliation.
123  * The deviceID, spec version and data model verson are initialized by the stack.
124  */
125 OCStackResult SaveDeviceInfo(OCDeviceInfo info);
126
127 /**
128  * Internal API used to clear the platform information.
129  */
130 void DeletePlatformInfo();
131
132 /**
133  * Internal API used to clear the device information.
134  */
135 void DeleteDeviceInfo();
136
137 /**
138  * Prepares a JSON string for response.
139  */
140 OCStackResult BuildVirtualResourceResponse(const OCResource *resourcePtr,
141                                            char * out,
142                                            uint16_t *remaining,
143                                            CATransportAdapter_t adapter);
144
145 /**
146  * A helper function that Maps an @ref OCEntityHandlerResult type to an
147  * @ref OCStackResult type.
148  */
149 OCStackResult EntityHandlerCodeToOCStackCode(OCEntityHandlerResult ehResult);
150
151 #endif //OC_RESOURCEHANDLER_H
152