Implement EventObserver and Event Dispatcher Split

The logic in this commit is:
1. Create EventDispatcher interface class.
2. Create EventDispatcher implementation through the interface.

APPLINK-16102

7 files changed, 160 insertions, 56 deletions

diff --git a/src/components/application_manager/include/application_manager/event_engine/event_dispatcher.h b/src/components/application_manager/include/application_manager/event_engine/event_dispatcher.h
index ff21b01c58..9c0a8b22e4 100644
--- a/src/components/application_manager/include/application_manager/event_engine/event_dispatcher.h
+++ b/src/components/application_manager/include/application_manager/event_engine/event_dispatcher.h
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2013, Ford Motor Company
+ Copyright (c) 2016, Ford Motor Company
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -46,7 +46,7 @@ namespace event_engine {
 
 class EventObserver;
 
-class EventDispatcher : public utils::Singleton<EventDispatcher> {
+class EventDispatcher {
  public:
 
   /*
@@ -54,7 +54,7 @@ class EventDispatcher : public utils::Singleton<EventDispatcher> {
    *
    * @param event Received event
    */
-  void raise_event(const Event& event);
+  virtual void raise_event(const Event& event) = 0;
 
   /*
    * @brief Subscribe the observer to event
@@ -63,9 +63,9 @@ class EventDispatcher : public utils::Singleton<EventDispatcher> {
    * @param hmi_correlation_id  The event HMI correlation ID
    * @param observer    The observer to subscribe for event
    */
-  void add_observer(const Event::EventID& event_id,
+  virtual void add_observer(const Event::EventID& event_id,
                     int32_t hmi_correlation_id,
-                    EventObserver* const observer);
+                    EventObserver* const observer) = 0;
 
   /*
    * @brief Unsubscribes the observer from specific event
@@ -73,51 +73,25 @@ class EventDispatcher : public utils::Singleton<EventDispatcher> {
    * @param event_id    The event ID to unsubscribe from
    * @param observer    The observer to be unsubscribed
    */
-  void remove_observer(const Event::EventID& event_id,
-                       EventObserver* const observer);
+  virtual void remove_observer(const Event::EventID& event_id,
+                       EventObserver* const observer) = 0;
 
   /*
    * @brief Unsubscribes the observer from all events
    *
    * @param observer  The observer to be unsubscribed
    */
-  void remove_observer(EventObserver* const observer);
-
- protected:
-
- private:
-
-  /*
-   * @brief Default constructor
-   */
-  EventDispatcher();
+  virtual void remove_observer(EventObserver* const observer) = 0;
 
   /*
    * @brief Destructor
    */
-  virtual ~EventDispatcher();
+  virtual ~EventDispatcher() {
+  };
 
-  /*
-   * @brief removes observer
-   * when occurs unsubscribe from event
-   * @param observer to be removed
-   */
-  void remove_observer_from_list(EventObserver* const observer);
-
-  DISALLOW_COPY_AND_ASSIGN(EventDispatcher);
-
-  FRIEND_BASE_SINGLETON_CLASS(EventDispatcher);
-
-  // Data types section
-  typedef std::list<EventObserver*>                   ObserverList;
-  typedef std::map<int32_t, ObserverList>             ObserversMap;
-  typedef std::map<Event::EventID, ObserversMap>      EventObserverMap;
+ protected:
 
-  // Members section
-  sync_primitives::Lock                               state_lock_;
-  sync_primitives::Lock                               observer_list_lock_;
-  EventObserverMap                                    observers_;
-  ObserverList                                        observers_list_;
+ private:
 
 };
 
diff --git a/src/components/application_manager/include/application_manager/event_engine/event_dispatcher_impl.h b/src/components/application_manager/include/application_manager/event_engine/event_dispatcher_impl.h
new file mode 100644
index 0000000000..0a19c26628
--- /dev/null
+++ b/src/components/application_manager/include/application_manager/event_engine/event_dispatcher_impl.h
@@ -0,0 +1,129 @@
+/*
+ Copyright (c) 2016, Ford Motor Company
+ All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions are met:
+
+ Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+
+ Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following
+ disclaimer in the documentation and/or other materials provided with the
+ distribution.
+
+ Neither the name of the Ford Motor Company nor the names of its contributors
+ may be used to endorse or promote products derived from this software
+ without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_EVENT_DISPATCHER_IMPL_H_
+#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_EVENT_DISPATCHER_IMPL_H_
+
+#include <list>
+#include <map>
+
+#include "utils/lock.h"
+#include "utils/singleton.h"
+
+#include "application_manager/event_engine/event.h"
+#include "application_manager/event_engine/event_dispatcher.h"
+
+namespace application_manager {
+namespace event_engine {
+
+class EventObserver;
+
+class EventDispatcherImpl : public EventDispatcher,
+  public utils::Singleton<EventDispatcherImpl> {
+ public:
+
+  /*
+   * @brief Delivers the event to all subscribers
+   *
+   * @param event Received event
+   */
+  virtual void raise_event(const Event& event);
+
+  /*
+   * @brief Subscribe the observer to event
+   *
+   * @param event_id    The event ID to subscribe for
+   * @param hmi_correlation_id  The event HMI correlation ID
+   * @param observer    The observer to subscribe for event
+   */
+  virtual void add_observer(const Event::EventID& event_id,
+                    int32_t hmi_correlation_id,
+                    EventObserver* const observer);
+
+  /*
+   * @brief Unsubscribes the observer from specific event
+   *
+   * @param event_id    The event ID to unsubscribe from
+   * @param observer    The observer to be unsubscribed
+   */
+  virtual void remove_observer(const Event::EventID& event_id,
+                       EventObserver* const observer);
+
+  /*
+   * @brief Unsubscribes the observer from all events
+   *
+   * @param observer  The observer to be unsubscribed
+   */
+  virtual void remove_observer(EventObserver* const observer);
+
+  /*
+   * @brief Destructor
+   */
+ virtual ~EventDispatcherImpl();
+
+ protected:
+
+ private:
+
+  /*
+   * @brief Default constructor
+   */
+  EventDispatcherImpl();
+
+  /*
+   * @brief removes observer
+   * when occurs unsubscribe from event
+   * @param observer to be removed
+   */
+  void remove_observer_from_list(EventObserver* const observer);
+
+  DISALLOW_COPY_AND_ASSIGN(EventDispatcherImpl);
+
+  FRIEND_BASE_SINGLETON_CLASS(EventDispatcherImpl);
+
+  // Data types section
+  typedef std::list<EventObserver*>                   ObserverList;
+  typedef std::map<int32_t, ObserverList>             ObserversMap;
+  typedef std::map<Event::EventID, ObserversMap>      EventObserverMap;
+
+  // Members section
+  sync_primitives::Lock                               state_lock_;
+  sync_primitives::Lock                               observer_list_lock_;
+  EventObserverMap                                    observers_;
+  ObserverList                                        observers_list_;
+
+};
+
+}
+}
+
+#endif  // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_EVENT_DISPATCHER_IMPL_H_
diff --git a/src/components/application_manager/include/application_manager/event_engine/event_observer.h b/src/components/application_manager/include/application_manager/event_engine/event_observer.h
index 8631203290..f9466057f2 100644
--- a/src/components/application_manager/include/application_manager/event_engine/event_observer.h
+++ b/src/components/application_manager/include/application_manager/event_engine/event_observer.h
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2013, Ford Motor Company
+ Copyright (c) 2016, Ford Motor Company
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -35,7 +35,7 @@
 
 #include <string>
 #include "application_manager/event_engine/event.h"
