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
  67     #ifdef WITH_PRESENCE
  68     /** "/oic/ad" .*/
  69     OC_PRESENCE,
  70     #endif
  71
  72     /** Max items in the list */
  73     OC_MAX_VIRTUAL_RESOURCES    //<s Max items in the list
  74 } OCVirtualResources;
  75
  76 /**
  77  * The type of query a request/response message is.
  78  */
  79 typedef enum
  80 {
  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
  86 } StackQueryTypes;
  87
  88 /**
  89  * The type of handling required to handle a request.
  90  */
  91 typedef enum
  92 {
  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
 100 } ResourceHandling;
 101
 102 /**
 103  * Default entity handler (ie. callback) to be used for resources with
 104  * no entity handler.
 105  */
 106 OCEntityHandlerResult defaultResourceEHandler(OCEntityHandlerFlag flag,
 107         OCEntityHandlerRequest * request, void* callbackParam);
 108
 109 /**
 110  * Find and retrieve pointer to a resource associated with a specific resource
 111  * URI.
 112  * @return pointer to found resource
 113  */
 114 OCResource *FindResourceByUri(const char* resourceUri);
 115
 116 /**
 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.
 120  */
 121 bool IsVirtualResource(const char* resourceUri);
 122
 123 /**
 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
 127  */
 128 OCStackResult DetermineResourceHandling (const OCServerRequest *request,
 129                                          ResourceHandling *handling,
 130                                          OCResource **resource);
 131
 132 /**
 133  * Processes the specified @ref request based on the type of resource handling
 134  * @ref resHandling.
 135  * @return ::OC_STACK_OK for Success, otherwise some error value.
 136  */
 137 OCStackResult ProcessRequest(ResourceHandling resHandling,
 138                              OCResource *resource,
 139                              OCServerRequest *request);
 140
 141 /**
 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.
 145  */
 146 OCStackResult SavePlatformInfo(OCPlatformInfo info);
 147
 148 /**
 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.
 154  */
 155 OCStackResult SaveDeviceInfo(OCDeviceInfo info);
 156
 157 /**
 158  * Internal API used to clear the platform information.
 159  */
 160 void DeletePlatformInfo();
 161
 162 /**
 163  * Internal API used to clear the device information.
 164  */
 165 void DeleteDeviceInfo();
 166
 167 /*
 168  * Prepare payload for resource representation.
 169  */
 170 OCStackResult BuildResponseRepresentation(const OCResource *resourcePtr,
 171                     OCRepPayload** payload);
 172
 173 /**
 174  * Prepares a Payload for response.
 175  */
 176 OCStackResult BuildVirtualResourceResponse(const OCResource *resourcePtr,
 177                                            OCDiscoveryPayload* payload,
 178                                            OCDevAddr *endpoint);
 179
 180 /**
 181  * A helper function that Maps an @ref OCEntityHandlerResult type to an
 182  * @ref OCStackResult type.
 183  */
 184 OCStackResult EntityHandlerCodeToOCStackCode(OCEntityHandlerResult ehResult);
 185
 186 #endif //OC_RESOURCEHANDLER_H
 187