summaryrefslogtreecommitdiff
path: root/src/components/application_manager/include/application_manager/app_service_manager.h
blob: 47a60780bc3b39706114add4ad0aede8803a030e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
/*
 * Copyright (c) 2018, 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_APP_SERVICE_MANAGER_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_APP_SERVICE_MANAGER_H_

#include "application_manager/application.h"
#include "application_manager/rpc_passing_handler.h"
#include "interfaces/MOBILE_API.h"
#include "smart_objects/smart_object.h"

namespace resumption {
class LastState;
}

namespace application_manager {

struct AppService {
  uint32_t connection_key;
  bool mobile_service;
  bool default_service = false;
  smart_objects::SmartObject record;
};

class RPCPassingHandler;
class ApplicationManager;
/**
 * @brief The AppServiceManager is TODO.
 */
class AppServiceManager {
 public:
  const std::string kEmbeddedService = "EMBEDDED_SERVICE";

  /**
   * @brief Class constructor
   * @param app_manager
   */
  AppServiceManager(ApplicationManager& app_manager,
                    resumption::LastState& last_state);

  /**
   * @brief Class destructor
   */
  virtual ~AppServiceManager();

  /**
   * @brief TODO
   * @param manifest
   */
  virtual smart_objects::SmartObject PublishAppService(
      const smart_objects::SmartObject& manifest,
      const bool mobile_service,
      const uint32_t connection_key);

  /**
   * @brief TODO
   * @param service_id
   */
  virtual bool UnpublishAppService(const std::string service_id);

  virtual void OnAppActivated(ApplicationConstSharedPtr app);

  /**
   * @brief TODO
   * @param connection_key
   */
  virtual void UnpublishServices(const uint32_t connection_key);

  /**
   * @brief TODO
   * @param service_id
   */
  virtual bool SetDefaultService(const std::string service_id);

  /**
   * @brief TODO
   * @param service_id
   */
  virtual bool RemoveDefaultService(const std::string service_id);

  /**
   * @brief TODO
   * @param service_id
   */
  virtual bool ActivateAppService(const std::string service_id);

  /**
   * @brief TODO
   * @param service_id
   */
  virtual bool DeactivateAppService(const std::string service_id);

  /**
   * @brief TODO
   * @param manifest
   */
  virtual std::vector<smart_objects::SmartObject> GetAllServiceRecords();
  virtual std::vector<std::pair<std::string, AppService> > GetActiveServices();

  virtual void GetProviderByType(const std::string& service_type,
                                 const bool mobile_consumer,
                                 ApplicationSharedPtr& app,
                                 bool& hmi_service);

  virtual void GetProviderByID(const std::string& service_id,
                               const bool mobile_consumer,
                               ApplicationSharedPtr& app,
                               bool& hmi_service);

  virtual AppService* ActiveServiceForType(const std::string service_type);

  virtual AppService* EmbeddedServiceForType(const std::string service_type);

  AppService* FindServiceByName(const std::string name);

  virtual AppService* FindServiceByID(const std::string service_id);

  virtual std::string DefaultServiceByType(const std::string service_type);

  /**
   * @brief TODO
   * @param service_id
   * @param service_published
   */
  virtual void SetServicePublished(const std::string service_id,
                                   bool service_published);

  /**
   * @brief TODO
   * @param out_params
   */
  virtual bool UpdateNavigationCapabilities(
      smart_objects::SmartObject& out_params);

  virtual RPCPassingHandler& GetRPCPassingHandler();

 private:
  ApplicationManager& app_manager_;
  resumption::LastState& last_state_;

  sync_primitives::RecursiveLock published_services_lock_;
  std::map<std::string, AppService> published_services_;
  RPCPassingHandler rpc_passing_handler_;

  void AppServiceUpdated(
      const smart_objects::SmartObject& service_record,
      const mobile_apis::ServiceUpdateReason::eType update_reason,
      smart_objects::SmartObject& msg_params);
  void GetProviderFromService(const AppService& service,
                              const bool mobile_consumer,
                              ApplicationSharedPtr& app,
                              bool& hmi_service);
  AppService* FindServiceByPolicyAppID(const std::string policy_app_id,
                                       const std::string type);
  std::string GetPolicyAppID(AppService service);
};

}  //  namespace application_manager

#endif  // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_APP_SERVICE_MANAGER_H_