RIC-641 Fixing client/server model definitions and adding client and server API

[ric-plt/xapp-frame-cpp.git] / src / model / SubscriptionInstance.h

diff --git a/src/model/SubscriptionInstance.h b/src/model/SubscriptionInstance.h
new file mode 100644 (file)
index 0000000..baff74f
--- /dev/null
+++ b/src/model/SubscriptionInstance.h
@@ -0,0 +1,81 @@
+/*
+# ==================================================================================
+# Copyright (c) 2020 HCL Technologies Limited.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==================================================================================
+*/
+#ifndef SubscriptionInstance_H
+#define SubscriptionInstance_H
+#include"ModelBase.h"
+
+namespace xapp
+{
+       namespace model
+       {
+               struct SubscriptionInstance : public ModelBase
+               {
+               public:
+                       nlohmann::json validator_schema = R"(
+                       {
+                       "$schema": "http://json-schema.org/draft-07/schema#",
+                       "title": "SubscriptionInstance",
+                       "description": "xApp service address and port",
+                       "properties": {
+                           "XappEventInstanceId": {
+                               "type": "integer",
+                               "minimum": 0,
+                               "maximum": 65535
+                           },
+                           "E2EventInstanceId": {
+                               "type": "integer",
+                               "minimum": 0,
+                               "maximum": 65535
+                           },
+                           "ErrorCause": {
+                               "description": "Descriptive error cause. Empty string when no error.",
+                               "type": "string"
+                           },
+                           "ErrorSource": {
+                               "description": "Source of error cause.",
+                               "type": "string",
+                               "enum": ["SUBMGR", "RTMGR", "DBAAS", "ASN1", "E2Node"]
+                           },
+                           "TimeoutType": {
+                               "description": "Type timeout. xApp should retry if timeout occurs.",
+                               "type": "string",
+                               "enum": ["E2-Timeout", "RTMGR-Timeout", "DBAAS-Timeout"]
+                           }
+                       },
+                       "required": [
+                                    "XappEventInstanceId",
+                                    "E2EventInstanceId"
+                                    ],
+                       "type": "object"
+                       })"_json;
+                       virtual nlohmann::json get_validator_schema() const { return validator_schema; }
+                       int XappEventInstanceId{ 0 };
+                       int     E2EventInstanceId{ 0 };
+                       std::string     ErrorCause{ "" };
+                       std::string     ErrorSource{ "" };
+                       std::string     TimeoutType{ "" };
+               };
+               void from_json(const nlohmann::json& j, SubscriptionInstance& ref);
+               void from_json(const nlohmann::json& j, std::vector<SubscriptionInstance>& ref);
+               void to_json(nlohmann::json& j, const SubscriptionInstance& ref);
+               void to_json(nlohmann::json& j, const std::vector<SubscriptionInstance>& ref);
+
+       }
+       
+}
+#endif