1 /*
2 // Copyright (c) 2018-2019 Intel Corporation
3 //
4 // Licensed under the Apache License, Version 2.0 (the "License");
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
7 //
8 //      http://www.apache.org/licenses/LICENSE-2.0
9 //
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
15 */
16 #pragma once
17 
18 #include "../lib/account_service.hpp"
19 #include "../lib/bios.hpp"
20 #include "../lib/cable.hpp"
21 #include "../lib/certificate_service.hpp"
22 #include "../lib/chassis.hpp"
23 #include "../lib/ethernet.hpp"
24 #include "../lib/event_service.hpp"
25 #include "../lib/hypervisor_system.hpp"
26 #include "../lib/log_services.hpp"
27 #include "../lib/manager_diagnostic_data.hpp"
28 #include "../lib/managers.hpp"
29 #include "../lib/memory.hpp"
30 #include "../lib/message_registries.hpp"
31 #include "../lib/metric_report.hpp"
32 #include "../lib/metric_report_definition.hpp"
33 #include "../lib/network_protocol.hpp"
34 #include "../lib/pcie.hpp"
35 #include "../lib/power.hpp"
36 #include "../lib/processor.hpp"
37 #include "../lib/redfish_sessions.hpp"
38 #include "../lib/redfish_v1.hpp"
39 #include "../lib/roles.hpp"
40 #include "../lib/sensors.hpp"
41 #include "../lib/service_root.hpp"
42 #include "../lib/storage.hpp"
43 #include "../lib/systems.hpp"
44 #include "../lib/task.hpp"
45 #include "../lib/telemetry_service.hpp"
46 #include "../lib/thermal.hpp"
47 #include "../lib/thermal_subsystem.hpp"
48 #include "../lib/trigger.hpp"
49 #include "../lib/update_service.hpp"
50 #include "../lib/virtual_media.hpp"
51 
52 namespace redfish
53 {
54 /*
55  * @brief Top level class installing and providing Redfish services
56  */
57 class RedfishService
58 {
59   public:
60     /*
61      * @brief Redfish service constructor
62      *
63      * Loads Redfish configuration and installs schema resources
64      *
65      * @param[in] app   Crow app on which Redfish will initialize
66      */
67     explicit RedfishService(App& app)
68     {
69         requestAccountServiceRoutes(app);
70         requestRoutesRoles(app);
71         requestRoutesRoleCollection(app);
72         requestRoutesServiceRoot(app);
73         requestRoutesNetworkProtocol(app);
74         requestRoutesSession(app);
75         requestEthernetInterfacesRoutes(app);
76 #ifdef BMCWEB_ALLOW_DEPRECATED_POWER_THERMAL
77         requestRoutesThermal(app);
78         requestRoutesPower(app);
79 #endif
80 #ifdef BMCWEB_NEW_POWERSUBSYSTEM_THERMALSUBSYSTEM
81         requestRoutesThermalSubsystem(app);
82 #endif
83         requestRoutesManagerCollection(app);
84         requestRoutesManager(app);
85         requestRoutesManagerResetAction(app);
86         requestRoutesManagerResetActionInfo(app);
87         requestRoutesManagerResetToDefaultsAction(app);
88         requestRoutesManagerDiagnosticData(app);
89         requestRoutesChassisCollection(app);
90         requestRoutesChassis(app);
91         requestRoutesChassisResetAction(app);
92         requestRoutesChassisResetActionInfo(app);
93         requestRoutesChassisDrive(app);
94         requestRoutesChassisDriveName(app);
95         requestRoutesUpdateService(app);
96         requestRoutesStorageCollection(app);
97         requestRoutesStorage(app);
98         requestRoutesDrive(app);
99         requestRoutesCable(app);
100         requestRoutesCableCollection(app);
101 #ifdef BMCWEB_INSECURE_ENABLE_REDFISH_FW_TFTP_UPDATE
102         requestRoutesUpdateServiceActionsSimpleUpdate(app);
103 #endif
104         requestRoutesSoftwareInventoryCollection(app);
105         requestRoutesSoftwareInventory(app);
106 
107         requestRoutesSystemLogServiceCollection(app);
108         requestRoutesEventLogService(app);
109         requestRoutesPostCodesEntryAdditionalData(app);
110 
111         requestRoutesPostCodesLogService(app);
112         requestRoutesPostCodesClear(app);
113         requestRoutesPostCodesEntry(app);
114         requestRoutesPostCodesEntryCollection(app);
115 
116 #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
117         requestRoutesSystemDumpService(app);
118         requestRoutesSystemDumpEntryCollection(app);
119         requestRoutesSystemDumpEntry(app);
120         requestRoutesSystemDumpCreate(app);
121         requestRoutesSystemDumpClear(app);
122 
123         requestRoutesBMCDumpService(app);
124         requestRoutesBMCDumpEntryCollection(app);
125         requestRoutesBMCDumpEntry(app);
126         requestRoutesBMCDumpCreate(app);
127         requestRoutesBMCDumpClear(app);
128 
129         requestRoutesFaultLogDumpService(app);
130         requestRoutesFaultLogDumpEntryCollection(app);
131         requestRoutesFaultLogDumpEntry(app);
132         requestRoutesFaultLogDumpClear(app);
133 #endif
134 
135 #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES
136         requestRoutesJournalEventLogEntryCollection(app);
137         requestRoutesJournalEventLogEntry(app);
138         requestRoutesJournalEventLogClear(app);
139 #endif
140 
141         requestRoutesBMCLogServiceCollection(app);
142 #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL
143         requestRoutesBMCJournalLogService(app);
144         requestRoutesBMCJournalLogEntryCollection(app);
145         requestRoutesBMCJournalLogEntry(app);
146 #endif
147 
148 #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG
149         requestRoutesCrashdumpService(app);
150         requestRoutesCrashdumpEntryCollection(app);
151         requestRoutesCrashdumpEntry(app);
152         requestRoutesCrashdumpFile(app);
153         requestRoutesCrashdumpClear(app);
154         requestRoutesCrashdumpCollect(app);
155 #endif // BMCWEB_ENABLE_REDFISH_CPU_LOG
156 
157         requestRoutesProcessorCollection(app);
158         requestRoutesProcessor(app);
159         requestRoutesOperatingConfigCollection(app);
160         requestRoutesOperatingConfig(app);
161         requestRoutesMemoryCollection(app);
162         requestRoutesMemory(app);
163 
164         requestRoutesSystemsCollection(app);
165         requestRoutesSystems(app);
166         requestRoutesSystemActionsReset(app);
167         requestRoutesSystemResetActionInfo(app);
168         requestRoutesBiosService(app);
169         requestRoutesBiosReset(app);
170 
171 #ifdef BMCWEB_ENABLE_VM_NBDPROXY
172         requestNBDVirtualMediaRoutes(app);
173 #endif // BMCWEB_ENABLE_VM_NBDPROXY
174 
175 #ifdef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES
176         requestRoutesDBusLogServiceActionsClear(app);
177         requestRoutesDBusEventLogEntryCollection(app);
178         requestRoutesDBusEventLogEntry(app);
179         requestRoutesDBusEventLogEntryDownload(app);
180 #endif
181 
182 #ifdef BMCWEB_ENABLE_REDFISH_HOST_LOGGER
183         requestRoutesSystemHostLogger(app);
184         requestRoutesSystemHostLoggerCollection(app);
185         requestRoutesSystemHostLoggerLogEntry(app);
186 #endif
187 
188         requestRoutesMessageRegistryFileCollection(app);
189         requestRoutesMessageRegistryFile(app);
190         requestRoutesMessageRegistry(app);
191 
192         requestRoutesCertificateService(app);
193         requestRoutesCertificateActionGenerateCSR(app);
194         requestRoutesCertificateActionsReplaceCertificate(app);
195         requestRoutesHTTPSCertificate(app);
196         requestRoutesHTTPSCertificateCollection(app);
197         requestRoutesCertificateLocations(app);
198         requestRoutesLDAPCertificateCollection(app);
199         requestRoutesLDAPCertificate(app);
200         requestRoutesTrustStoreCertificateCollection(app);
201         requestRoutesTrustStoreCertificate(app);
202 
203         requestRoutesSystemPCIeFunctionCollection(app);
204         requestRoutesSystemPCIeFunction(app);
205         requestRoutesSystemPCIeDeviceCollection(app);
206         requestRoutesSystemPCIeDevice(app);
207 
208         requestRoutesSensorCollection(app);
209         requestRoutesSensor(app);
210 
211         requestRoutesTaskMonitor(app);
212         requestRoutesTaskService(app);
213         requestRoutesTaskCollection(app);
214         requestRoutesTask(app);
215         requestRoutesEventService(app);
216         requestRoutesEventDestinationCollection(app);
217         requestRoutesEventDestination(app);
218         requestRoutesSubmitTestEvent(app);
219 
220         hypervisor::requestRoutesHypervisorSystems(app);
221 
222         requestRoutesTelemetryService(app);
223         requestRoutesMetricReportDefinitionCollection(app);
224         requestRoutesMetricReportDefinition(app);
225         requestRoutesMetricReportCollection(app);
226         requestRoutesMetricReport(app);
227         requestRoutesTriggerCollection(app);
228         requestRoutesTrigger(app);
229 
230         // Note, this must be the last route registered
231         requestRoutesRedfish(app);
232     }
233 };
234 
235 } // namespace redfish
236