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  * Attributes used to form a proper OIC conforming JSON message.
  30  */
  31 #define OC_RSRVD_OC                     "oc"
  32 #define OC_RSRVD_PAYLOAD                "payload"
  33 #define OC_RSRVD_HREF                   "href"
  34 #define OC_RSRVD_PROPERTY               "prop"
  35 #define OC_RSRVD_REPRESENTATION         "rep"
  36 #define OC_RSRVD_CONTENT_TYPE           "ct"
  37 #define OC_RSRVD_RESOURCE_TYPE          "rt"
  38 #define OC_RSRVD_RESOURCE_TYPE_PRESENCE "core.presence"
  39 #define OC_RSRVD_INTERFACE              "if"
  40 #define OC_RSRVD_DEVICE_ID              "di"
  41 #define OC_RSRVD_DEVICE_NAME            "dn"
  42 #define OC_RSRVD_INTERFACE_DEFAULT      "oc.mi.def"
  43 #define OC_RSRVD_INTERFACE_LL           "oc.mi.ll"
  44 #define OC_RSRVD_INTERFACE_BATCH        "oc.mi.b"
  45 #define OC_RSRVD_INTERFACE_GROUP        "oc.mi.grp"
  46 #define OC_RSRVD_MFG_DATE               "mndt"
  47 #define OC_RSRVD_FW_VERSION             "mnfv"
  48 #define OC_RSRVD_HOST_NAME              "hn"
  49 #define OC_RSRVD_MFG_NAME               "mnmn"
  50 #define OC_RSRVD_MFG_URL                "mnml"
  51 #define OC_RSRVD_MODEL_NUM              "mnmo"
  52 #define OC_RSRVD_PLATFORM_VERSION       "mnpv"
  53 #define OC_RSRVD_SUPPORT_URL            "mnsl"
  54 #define OC_RSRVD_VERSION                "icv"
  55 #define OC_RSRVD_OBSERVABLE             "obs"
  56 #define OC_RSRVD_SECURE                 "sec"
  57 #define OC_RSRVD_HOSTING_PORT           "port"
  58 #define OC_RSRVD_SERVER_INSTANCE_ID     "sid"
  59
  60 /**
  61  * Common JSON string components used by the stack to build JSON strings.
  62  */
  63 #define OC_JSON_PREFIX                     "{\"oc\":["
  64 #define OC_JSON_PREFIX_LEN                 (sizeof(OC_JSON_PREFIX) - 1)
  65 #define OC_JSON_SUFFIX                     "]}"
  66 #define OC_JSON_SUFFIX_LEN                 (sizeof(OC_JSON_SUFFIX) - 1)
  67 #define OC_JSON_SEPARATOR                  ','
  68 #define OC_JSON_SEPARATOR_STR              ","
  69
  70 /**
  71  * Static values for various JSON attributes.
  72  */
  73 #define OC_RESOURCE_OBSERVABLE   1
  74 #define OC_RESOURCE_SECURE       1
  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);
 108
 109 /**
 110  * Get string value associated with a virtual resource type.
 111  */
 112 const char * GetVirtualResourceUri(OCVirtualResources resource);
 113
 114 /**
 115  * Find and retrieve pointer to a resource associated with a specific resource
 116  * URI.
 117  */
 118 OCResource *FindResourceByUri(const char* resourceUri);
 119
 120 /**
 121  * Returns true if the specificed resource URI aligns with a pre-existing
 122  * virtual resource; returns false otherwise.
 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  */
 130 OCStackResult DetermineResourceHandling (const OCServerRequest *request,
 131                                          ResourceHandling *handling,
 132                                          OCResource **resource);
 133
 134 /**
 135  * Processes the specified @ref request based on the type of resource handling
 136  * @ref resHandling.
 137  */
 138 OCStackResult ProcessRequest(ResourceHandling resHandling,
 139                              OCResource *resource,
 140                              OCServerRequest *request);
 141
 142 /**
 143  * Internal API used to save all of the device's information for use in device
 144  * discovery requests.
 145  */
 146 OCStackResult SaveDeviceInfo(OCDeviceInfo deviceInfo);
 147
 148 /**
 149  * Internal API used to clear the device information.
 150  */
 151 void DeleteDeviceInfo();
 152
 153 /**
 154  * Prepares a JSON string for response.
 155  */
 156 OCStackResult BuildVirtualResourceResponse(const OCResource *resourcePtr,
 157                                            uint8_t filterOn,
 158                                            const char *filterValue,
 159                                            char * out,
 160                                            uint16_t *remaining,
 161                                            CAConnectivityType_t connType);
 162
 163 /**
 164  * A helper function that Maps an @ref OCEntityHandlerResult type to an
 165  * @ref OCStackResult type.
 166  */
 167 OCStackResult EntityHandlerCodeToOCStackCode(OCEntityHandlerResult ehResult);
 168
 169 #endif //OC_RESOURCEHANDLER_H
 170