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  *  OIC Virtual resources supported by every OIC device.
  49  */
  50 typedef enum
  51 {
  52     /** unknown URI.*/
  53     OC_UNKNOWN_URI =0,
  54
  55     /** "/oic/res".*/
  56     OC_WELL_KNOWN_URI,
  57
  58     /** "/oic/d" .*/
  59     OC_DEVICE_URI,
  60
  61     /** "/oic/p" .*/
  62     OC_PLATFORM_URI,
  63
  64     /** "/oic/res/d/type" .*/
  65     OC_RESOURCE_TYPES_URI,
  66 #ifdef ROUTING_GATEWAY
  67     /** "/oic/gateway" .*/
  68     OC_GATEWAY_URI,
  69 #endif
  70     #ifdef WITH_PRESENCE
  71     /** "/oic/ad" .*/
  72     OC_PRESENCE,
  73     #endif
  74
  75     /** Max items in the list */
  76     OC_MAX_VIRTUAL_RESOURCES    //<s Max items in the list
  77 } OCVirtualResources;
  78
  79 /**
  80  * The type of query a request/response message is.
  81  */
  82 typedef enum
  83 {
  84     STACK_RES_DISCOVERY_NOFILTER = 0,
  85     STACK_RES_DISCOVERY_IF_FILTER,
  86     STACK_RES_DISCOVERY_RT_FILTER,
  87     STACK_DEVICE_DISCOVERY_DI_FILTER,
  88     STACK_DEVICE_DISCOVERY_DN_FILTER
  89 } StackQueryTypes;
  90
  91 /**
  92  * The type of handling required to handle a request.
  93  */
  94 typedef enum
  95 {
  96     OC_RESOURCE_VIRTUAL = 0,
  97     OC_RESOURCE_NOT_COLLECTION_WITH_ENTITYHANDLER,
  98     OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER,
  99     OC_RESOURCE_COLLECTION_WITH_ENTITYHANDLER,
 100     OC_RESOURCE_COLLECTION_DEFAULT_ENTITYHANDLER,
 101     OC_RESOURCE_DEFAULT_DEVICE_ENTITYHANDLER,
 102     OC_RESOURCE_NOT_SPECIFIED
 103 } ResourceHandling;
 104
 105 /**
 106  * Default entity handler (ie. callback) to be used for resources with
 107  * no entity handler.
 108  */
 109 OCEntityHandlerResult defaultResourceEHandler(OCEntityHandlerFlag flag,
 110         OCEntityHandlerRequest * request, void* callbackParam);
 111
 112 /**
 113  * Find and retrieve pointer to a resource associated with a specific resource
 114  * URI.
 115  * @return pointer to found resource
 116  */
 117 OCResource *FindResourceByUri(const char* resourceUri);
 118
 119 /**
 120  * This function checks whether the specified resource URI aligns with a pre-existing
 121  * virtual resource; returns false otherwise.
 122  * @return true or false.
 123  */
 124 bool IsVirtualResource(const char* resourceUri);
 125
 126 /**
 127  * Parameter @ref handling returns by-reference the type of resource handling
 128  * required by the internal stack based on the specified @ref request.
 129  * @return ::OC_STACK_OK for Success, otherwise some error value
 130  */
 131 OCStackResult DetermineResourceHandling (const OCServerRequest *request,
 132                                          ResourceHandling *handling,
 133                                          OCResource **resource);
 134
 135 /**
 136  * Processes the specified @ref request based on the type of resource handling
 137  * @ref resHandling.
 138  * @return ::OC_STACK_OK for Success, otherwise some error value.
 139  */
 140 OCStackResult ProcessRequest(ResourceHandling resHandling,
 141                              OCResource *resource,
 142                              OCServerRequest *request);
 143
 144 /**
 145  * Internal API used to save all of the platform's information for use in platform
 146  * discovery requests.
 147  * @return ::OC_STACK_OK for Success, otherwise some error value.
 148  */
 149 OCStackResult SavePlatformInfo(OCPlatformInfo info);
 150
 151 /**
 152  * Internal API used to save all of the device's information for use in platform
 153  * discovery requests.
 154  * @param info       Device name is received from the application.
 155  *                   DeviceID, spec version and data model version are initialized by the stack.
 156  * @return ::OC_STACK_OK for Success, otherwise some error value.
 157  */
 158 OCStackResult SaveDeviceInfo(OCDeviceInfo info);
 159
 160 /**
 161  * Internal API used to clear the platform information.
 162  */
 163 void DeletePlatformInfo();
 164
 165 /**
 166  * Internal API used to clear the device information.
 167  */
 168 void DeleteDeviceInfo();
 169
 170 /*
 171  * Prepare payload for resource representation.
 172  */
 173 OCStackResult BuildResponseRepresentation(const OCResource *resourcePtr,
 174                     OCRepPayload** payload);
 175
 176 /**
 177  * A helper function that Maps an @ref OCEntityHandlerResult type to an
 178  * @ref OCStackResult type.
 179  */
 180 OCStackResult EntityHandlerCodeToOCStackCode(OCEntityHandlerResult ehResult);
 181
 182 #endif //OC_RESOURCEHANDLER_H
 183