Feature/947 v2 entities

CHANGES_NEXT_RELEASE

@@ -1 +1,2 @@
 Fix: Fixed a bug about pagination problem due to missing ErrorCode with details in the case of queries with forwarding to context providers.  (Issue #945)
+Add: New convop "GET /v2/entities" (Issue #947)

CMakeLists.txt

@@ -158,10 +158,12 @@ if (error EQUAL 0)
   ADD_SUBDIRECTORY(src/lib/orionTypes)
   ADD_SUBDIRECTORY(src/lib/ngsi)
   ADD_SUBDIRECTORY(src/lib/serviceRoutines)
+  ADD_SUBDIRECTORY(src/lib/serviceRoutinesV2)
   ADD_SUBDIRECTORY(src/lib/convenience)
   ADD_SUBDIRECTORY(src/lib/ngsi9)
   ADD_SUBDIRECTORY(src/lib/ngsi10)
   ADD_SUBDIRECTORY(src/lib/ngsiNotify)
+  ADD_SUBDIRECTORY(src/lib/apiTypesV2)
   ADD_SUBDIRECTORY(src/lib/parse)
   ADD_SUBDIRECTORY(src/lib/jsonParse)
   ADD_SUBDIRECTORY(src/lib/xmlParse)

src/app/contextBroker/CMakeLists.txt

@@ -31,10 +31,12 @@ SET (STATIC_LIBS
     mongoBackend
     ngsiNotify
     serviceRoutines
+    serviceRoutinesV2
     mongoBackend
     rest
     jsonParse
     xmlParse
+    apiTypesV2
     convenience
     ngsi9
     ngsi10

src/app/contextBroker/contextBroker.cpp

@@ -171,6 +171,9 @@
 #include "serviceRoutines/badNgsi9Request.h"
 #include "serviceRoutines/badNgsi10Request.h"
 #include "serviceRoutines/badRequest.h"
+
+#include "serviceRoutinesV2/getEntities.h"
+
 #include "contextBroker/version.h"
 
 #include "common/string.h"
@@ -324,6 +327,13 @@ PaArgument paArgs[] =
 */
 
 
+//
+// /v2 conv-ops 
+//
+#define ENT                EntitiesRequest
+#define ENT_COMPS_V2       2, { "v2", "entities" }
+#define ENT_COMPS_WORD     ""
+
 //
 // NGSI9
 //
@@ -569,6 +579,12 @@ PaArgument paArgs[] =
 
 
 
+#define CONVENIENCE_OPERATIONS_V2                                                                        \
+  { "GET",    ENT,   ENT_COMPS_V2,         ENT_COMPS_WORD,  getEntities                               }, \
+  { "*",      ENT,   ENT_COMPS_V2,         ENT_COMPS_WORD,  badVerbGetOnly                            }
+
+
+
 #define REGISTRY_STANDARD_REQUESTS_V0                                                                    \
   { "POST",   RCR,   RCR_COMPS_V0,         RCR_POST_WORD,   postRegisterContext                       }, \
   { "*",      RCR,   RCR_COMPS_V0,         RCR_POST_WORD,   badVerbPostOnly                           }, \
@@ -899,6 +915,8 @@ PaArgument paArgs[] =
 */
 RestService restServiceV[] =
 {
+  CONVENIENCE_OPERATIONS_V2,
+
   REGISTRY_STANDARD_REQUESTS_V0,
   REGISTRY_STANDARD_REQUESTS_V1,
   STANDARD_REQUESTS_V0,

src/lib/apiTypesV2/CMakeLists.txt

@@ -0,0 +1,44 @@
+# Copyright 2015 Telefonica Investigacion y Desarrollo, S.A.U
+#
+# This file is part of Orion Context Broker.
+#
+# Orion Context Broker is free software: you can redistribute it and/or
+# modify it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# Orion Context Broker is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
+# General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Orion Context Broker. If not, see http://www.gnu.org/licenses/.
+#
+# For those usages not covered by this license please contact with
+# iot_support at tid dot es
+
+CMAKE_MINIMUM_REQUIRED(VERSION 2.6)
+
+SET (SOURCES
+    Entity.cpp
+    EntityVector.cpp
+    Entities.cpp
+)
+
+SET (HEADERS
+    Entity.h
+    EntityVector.h
+    Entities.h
+)
+
+
+
+# Include directories
+# -----------------------------------------------------------------
+include_directories("${PROJECT_SOURCE_DIR}/src/lib")
+
+
+# Library declaration
+# -----------------------------------------------------------------
+ADD_LIBRARY(apiTypesV2 STATIC ${SOURCES} ${HEADERS})

src/lib/apiTypesV2/Entities.cpp

@@ -0,0 +1,136 @@
+/*
+*
+* Copyright 2015 Telefonica Investigacion y Desarrollo, S.A.U
+*
+* This file is part of Orion Context Broker.
+*
+* Orion Context Broker is free software: you can redistribute it and/or
+* modify it under the terms of the GNU Affero General Public License as
+* published by the Free Software Foundation, either version 3 of the
+* License, or (at your option) any later version.
+*
+* Orion Context Broker is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
+* General Public License for more details.
+*
+* You should have received a copy of the GNU Affero General Public License
+* along with Orion Context Broker. If not, see http://www.gnu.org/licenses/.
+*
+* For those usages not covered by this license please contact with
+* iot_support at tid dot es
+*
+* Author: Ken Zangelin
+*/
+#include <string>
+#include <vector>
+
+#include "ngsi10/QueryContextResponse.h"
+#include "apiTypesV2/Entities.h"
+
+
+
+/* ****************************************************************************
+*
+* Entities::Entities - 
+*/
+Entities::Entities()
+{
+  errorCode.fill(SccOk);
+}
+
+
+
+/* ****************************************************************************
+*
+* Entities::~Entities - 
+*/
+Entities::~Entities()
+{
+  release();
+}
+
+
+
+/* ****************************************************************************
+*
+* Entities::render - 
+*
+* If no error reported in errorCode, render the vector of entities.
+* Otherwise, render the errorCode.
+*/
+std::string Entities::render(ConnectionInfo* ciP, RequestType requestType)
+{
+  if ((errorCode.code == SccOk) || (errorCode.code == SccNone))
+  {
+    return vec.render(ciP, requestType, false);
+  }
+
+  return errorCode.renderV2();
+} 
+
+
+
+/* ****************************************************************************
+*
+* Entities::check - 
+*
+* NOTE
+*   The 'check' method is normally only used to check that incoming payload is correct.
+*   For now (at least), the Entities type is only used as outgoing payload ...
+*/
+std::string Entities::check(ConnectionInfo* ciP, RequestType requestType)
+{
+  return vec.check(ciP, requestType);
+}
+
+
+
+/* ****************************************************************************
+*
+* Entities::present - 
+*/
+void Entities::present(const std::string& indent)
+{
+  LM_F(("%s%d Entities:", indent.c_str(), vec.size()));
+  vec.present(indent + "  ");
+}
+
+
+
+/* ****************************************************************************
+*
+* Entities::release - 
+*/
+void Entities::release(void)
+{
+  vec.release();
+}
+
+
+
+/* ****************************************************************************
+*
+* Entities::fill - 
+*/
+void Entities::fill(QueryContextResponse* qcrsP)
+{
+  if (qcrsP->errorCode.code != SccOk)
+  {
+    errorCode.fill(qcrsP->errorCode);
+    return;
+  }
+
+  for (unsigned int ix = 0; ix < qcrsP->contextElementResponseVector.size(); ++ix)
+  {
+    ContextElement* ceP = &qcrsP->contextElementResponseVector[ix]->contextElement;
+    Entity*         eP  = new Entity();
+
+    eP->id        = ceP->entityId.id;
+    eP->type      = ceP->entityId.type;
+    eP->isPattern = ceP->entityId.isPattern;
+
+    eP->attributeVector.fill(&ceP->contextAttributeVector);
+    vec.push_back(eP);
+  }
+}

src/lib/apiTypesV2/Entities.h

@@ -0,0 +1,57 @@
+#ifndef SRC_LIB_APITYPESV2_ENTITIES_H_
+#define SRC_LIB_APITYPESV2_ENTITIES_H_
+
+/*
+*
+* Copyright 2015 Telefonica Investigacion y Desarrollo, S.A.U
+*
+* This file is part of Orion Context Broker.
+*
+* Orion Context Broker is free software: you can redistribute it and/or
+* modify it under the terms of the GNU Affero General Public License as
+* published by the Free Software Foundation, either version 3 of the
+* License, or (at your option) any later version.
+*
+* Orion Context Broker is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
+* General Public License for more details.
+*
+* You should have received a copy of the GNU Affero General Public License
+* along with Orion Context Broker. If not, see http://www.gnu.org/licenses/.
+*
+* For those usages not covered by this license please contact with
+* iot_support at tid dot es
+*
+* Author: Ken Zangelin
+*/
+#include <string>
+#include <vector>
+
+#include "apiTypesV2/EntityVector.h"
+#include "ngsi/StatusCode.h"
+
+
+struct QueryContextResponse;
+
+/* ****************************************************************************
+*
+* Entities - 
+*/
+class Entities
+{
+public:
+  EntityVector vec;          // Optional - mandatory if 200-OK
+  StatusCode   errorCode;    // Optional - mandatory if not 200-OK
+
+  Entities();
+  ~Entities();
+
+  std::string  render(ConnectionInfo* ciP, RequestType requestType);
+  std::string  check(ConnectionInfo*  ciP, RequestType requestType);
+  void         present(const std::string& indent);
+  void         release(void);
+  void         fill(QueryContextResponse* qcrsP);
+};
+
+#endif  // SRC_LIB_APITYPESV2_ENTITIES_H_