vshl-capabilities:

This API is responsible for brokering capbilities related
messages from voiceagents to apps and vice versa.

Verbs exposed are

navigation/publish
navigation/subscribe
phonecontrol/publish
phonecontrol/subscribe
playbackcontroller/publish
playbackcontroller/subscribe
guiMetadata/publish
guiMetadata/subscribe

This API exposes publish and subscribe methods for all
the speech framework domains/capabilities. For eg. navigation,
phonecontrol etc. This API is used by apps and low level voice
agent binding to subscribe and publish these capability messages
whenever applicable.
This specific commit is for vshl-capabilities API.

Change-Id: I822c2e8589e39574d707a7c199bea91a686dced7
Signed-off-by: Naveen Bobbili  <nbobbili@amazon.com>

4 files changed, 243 insertions, 0 deletions

diff --git a/src/plugins/utilities/events/EventRouter.cpp b/src/plugins/utilities/events/EventRouter.cpp
new file mode 100644
index 0000000..e715ca8
--- /dev/null
+++ b/src/plugins/utilities/events/EventRouter.cpp
@@ -0,0 +1,68 @@
+/*
+ * Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file 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.
+ */
+#include "utilities/events/EventRouter.h"
+
+static string TAG = "vshlcapabilities::utilities::events::EventRouter";
+
+using Level = vshlcapabilities::common::interfaces::ILogger::Level;
+
+namespace vshlcapabilities {
+namespace utilities {
+namespace events {
+
+unique_ptr<EventRouter> EventRouter::create(shared_ptr<vshlcapabilities::common::interfaces::ILogger> logger) {
+    return std::unique_ptr<EventRouter>(new EventRouter(logger));
+}
+
+EventRouter::EventRouter(shared_ptr<vshlcapabilities::common::interfaces::ILogger> logger) : mLogger(logger) {
+}
+
+EventRouter::~EventRouter() {
+    mEventFilters.clear();
+}
+
+bool EventRouter::handleIncomingEvent(const string eventName, const string voiceAgentId, const string payload) {
+    for (auto eventFilter : mEventFilters) {
+        if (eventFilter->onIncomingEvent(eventName, voiceAgentId, payload)) {
+            return true;
+        }
+    }
+
+    return false;
+}
+
+bool EventRouter::addEventFilter(shared_ptr<vshlcapabilities::common::interfaces::IEventFilter> filter) {
+    if (!filter) {
+        mLogger->log(Level::ERROR, TAG, "Failed to add event filter. Invalid arguments.");
+        return false;
+    }
+
+    mEventFilters.insert(filter);
+    return true;
+}
+
+bool EventRouter::removeEventFilter(shared_ptr<vshlcapabilities::common::interfaces::IEventFilter> filter) {
+    if (!filter) {
+        mLogger->log(Level::ERROR, TAG, "Failed to add remove filter. Invalid arguments.");
+        return false;
+    }
+
+    mEventFilters.erase(filter);
+    return true;
+}
+
+}  // namespace events
+}  // namespace utilities
+}  // namespace vshl
diff --git a/src/plugins/utilities/events/EventRouter.h b/src/plugins/utilities/events/EventRouter.h
new file mode 100644
index 0000000..1286128
--- /dev/null
+++ b/src/plugins/utilities/events/EventRouter.h
@@ -0,0 +1,66 @@
+/*
+ * Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file 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 VSHL_UTILITIES_EVENTS_EVENTMANAGER_H_
+#define VSHL_UTILITIES_EVENTS_EVENTMANAGER_H_
+
+#include <memory>
+#include <string>
+#include <unordered_set>
+
+#include "interfaces/utilities/events/IEventFilter.h"
+#include "interfaces/utilities/logging/ILogger.h"
+
+using namespace std;
+
+namespace vshlcapabilities {
+namespace utilities {
+namespace events {
+/*
+ * This class is responsible for routing incoming events to
+ * the appropriate event listener for consumption.
+ * Note: The listeners should implement the IEventFilter class.
+ */
+class EventRouter {
+public:
+    static unique_ptr<EventRouter> create(shared_ptr<vshlcapabilities::common::interfaces::ILogger> logger);
+
+    // Destructor
+    ~EventRouter();
+
+    // Add event filter as listerner.
+    bool addEventFilter(shared_ptr<vshlcapabilities::common::interfaces::IEventFilter> filter);
+
+    // Remove event filter as listerner.
+    bool removeEventFilter(shared_ptr<vshlcapabilities::common::interfaces::IEventFilter> filter);
+
+    // This method is called by the controller for routing
+    // the event to appropriate listener.
+    bool handleIncomingEvent(const string eventName, const string voiceAgentId, const string payload);
+
+private:
+    EventRouter(shared_ptr<vshlcapabilities::common::interfaces::ILogger> logger);
+
+    // set of event filters.
+    unordered_set<shared_ptr<vshlcapabilities::common::interfaces::IEventFilter>> mEventFilters;
+
+    // Logger
+    shared_ptr<vshlcapabilities::common::interfaces::ILogger> mLogger;
+};
+
+}  // namespace events
+}  // namespace utilities
+}  // namespace vshl
+
+#endif  // VSHL_UTILITIES_EVENTS_EVENTROUTER_H_
diff --git a/src/plugins/utilities/logging/Logger.cpp b/src/plugins/utilities/logging/Logger.cpp
new file mode 100644
index 0000000..c121556
--- /dev/null
+++ b/src/plugins/utilities/logging/Logger.cpp
@@ -0,0 +1,56 @@
+/*
+ * Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file 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.
+ */
+#include "utilities/logging/Logger.h"
+
+namespace vshlcapabilities {
+namespace utilities {
+namespace logging {
+
+// Constructor
+Logger::Logger(AFB_ApiT api) {
+    mApi = api;
+}
+
+unique_ptr<Logger> Logger::create(AFB_ApiT api) {
+    auto logger = std::unique_ptr<Logger>(new Logger(api));
+    return logger;
+}
+
+void Logger::log(Level level, const std::string& tag, const std::string& message) {
+    string format_msg = "Tag: " + tag + ", message: " + message;
+    switch (level) {
+        case Level::NOTICE:
+            AFB_ApiNotice(mApi, format_msg.c_str());
+            break;
+        case Level::WARNING:
+            AFB_ApiWarning(mApi, format_msg.c_str());
+            break;
+        case Level::DEBUG:
+            AFB_ApiDebug(mApi, format_msg.c_str());
+            break;
+        case Level::ERROR:
+            AFB_ApiError(mApi, format_msg.c_str());
+            break;
+        case Level::INFO:
+            AFB_ApiInfo(mApi, format_msg.c_str());
+            break;
+        default:
+            break;
+    }
+}
+
+}  // namespace logging
+}  // namespace utilities
+}  // namespace vshl
diff --git a/src/plugins/utilities/logging/Logger.h b/src/plugins/utilities/logging/Logger.h
new file mode 100644
index 0000000..56f810d
--- /dev/null
+++ b/src/plugins/utilities/logging/Logger.h
@@ -0,0 +1,53 @@
+/*
+ * Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file 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 VSHL_UTILITIES_LOGGING_LOGGER_H_
+#define VSHL_UTILITIES_LOGGING_LOGGER_H_
+
+#include <memory>
+
+extern "C" {
+#define AFB_BINDING_VERSION 3
+#include "afb-definitions.h"
+#include "ctl-plugin.h"
+};
+
+#include "interfaces/utilities/logging/ILogger.h"
+
+using namespace std;
+
+namespace vshlcapabilities {
+namespace utilities {
+namespace logging {
+
+class Logger : public vshlcapabilities::common::interfaces::ILogger {
+public:
+  static std::unique_ptr<Logger> create(AFB_ApiT api);
+
+  // ILogger interface
+  void log(Level level, const std::string &tag,
+           const std::string &message) override;
+
+private:
+  Logger(AFB_ApiT api);
+
+  // Binding API reference
+  AFB_ApiT mApi;
+};
+
+} // namespace logging
+} // namespace utilities
+} // namespace vshl
+
+#endif // VSHL_UTILITIES_LOGGING_LOGGER_H_