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
|
/*
* Copyright (c) 2017, 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_SERVICE_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_SERVICE_H_
#include <string>
#include <sstream>
#include <vector>
#include "application_manager/application.h"
#include "application_manager/application_manager_settings.h"
#include "application_manager/message.h"
#include "application_manager/hmi_interfaces.h"
namespace application_manager {
enum TypeAccess { kDisallowed, kAllowed };
enum MessageValidationResult {
SUCCESS = 0,
INVALID_JSON,
INVALID_METADATA,
SCHEMA_MISMATCH,
UNSUPPORTED_PROTOCOL
};
typedef std::string PluginFunctionID;
/**
* @brief Interface to core service
*/
class Service {
public:
virtual ~Service() {}
/**
* @brief Checks message permissions and cuts parameters according
* to policy table permissions
* @param msg message to cut disallowed parameters
* @return result according by mobile API
*/
virtual mobile_apis::Result::eType CheckPolicyPermissions(MessagePtr msg) = 0;
/**
* Checks if module for application is present in policy table
* @param app_id id of application
* @param module type
* @return true if module is present, otherwise - false
*/
virtual bool CheckModule(const ApplicationId& app_id,
const std::string& module) = 0;
/**
* @brief Get pointer to application by application id
* @param app_id application id
* return pointer to application
*/
virtual ApplicationSharedPtr GetApplication(ApplicationId app_id) = 0;
/**
* Removes parameters not listed in HMI API from HMI request
* @param message message to handle
*/
virtual void RemoveHMIFakeParameters(
application_manager::MessagePtr& message) = 0;
/**
* @brief Send message to HMI
* @param message Message to HMI
*/
virtual void SendMessageToHMI(const MessagePtr& message) = 0;
/**
* @brief Send message to mobile device
* @param message Message to mobile
*/
virtual void SendMessageToMobile(const MessagePtr& message) = 0;
/**
* @brief Returns unique correlation ID for next HMI request
*
* @return Unique correlation ID
*/
virtual uint32_t GetNextCorrelationID() = 0;
/**
* @brief Returns all applications related to plugin
* @param uid ID provided by plugin to its extension to app.
* @return List with shared pointers to applications
*/
virtual std::vector<ApplicationSharedPtr> GetApplications(
AppExtensionUID uid) = 0;
/**
* @brief Change hmi level of app and notify it
* @param app Application to be changed and notified
* @param level New HMI level of app
*/
virtual void ChangeNotifyHMILevel(ApplicationSharedPtr app,
mobile_apis::HMILevel::eType level) = 0;
/**
* @brief Notify HMI about app changing HMI Level
* only NONE, BACKGROUND and LIMITED levels are sent
* @param app Application to be changed and notified
* @param level New HMI level of app
*/
virtual void NotifyHMIAboutHMILevel(ApplicationSharedPtr app,
mobile_apis::HMILevel::eType level) = 0;
virtual const smart_objects::SmartObject* GetRCCapabilities() const = 0;
/**
* Checks if application has remote control functions
* @param app application
* @return true if application has remote control functions
*/
virtual bool IsRemoteControlApplication(ApplicationSharedPtr app) const = 0;
/**
* @brief Gets current state of the specified interface
* @param interface which state to get
* @return true if specified interface available otherwise false
*/
virtual bool IsInterfaceAvailable(
const HmiInterfaces::InterfaceID interface) const = 0;
/**
* Gets all allowed module types
* @param app_id unique identifier of application
* @param list of allowed module types
* @return true if application has allowed modules
*/
virtual bool GetModuleTypes(const std::string& policy_app_id,
std::vector<std::string>* modules) const = 0;
/**
* @brief ValidateMessageBySchema validates message by xml schema
* @param message message for validation
* @return true if message is valid according to schema, otherwise false
*/
virtual MessageValidationResult ValidateMessageBySchema(
const Message& message) = 0;
/**
* @brief Gets application manager settings structure
* @return reference to application manager settings structure
*/
virtual const ApplicationManagerSettings& GetSettings() const = 0;
};
typedef utils::SharedPtr<Service> ServicePtr;
} // namespace application_manager
#endif // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_SERVICE_H_
|