-#include "application_manager/event_engine/event_dispatcher.h"
+#include "application_manager/event_engine/event_dispatcher_impl.h"
 
 namespace application_manager {
 namespace event_engine {
@@ -44,7 +44,7 @@ class EventObserver
 {
  public:
 
-  friend class EventDispatcher;
+  friend class EventDispatcherImpl;
 
   // Typedef for possible Observer ID's from mobile_apis functionID enum
   typedef unsigned long ObserverID;
diff --git a/src/components/application_manager/src/event_engine/event.cc b/src/components/application_manager/src/event_engine/event.cc
index 561e8a841f..76a3f6a887 100644
--- a/src/components/application_manager/src/event_engine/event.cc
+++ b/src/components/application_manager/src/event_engine/event.cc
@@ -31,7 +31,7 @@
  */
 
 #include "application_manager/event_engine/event.h"
-#include "application_manager/event_engine/event_dispatcher.h"
+#include "application_manager/event_engine/event_dispatcher_impl.h"
 
 namespace application_manager {
 namespace event_engine {
@@ -45,7 +45,7 @@ Event::~Event() {
 }
 
 void Event::raise() {
-  EventDispatcher::instance()->raise_event(*this);
+  EventDispatcherImpl::instance()->raise_event(*this);
 }
 
 void Event::set_smart_object(const smart_objects::SmartObject& so) {
diff --git a/src/components/application_manager/src/event_engine/event_dispatcher.cc b/src/components/application_manager/src/event_engine/event_dispatcher_impl.cc
index bac94431f0..636874d023 100644
--- a/src/components/application_manager/src/event_engine/event_dispatcher.cc
+++ b/src/components/application_manager/src/event_engine/event_dispatcher_impl.cc
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2013, Ford Motor Company
+ Copyright (c) 2016, Ford Motor Company
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -32,21 +32,21 @@
 
 #include "interfaces/HMI_API.h"
 #include "application_manager/event_engine/event_observer.h"
-#include "application_manager/event_engine/event_dispatcher.h"
+#include "application_manager/event_engine/event_dispatcher_impl.h"
 
 namespace application_manager {
 namespace event_engine {
 using namespace sync_primitives;
 
-EventDispatcher::EventDispatcher()
+EventDispatcherImpl::EventDispatcherImpl()
     : observer_list_lock_(true),
       observers_() {
 }
 
-EventDispatcher::~EventDispatcher() {
+EventDispatcherImpl::~EventDispatcherImpl() {
 }
 
-void EventDispatcher::raise_event(const Event& event) {
+void EventDispatcherImpl::raise_event(const Event& event) {
   {
     AutoLock auto_lock(state_lock_);
     // check if event is notification
@@ -74,14 +74,14 @@ void EventDispatcher::raise_event(const Event& event) {
   }
 }
 
-void EventDispatcher::add_observer(const Event::EventID& event_id,
+void EventDispatcherImpl::add_observer(const Event::EventID& event_id,
                                    int32_t hmi_correlation_id,
                                    EventObserver* const observer) {
   AutoLock auto_lock(state_lock_);
   observers_[event_id][hmi_correlation_id].push_back(observer);
 }
 
-void EventDispatcher::remove_observer(const Event::EventID& event_id,
+void EventDispatcherImpl::remove_observer(const Event::EventID& event_id,
 		                              EventObserver* const observer) {
   remove_observer_from_list(observer);
   AutoLock auto_lock(state_lock_);
@@ -100,7 +100,7 @@ void EventDispatcher::remove_observer(const Event::EventID& event_id,
   }
 }
 
-void EventDispatcher::remove_observer(EventObserver* const observer) {
+void EventDispatcherImpl::remove_observer(EventObserver* const observer) {
   remove_observer_from_list(observer);
   AutoLock auto_lock(state_lock_);
   EventObserverMap::iterator event_map = observers_.begin();
@@ -121,7 +121,7 @@ void EventDispatcher::remove_observer(EventObserver* const observer) {
   }
 }
 
-void EventDispatcher::remove_observer_from_list(EventObserver* const observer) {
+void EventDispatcherImpl::remove_observer_from_list(EventObserver* const observer) {
   AutoLock auto_lock(observer_list_lock_);
   if (!observers_list_.empty()) {
     ObserverList::iterator it_begin = observers_list_.begin();
diff --git a/src/components/application_manager/src/event_engine/event_observer.cc b/src/components/application_manager/src/event_engine/event_observer.cc
index c6d81529f9..562102c7c0 100644
--- a/src/components/application_manager/src/event_engine/event_observer.cc
+++ b/src/components/application_manager/src/event_engine/event_observer.cc
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2013, Ford Motor Company
+ Copyright (c) 2016, Ford Motor Company
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -48,15 +48,15 @@ EventObserver::~EventObserver() {
 
 void EventObserver::subscribe_on_event(const Event::EventID& event_id,
                                        int32_t hmi_correlation_id) {
-  EventDispatcher::instance()->add_observer(event_id, hmi_correlation_id, this);
+  EventDispatcherImpl::instance()->add_observer(event_id, hmi_correlation_id, this);
 }
 
 void EventObserver::unsubscribe_from_event(const Event::EventID& event_id) {
-  EventDispatcher::instance()->remove_observer(event_id, this);
+  EventDispatcherImpl::instance()->remove_observer(event_id, this);
 }
 
 void EventObserver::unsubscribe_from_all_events() {
-  EventDispatcher::instance()->remove_observer(this);
+  EventDispatcherImpl::instance()->remove_observer(this);
 }
 
 }
diff --git a/src/components/application_manager/test/mock/include/application_manager/event_engine/event_dispatcher_impl.h b/src/components/application_manager/test/mock/include/application_manager/event_engine/event_dispatcher_impl.h
new file mode 120000
index 0000000000..1e76796cfe
--- /dev/null
+++ b/src/components/application_manager/test/mock/include/application_manager/event_engine/event_dispatcher_impl.h
@@ -0,0 +1 @@
+../../../../../include/application_manager/event_engine/event_dispatcher_impl.h
\ No newline at end of file