resource/csdk/stack/src/ocserverrequest.c

   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 #include <string.h>
  21
  22 #include "ocstack.h"
  23 #include "ocserverrequest.h"
  24 #include "ocresourcehandler.h"
  25 #include "oic_malloc.h"
  26 #include "oic_string.h"
  27
  28 #include "cacommon.h"
  29 #include "cainterface.h"
  30
  31 #include "utlist.h"
  32 #include "pdu.h"
  33
  34 // Module Name
  35 #define VERIFY_NON_NULL(arg) { if (!arg) {OC_LOG(FATAL, TAG, #arg " is NULL"); goto exit;} }
  36
  37 #define TAG  PCF("ocserverrequest")
  38
  39 static struct OCServerRequest * serverRequestList = NULL;
  40 static struct OCServerResponse * serverResponseList = NULL;
  41
  42 //-------------------------------------------------------------------------------------------------
  43 // Local functions
  44 //-------------------------------------------------------------------------------------------------
  45
  46 /**
  47  * Add a server response to the server response list
  48  *
  49  * @param response initialized server response that is created by this function
  50  * @param requestHandle - handle of the response
  51  *
  52  * @return
  53  *     OCStackResult
  54  */
  55 static OCStackResult AddServerResponse (OCServerResponse ** response, OCRequestHandle requestHandle)
  56 {
  57     OCServerResponse * serverResponse = NULL;
  58
  59     serverResponse = (OCServerResponse *) OICCalloc(1, sizeof(OCServerResponse));
  60     VERIFY_NON_NULL(serverResponse);
  61
  62     serverResponse->payload = (char *) OICCalloc(1, MAX_RESPONSE_LENGTH);
  63     VERIFY_NON_NULL(serverResponse->payload);
  64
  65     serverResponse->remainingPayloadSize = MAX_RESPONSE_LENGTH;
  66     serverResponse->requestHandle = requestHandle;
  67
  68     *response = serverResponse;
  69     OC_LOG(INFO, TAG, PCF("Server Response Added!!"));
  70     LL_APPEND (serverResponseList, serverResponse);
  71     return OC_STACK_OK;
  72
  73 exit:
  74     if (serverResponse)
  75     {
  76         OICFree(serverResponse);
  77         serverResponse = NULL;
  78     }
  79     *response = NULL;
  80     return OC_STACK_NO_MEMORY;
  81 }
  82
  83 /**
  84  * Delete a server request from the server request list
  85  *
  86  * @param serverRequest - server request to delete
  87  */
  88 static void DeleteServerRequest(OCServerRequest * serverRequest)
  89 {
  90     if(serverRequest)
  91     {
  92         LL_DELETE(serverRequestList, serverRequest);
  93         OICFree(serverRequest->requestToken);
  94         OICFree(serverRequest);
  95         serverRequest = NULL;
  96         OC_LOG(INFO, TAG, PCF("Server Request Removed!!"));
  97     }
  98 }
  99
 100 /**
 101  * Delete a server response from the server response list
 102  *
 103  * @param serverResponse - server response to delete
 104  */
 105 static void DeleteServerResponse(OCServerResponse * serverResponse)
 106 {
 107     if(serverResponse)
 108     {
 109         LL_DELETE(serverResponseList, serverResponse);
 110         OICFree(serverResponse->payload);
 111         OICFree(serverResponse);
 112         OC_LOG(INFO, TAG, PCF("Server Response Removed!!"));
 113     }
 114 }
 115
 116 /**
 117  * Find a server response and delete it from the server response list
 118  *
 119  * @param serverResponse - server response to find and delete
 120  */
 121 static void FindAndDeleteServerResponse(OCServerResponse * serverResponse)
 122 {
 123     OCServerResponse* tmp;
 124     if(serverResponse)
 125     {
 126         LL_FOREACH(serverResponseList, tmp)
 127         {
 128             if (serverResponse == tmp)
 129             {
 130                 DeleteServerResponse(tmp);
 131                 return;
 132             }
 133         }
 134     }
 135 }
 136
 137 //-------------------------------------------------------------------------------------------------
 138 // Internal APIs
 139 //-------------------------------------------------------------------------------------------------
 140
 141 /**
 142  * Get a server request from the server request list using the specified token.
 143  *
 144  * @param token - token of server request
 145  * @param tokenLength - length of token
 146  *
 147  * @return
 148  *     OCServerRequest*
 149  */
 150 OCServerRequest * GetServerRequestUsingToken (const CAToken_t token, uint8_t tokenLength)
 151 {
 152     if(!token)
 153     {
 154         OC_LOG(ERROR, TAG, PCF("Invalid Parameter Token"));
 155         return NULL;
 156     }
 157
 158     OCServerRequest * out = NULL;
 159     LL_FOREACH (serverRequestList, out)
 160     {
 161         OC_LOG(INFO, TAG,PCF("comparing tokens"));
 162         OC_LOG_BUFFER(INFO, TAG, (const uint8_t *)token, tokenLength);
 163         OC_LOG_BUFFER(INFO, TAG, (const uint8_t *)out->requestToken, tokenLength);
 164         if(memcmp(out->requestToken, token, tokenLength) == 0)
 165         {
 166             return out;
 167         }
 168     }
 169     OC_LOG(ERROR, TAG, PCF("Server Request not found!!"));
 170     return NULL;
 171 }
 172
 173 /**
 174  * Get a server request from the server request list using the specified handle
 175  *
 176  * @param handle - handle of server request
 177  * @return
 178  *     OCServerRequest*
 179  */
 180 OCServerRequest * GetServerRequestUsingHandle (const OCServerRequest * handle)
 181 {
 182     OCServerRequest * out = NULL;
 183     LL_FOREACH (serverRequestList, out)
 184     {
 185         if(out == handle)
 186         {
 187             return out;
 188         }
 189     }
 190     OC_LOG(ERROR, TAG, PCF("Server Request not found!!"));
 191     return NULL;
 192 }
 193
 194 /**
 195  * Get a server response from the server response list using the specified handle
 196  *
 197  * @param handle - handle of server response
 198  *
 199  * @return
 200  *     OCServerResponse*
 201  */
 202 OCServerResponse * GetServerResponseUsingHandle (const OCServerRequest * handle)
 203 {
 204     OCServerResponse * out = NULL;
 205     LL_FOREACH (serverResponseList, out)
 206     {
 207         if(out->requestHandle == handle)
 208         {
 209             return out;
 210         }
 211     }
 212     OC_LOG(ERROR, TAG, PCF("Server Response not found!!"));
 213     return NULL;
 214 }
 215
 216 /**
 217  * Add a server request to the server request list
 218  *
 219  * @param request - initialized server request that is created by this function
 220  * @param coapID - ID of CoAP pdu
 221  * @param delayedResNeeded - delayed response required 0=no 1=yes
 222  * @param secured - secure endpoint 0=no 1=yes
 223  * @param notificationFlag - //TODO: remove - does not appear to be used any longer
 224  * @param method - RESTful method
 225  * @param numRcvdVendorSpecificHeaderOptions - number of received vendor specific header options
 226  * @param observationOption - value of observation option
 227  * @param qos - request QOS
 228  * @param query - request query
 229  * @param rcvdVendorSpecificHeaderOptions - received vendor specific header options
 230  * @param reqJSONPayload - request JSON payload
 231  * @param requestToken - request token
 232  * @param tokenLength - request token length
 233  * @param resourceUrl - URL of resource
 234  * @param reqTotalSize - total size of the request
 235  * @param addressInfo - CA Address
 236  * @param connectivityType - connection type
 237  *
 238  * @return
 239  *     OCStackResult
 240  */
 241 OCStackResult AddServerRequest (OCServerRequest ** request, uint16_t coapID,
 242         uint8_t delayedResNeeded, uint8_t notificationFlag, OCMethod method,
 243         uint8_t numRcvdVendorSpecificHeaderOptions, uint32_t observationOption,
 244         OCQualityOfService qos, char * query,
 245         OCHeaderOption * rcvdVendorSpecificHeaderOptions,
 246         char * reqJSONPayload, CAToken_t requestToken, uint8_t tokenLength,
 247         char * resourceUrl, size_t reqTotalSize, const OCDevAddr *devAddr)
 248 {
 249     OCServerRequest * serverRequest = NULL;
 250
 251     //Note: OCServerRequest includes 1 byte for the JSON Payload.  payloadSize is calculated
 252     //as the required length of the string, so this will result in enough room for the
 253     //null terminator as well.
 254     serverRequest = (OCServerRequest *) OICCalloc(1, sizeof(OCServerRequest) +
 255         (reqTotalSize ? reqTotalSize : 1) - 1);
 256     VERIFY_NON_NULL(devAddr);
 257     VERIFY_NON_NULL(serverRequest);
 258
 259     serverRequest->coapID = coapID;
 260     serverRequest->delayedResNeeded = delayedResNeeded;
 261     serverRequest->notificationFlag = notificationFlag;
 262
 263     serverRequest->method = method;
 264     serverRequest->numRcvdVendorSpecificHeaderOptions = numRcvdVendorSpecificHeaderOptions;
 265     serverRequest->observationOption = observationOption;
 266     serverRequest->observeResult = OC_STACK_ERROR;
 267     serverRequest->qos = qos;
 268     serverRequest->ehResponseHandler = HandleSingleResponse;
 269     serverRequest->numResponses = 1;
 270
 271     if(query)
 272     {
 273         OICStrcpy(serverRequest->query, sizeof(serverRequest->query), query);
 274     }
 275
 276     if(rcvdVendorSpecificHeaderOptions)
 277     {
 278         memcpy(serverRequest->rcvdVendorSpecificHeaderOptions, rcvdVendorSpecificHeaderOptions,
 279             MAX_HEADER_OPTIONS * sizeof(OCHeaderOption));
 280     }
 281     if(reqJSONPayload && reqTotalSize)
 282     {
 283         OICStrcpy(serverRequest->reqJSONPayload, reqTotalSize, reqJSONPayload);
 284     }
 285     serverRequest->requestComplete = 0;
 286     if(requestToken)
 287     {
 288         // If tokenLength is zero, the return value depends on the
 289         // particular library implementation (it may or may not be a null pointer).
 290         if (tokenLength)
 291         {
 292             serverRequest->requestToken = (CAToken_t) OICMalloc(tokenLength);
 293             VERIFY_NON_NULL(serverRequest->requestToken);
 294             memcpy(serverRequest->requestToken, requestToken, tokenLength);
 295         }
 296
 297     }
 298     serverRequest->tokenLength = tokenLength;
 299
 300     if(resourceUrl)
 301     {
 302         OICStrcpy(serverRequest->resourceUrl, sizeof(serverRequest->resourceUrl),
 303             resourceUrl);
 304     }
 305
 306     serverRequest->devAddr = *devAddr;
 307
 308     *request = serverRequest;
 309     OC_LOG(INFO, TAG, PCF("Server Request Added!!"));
 310     LL_APPEND (serverRequestList, serverRequest);
 311     return OC_STACK_OK;
 312
 313 exit:
 314     if (serverRequest)
 315     {
 316         OICFree(serverRequest);
 317         serverRequest = NULL;
 318     }
 319     *request = NULL;
 320     return OC_STACK_NO_MEMORY;
 321 }
 322
 323 /**
 324  * Form the OCEntityHandlerRequest struct that is passed to a resource's entity handler
 325  *
 326  * @param entityHandlerRequest - pointer to the OCEntityHandlerRequest struct that is created.
 327  *                              Required to be zero-initialized before calling this function.
 328  * @param request          - request handle
 329  * @param method           - RESTful method
 330  * @param resource         - resource handle
 331  * @param queryBuf         - resource query of request
 332  * @param bufReqPayload    - JSON payload of request
 333  * @param numVendorOptions - number of vendor options
 334  * @param vendorOptions    - vendor options
 335  * @param observeAction    - observe action flag
 336  * @param observeID        - observe ID
 337  *
 338  * @return
 339  *     OCStackResult
 340  */
 341 OCStackResult FormOCEntityHandlerRequest(
 342         OCEntityHandlerRequest * entityHandlerRequest,
 343         OCRequestHandle request,
 344         OCMethod method,
 345         OCResourceHandle resource,
 346         char * queryBuf,
 347         char * bufReqPayload,
 348         uint8_t numVendorOptions,
 349         OCHeaderOption * vendorOptions,
 350         OCObserveAction observeAction,
 351         OCObservationId observeID)
 352 {
 353     if (entityHandlerRequest)
 354     {
 355         entityHandlerRequest->resource = (OCResourceHandle) resource;
 356         entityHandlerRequest->requestHandle = request;
 357         entityHandlerRequest->method = method;
 358         entityHandlerRequest->query = queryBuf;
 359         entityHandlerRequest->obsInfo.action = observeAction;
 360         entityHandlerRequest->obsInfo.obsId = observeID;
 361         entityHandlerRequest->numRcvdVendorSpecificHeaderOptions = numVendorOptions;
 362         entityHandlerRequest->rcvdVendorSpecificHeaderOptions = vendorOptions;
 363         entityHandlerRequest->reqJSONPayload = bufReqPayload;
 364
 365         return OC_STACK_OK;
 366     }
 367
 368     return OC_STACK_INVALID_PARAM;
 369 }
 370
 371 /**
 372  * Find a server request in the server request list and delete
 373  *
 374  * @param serverRequest - server request to find and delete
 375  */
 376 void FindAndDeleteServerRequest(OCServerRequest * serverRequest)
 377 {
 378     OCServerRequest* tmp;
 379     if(serverRequest)
 380     {
 381         LL_FOREACH(serverRequestList, tmp)
 382         {
 383             if (serverRequest == tmp)
 384             {
 385                 DeleteServerRequest(tmp);
 386                 return;
 387             }
 388         }
 389     }
 390 }
 391
 392 CAResponseResult_t ConvertEHResultToCAResult (OCEntityHandlerResult result)
 393 {
 394     CAResponseResult_t caResult = CA_BAD_REQ;
 395
 396     switch (result)
 397     {
 398         case OC_EH_OK:
 399             caResult = CA_SUCCESS;
 400             break;
 401         case OC_EH_ERROR:
 402             caResult = CA_BAD_REQ;
 403             break;
 404         case OC_EH_RESOURCE_CREATED:
 405             caResult = CA_CREATED;
 406             break;
 407         case OC_EH_RESOURCE_DELETED:
 408             caResult = CA_DELETED;
 409             break;
 410         case OC_EH_SLOW:
 411             caResult = CA_SUCCESS;
 412             break;
 413         case OC_EH_FORBIDDEN:
 414             caResult = CA_UNAUTHORIZED_REQ;
 415             break;
 416         case OC_EH_RESOURCE_NOT_FOUND:
 417             caResult = CA_NOT_FOUND;
 418             break;
 419         default:
 420             caResult = CA_BAD_REQ;
 421             break;
 422     }
 423     return caResult;
 424 }
 425
 426
 427 /**
 428  * Handler function for sending a response from a single resource
 429  *
 430  * @param ehResponse - pointer to the response from the resource
 431  *
 432  * @return
 433  *     OCStackResult
 434  */
 435
 436 OCStackResult HandleSingleResponse(OCEntityHandlerResponse * ehResponse)
 437 {
 438     OCStackResult result = OC_STACK_ERROR;
 439     CAEndpoint_t responseEndpoint = {};
 440     CAResponseInfo_t responseInfo = {};
 441     CAHeaderOption_t* optionsPointer = NULL;
 442
 443     if(!ehResponse || !ehResponse->requestHandle)
 444     {
 445         return OC_STACK_ERROR;
 446     }
 447
 448     OC_LOG_V(INFO, TAG, "Inside HandleSingleResponse: %s", ehResponse->payload);
 449
 450     if(ehResponse->payloadSize >= (MAX_RESPONSE_LENGTH))// - OC_JSON_PREFIX_LEN - OC_JSON_SUFFIX_LEN))
 451     {
 452         OC_LOG_V(ERROR, TAG, "Response payload size was too large.  Max is %hu, payload size was %hu",
 453                 (MAX_RESPONSE_LENGTH - OC_JSON_PREFIX_LEN - OC_JSON_SUFFIX_LEN), ehResponse->payloadSize);
 454         return OC_STACK_INVALID_PARAM;
 455     }
 456
 457     OCServerRequest *serverRequest = (OCServerRequest *)ehResponse->requestHandle;
 458
 459     CopyDevAddrToEndpoint(&serverRequest->devAddr, &responseEndpoint);
 460
 461     responseInfo.info.resourceUri = serverRequest->resourceUrl;
 462     responseInfo.result = ConvertEHResultToCAResult(ehResponse->ehResult);
 463
 464     if(serverRequest->notificationFlag && serverRequest->qos == OC_HIGH_QOS)
 465     {
 466         responseInfo.info.type = CA_MSG_CONFIRM;
 467     }
 468     else if(serverRequest->notificationFlag && serverRequest->qos != OC_HIGH_QOS)
 469     {
 470         responseInfo.info.type = CA_MSG_NONCONFIRM;
 471     }
 472     else if(!serverRequest->notificationFlag && !serverRequest->slowFlag &&
 473             serverRequest->qos == OC_HIGH_QOS)
 474     {
 475         responseInfo.info.type = CA_MSG_ACKNOWLEDGE;
 476     }
 477     else if(!serverRequest->notificationFlag && serverRequest->slowFlag &&
 478             serverRequest->qos == OC_HIGH_QOS)
 479     {
 480         responseInfo.info.type = CA_MSG_CONFIRM;
 481     }
 482     else if(!serverRequest->notificationFlag)
 483     {
 484         responseInfo.info.type = CA_MSG_NONCONFIRM;
 485     }
 486
 487     responseInfo.info.messageId = serverRequest->coapID;
 488     responseInfo.info.token = (CAToken_t)OICMalloc(CA_MAX_TOKEN_LEN+1);
 489     if (!responseInfo.info.token)
 490     {
 491         OC_LOG(FATAL, TAG, "Response Info Token is NULL");
 492         return result;
 493     }
 494
 495     memcpy(responseInfo.info.token, serverRequest->requestToken, serverRequest->tokenLength);
 496     responseInfo.info.tokenLength = serverRequest->tokenLength;
 497
 498     if(serverRequest->observeResult == OC_STACK_OK)
 499     {
 500         responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions + 1;
 501     }
 502     else
 503     {
 504         responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions;
 505     }
 506
 507     if(responseInfo.info.numOptions > 0)
 508     {
 509         responseInfo.info.options = (CAHeaderOption_t *)
 510                                       OICCalloc(responseInfo.info.numOptions,
 511                                               sizeof(CAHeaderOption_t));
 512
 513         if(!responseInfo.info.options)
 514         {
 515             OC_LOG(FATAL, TAG, PCF("options is NULL"));
 516             OICFree(responseInfo.info.token);
 517             return OC_STACK_NO_MEMORY;
 518         }
 519
 520         optionsPointer = responseInfo.info.options;
 521
 522         // TODO: This exposes CoAP specific details.  At some point, this should be
 523         // re-factored and handled in the CA layer.
 524         if(serverRequest->observeResult == OC_STACK_OK)
 525         {
 526             responseInfo.info.options[0].protocolID = CA_COAP_ID;
 527             responseInfo.info.options[0].optionID = COAP_OPTION_OBSERVE;
 528             responseInfo.info.options[0].optionLength = sizeof(uint32_t);
 529             memcpy(responseInfo.info.options[0].optionData,
 530                     &(serverRequest->observationOption), sizeof(uint32_t));
 531
 532             // Point to the next header option before copying vender specific header options
 533             optionsPointer += 1;
 534         }
 535
 536         if (ehResponse->numSendVendorSpecificHeaderOptions)
 537         {
 538             memcpy(optionsPointer, ehResponse->sendVendorSpecificHeaderOptions,
 539                             sizeof(OCHeaderOption) *
 540                             ehResponse->numSendVendorSpecificHeaderOptions);
 541         }
 542     }
 543     else
 544     {
 545         responseInfo.info.options = NULL;
 546     }
 547
 548     char payload[MAX_RESPONSE_LENGTH + OC_JSON_PREFIX_LEN + OC_JSON_SUFFIX_LEN + 1] = {};
 549
 550     // Put the JSON prefix and suffix around the payload
 551     OICStrcpy(payload, sizeof(payload), OC_JSON_PREFIX);
 552     if(ehResponse->payloadSize)
 553     {
 554         OICStrcatPartial(payload, sizeof(payload),
 555             ehResponse->payload,
 556             ehResponse->payloadSize < MAX_RESPONSE_LENGTH ?
 557             ehResponse->payloadSize : MAX_RESPONSE_LENGTH);
 558     }
 559     OICStrcat(payload, sizeof(payload), OC_JSON_SUFFIX);
 560     responseInfo.info.payload = (CAPayload_t)payload;
 561
 562     #ifdef WITH_PRESENCE
 563     //TODO: Add other connectivity types to CAConnTypes[] when enabled
 564     CATransportAdapter_t CAConnTypes[] = {CA_ADAPTER_IP};
 565     const char * connTypes[] = {"ip transport"};
 566     int size = sizeof(CAConnTypes)/ sizeof(CATransportAdapter_t);
 567     CATransportAdapter_t adapter = responseEndpoint.adapter;
 568     CAResult_t caResult = CA_STATUS_FAILED;
 569     result = OC_STACK_OK;
 570
 571     //Sending response on all n/w interfaces
 572     for(int i = 0; i < size; i++ )
 573     {
 574         responseEndpoint.adapter = (CATransportAdapter_t)(adapter & CAConnTypes[i]);
 575         if(responseEndpoint.adapter)
 576         {
 577             //The result is set to OC_STACK_OK only if CASendResponse succeeds in sending the
 578             //response on all the n/w interfaces else it is set to OC_STACK_ERROR
 579             caResult = CASendResponse(&responseEndpoint, &responseInfo);
 580             if(caResult != CA_STATUS_OK)
 581             {
 582                 OC_LOG_V(ERROR, TAG, "CASendResponse failed on %s", connTypes[i]);
 583                 result = CAResultToOCResult(caResult);
 584             }
 585             else
 586             {
 587                 OC_LOG_V(INFO, TAG, "CASendResponse succeeded on %s", connTypes[i]);
 588             }
 589         }
 590     }
 591     #else
 592     CAResult_t caResult = CASendResponse(&responseEndpoint, &responseInfo);
 593     if(caResult != CA_STATUS_OK)
 594     {
 595         OC_LOG(ERROR, TAG, PCF("CASendResponse failed"));
 596         result = CAResultToOCResult(caResult);
 597     }
 598     else
 599     {
 600         result = OC_STACK_OK;
 601     }
 602     #endif
 603
 604     OICFree(responseInfo.info.token);
 605     OICFree(responseInfo.info.options);
 606     //Delete the request
 607     FindAndDeleteServerRequest(serverRequest);
 608     return result;
 609 }
 610
 611 /**
 612  * Handler function for sending a response from multiple resources, such as a collection.
 613  * Aggregates responses from multiple resource until all responses are received then sends the
 614  * concatenated response
 615  *
 616  * TODO: Need to add a timeout in case a (remote?) resource does not respond
 617  *
 618  * @param ehResponse - pointer to the response from the resource
 619  *
 620  * @return
 621  *     OCStackResult
 622  */
 623 OCStackResult HandleAggregateResponse(OCEntityHandlerResponse * ehResponse)
 624 {
 625     OCStackResult stackRet = OC_STACK_ERROR;
 626     OCServerRequest * serverRequest = NULL;
 627     OCServerResponse * serverResponse = NULL;
 628     uint16_t bufferNeeded = 0;
 629
 630     if(!ehResponse || !ehResponse->payload)
 631     {
 632         OC_LOG(ERROR, TAG, PCF("HandleAggregateResponse invalid parameters"));
 633         return OC_STACK_INVALID_PARAM;
 634     }
 635
 636     OC_LOG_V(INFO, TAG, "Inside HandleAggregateResponse: %s", ehResponse->payload);
 637
 638     serverRequest = GetServerRequestUsingHandle((OCServerRequest *)ehResponse->requestHandle);
 639     serverResponse = GetServerResponseUsingHandle((OCServerRequest *)ehResponse->requestHandle);
 640
 641     if(serverRequest)
 642     {
 643         if(!serverResponse)
 644         {
 645             OC_LOG(INFO, TAG, PCF("This is the first response fragment"));
 646             stackRet = AddServerResponse(&serverResponse, ehResponse->requestHandle);
 647             if (OC_STACK_OK != stackRet)
 648             {
 649                 OC_LOG(ERROR, TAG, PCF("Error adding server response"));
 650                 return stackRet;
 651             }
 652             VERIFY_NON_NULL(serverResponse);
 653             VERIFY_NON_NULL(serverResponse->payload);
 654         }
 655
 656         // If there is more than 1 response, then we need to allow for a null-termination
 657         // in the server response payload buffer AND the JSON response separator
 658         bufferNeeded = ehResponse->payloadSize + 1;
 659         if (serverRequest->numResponses > 1)
 660         {
 661             bufferNeeded += strlen(OC_JSON_SEPARATOR_STR);
 662         }
 663         if(serverResponse->remainingPayloadSize >= bufferNeeded)
 664         {
 665             OC_LOG(ERROR, TAG, PCF("There is room in response buffer"));
 666             // append
 667             // allocated size of the payload is assumed, since a search of the code
 668             // shows that it is OICCalloc'ed to this size in AddServerResponse above
 669             OICStrcatPartial(serverResponse->payload,
 670                     MAX_RESPONSE_LENGTH,
 671                     ehResponse->payload,
 672                     serverResponse->remainingPayloadSize);
 673             OC_LOG_V(INFO, TAG, "Current aggregated response  ...%s", serverResponse->payload);
 674             serverResponse->remainingPayloadSize -= strlen((char *)ehResponse->payload);
 675             (serverRequest->numResponses)--;
 676             if(serverRequest->numResponses == 0)
 677             {
 678                 OC_LOG(INFO, TAG, PCF("This is the last response fragment"));
 679                 ehResponse->payload = serverResponse->payload;
 680                 ehResponse->payloadSize = strlen((char *) serverResponse->payload) + 1;
 681                 stackRet = HandleSingleResponse(ehResponse);
 682                 //Delete the request and response
 683                 FindAndDeleteServerRequest(serverRequest);
 684                 FindAndDeleteServerResponse(serverResponse);
 685             }
 686             else
 687             {
 688                 OC_LOG(INFO, TAG, PCF("More response fragments to come"));
 689                 OICStrcatPartial(serverResponse->payload,
 690                         MAX_RESPONSE_LENGTH,
 691                         OC_JSON_SEPARATOR_STR,
 692                         serverResponse->remainingPayloadSize);
 693                 OC_LOG_V(INFO, TAG, "Current aggregated response  ...%s", serverResponse->payload);
 694                 serverResponse->remainingPayloadSize -= strlen(OC_JSON_SEPARATOR_STR);
 695                 stackRet = OC_STACK_OK;
 696             }
 697         }
 698         else
 699         {
 700             OC_LOG(ERROR, TAG, PCF("No room in response buffer"));
 701             //Delete the request and response
 702             FindAndDeleteServerRequest(serverRequest);
 703             FindAndDeleteServerResponse(serverResponse);
 704             stackRet = OC_STACK_NO_MEMORY;
 705         }
 706     }
 707 exit:
 708     return stackRet;
 709 }
 710