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/trigger.hpp"
48 #include "../lib/update_service.hpp"
49 #include "../lib/virtual_media.hpp"
50 
51 namespace redfish
52 {
53 /*
54  * @brief Top level class installing and providing Redfish services
55  */
56 class RedfishService
57 {
58   public:
59     /*
60      * @brief Redfish service constructor
61      *
62      * Loads Redfish configuration and installs schema resources
63      *
64      * @param[in] app   Crow app on which Redfish will initialize
65      */
66     explicit RedfishService(App& app)
67     {
68         requestAccountServiceRoutes(app);
69         requestRoutesRoles(app);
70         requestRoutesRoleCollection(app);
71         requestRoutesServiceRoot(app);
72         requestRoutesNetworkProtocol(app);
73         requestRoutesSession(app);
74         requestEthernetInterfacesRoutes(app);
75 #ifdef BMCWEB_ALLOW_DEPRECATED_POWER_THERMAL
76         requestRoutesThermal(app);
77         requestRoutesPower(app);
78 #endif
79         requestRoutesManagerCollection(app);
80         requestRoutesManager(app);
81         requestRoutesManagerResetAction(app);
82         requestRoutesManagerResetActionInfo(app);
83         requestRoutesManagerResetToDefaultsAction(app);
84         requestRoutesManagerDiagnosticData(app);
85         requestRoutesChassisCollection(app);
86         requestRoutesChassis(app);
87         requestRoutesChassisResetAction(app);
88         requestRoutesChassisResetActionInfo(app);
89         requestRoutesChassisDrive(app);
90         requestRoutesChassisDriveName(app);
91         requestRoutesUpdateService(app);
92         requestRoutesStorageCollection(app);
93         requestRoutesStorage(app);
94         requestRoutesDrive(app);
95         requestRoutesCable(app);
96         requestRoutesCableCollection(app);
97 #ifdef BMCWEB_INSECURE_ENABLE_REDFISH_FW_TFTP_UPDATE
98         requestRoutesUpdateServiceActionsSimpleUpdate(app);
99 #endif
100         requestRoutesSoftwareInventoryCollection(app);
101         requestRoutesSoftwareInventory(app);
102 
103         requestRoutesSystemLogServiceCollection(app);
104         requestRoutesEventLogService(app);
105         requestRoutesPostCodesEntryAdditionalData(app);
106 
107         requestRoutesPostCodesLogService(app);
108         requestRoutesPostCodesClear(app);
109         requestRoutesPostCodesEntry(app);
110         requestRoutesPostCodesEntryCollection(app);
111 
112 #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
113         requestRoutesSystemDumpService(app);
114         requestRoutesSystemDumpEntryCollection(app);
115         requestRoutesSystemDumpEntry(app);
116         requestRoutesSystemDumpCreate(app);
117         requestRoutesSystemDumpClear(app);
118 
119         requestRoutesBMCDumpService(app);
120         requestRoutesBMCDumpEntryCollection(app);
121         requestRoutesBMCDumpEntry(app);
122         requestRoutesBMCDumpCreate(app);
123         requestRoutesBMCDumpClear(app);
124 
125         requestRoutesFaultLogDumpService(app);
126         requestRoutesFaultLogDumpEntryCollection(app);
127         requestRoutesFaultLogDumpEntry(app);
128         requestRoutesFaultLogDumpClear(app);
129 #endif
130 
131 #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES
132         requestRoutesJournalEventLogEntryCollection(app);
133         requestRoutesJournalEventLogEntry(app);
134         requestRoutesJournalEventLogClear(app);
135 #endif
136 
137         requestRoutesBMCLogServiceCollection(app);
138 #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL
139         requestRoutesBMCJournalLogService(app);
140         requestRoutesBMCJournalLogEntryCollection(app);
141         requestRoutesBMCJournalLogEntry(app);
142 #endif
143 
144 #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG
145         requestRoutesCrashdumpService(app);
146         requestRoutesCrashdumpEntryCollection(app);
147         requestRoutesCrashdumpEntry(app);
148         requestRoutesCrashdumpFile(app);
149         requestRoutesCrashdumpClear(app);
150         requestRoutesCrashdumpCollect(app);
151 #endif // BMCWEB_ENABLE_REDFISH_CPU_LOG
152 
153         requestRoutesProcessorCollection(app);
154         requestRoutesProcessor(app);
155         requestRoutesOperatingConfigCollection(app);
156         requestRoutesOperatingConfig(app);
157         requestRoutesMemoryCollection(app);
158         requestRoutesMemory(app);
159 
160         requestRoutesSystemsCollection(app);
161         requestRoutesSystems(app);
162         requestRoutesSystemActionsReset(app);
163         requestRoutesSystemResetActionInfo(app);
164         requestRoutesBiosService(app);
165         requestRoutesBiosReset(app);
166 
167 #ifdef BMCWEB_ENABLE_VM_NBDPROXY
168         requestNBDVirtualMediaRoutes(app);
169 #endif // BMCWEB_ENABLE_VM_NBDPROXY
170 
171 #ifdef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES
172         requestRoutesDBusLogServiceActionsClear(app);
173         requestRoutesDBusEventLogEntryCollection(app);
174         requestRoutesDBusEventLogEntry(app);
175         requestRoutesDBusEventLogEntryDownload(app);
176 #endif
177 
178 #ifdef BMCWEB_ENABLE_REDFISH_HOST_LOGGER
179         requestRoutesSystemHostLogger(app);
180         requestRoutesSystemHostLoggerCollection(app);
181         requestRoutesSystemHostLoggerLogEntry(app);
182 #endif
183 
184         requestRoutesMessageRegistryFileCollection(app);
185         requestRoutesMessageRegistryFile(app);
186         requestRoutesMessageRegistry(app);
187 
188         requestRoutesCertificateService(app);
189         requestRoutesCertificateActionGenerateCSR(app);
190         requestRoutesCertificateActionsReplaceCertificate(app);
191         requestRoutesHTTPSCertificate(app);
192         requestRoutesHTTPSCertificateCollection(app);
193         requestRoutesCertificateLocations(app);
194         requestRoutesLDAPCertificateCollection(app);
195         requestRoutesLDAPCertificate(app);
196         requestRoutesTrustStoreCertificateCollection(app);
197         requestRoutesTrustStoreCertificate(app);
198 
199         requestRoutesSystemPCIeFunctionCollection(app);
200         requestRoutesSystemPCIeFunction(app);
201         requestRoutesSystemPCIeDeviceCollection(app);
202         requestRoutesSystemPCIeDevice(app);
203 
204         requestRoutesSensorCollection(app);
205         requestRoutesSensor(app);
206 
207         requestRoutesTaskMonitor(app);
208         requestRoutesTaskService(app);
209         requestRoutesTaskCollection(app);
210         requestRoutesTask(app);
211         requestRoutesEventService(app);
212         requestRoutesEventDestinationCollection(app);
213         requestRoutesEventDestination(app);
214         requestRoutesSubmitTestEvent(app);
215 
216         hypervisor::requestRoutesHypervisorSystems(app);
217 
218         requestRoutesTelemetryService(app);
219         requestRoutesMetricReportDefinitionCollection(app);
220         requestRoutesMetricReportDefinition(app);
221         requestRoutesMetricReportCollection(app);
222         requestRoutesMetricReport(app);
223         requestRoutesTriggerCollection(app);
224         requestRoutesTrigger(app);
225 
226         // Note, this must be the last route registered
227         requestRoutesRedfish(app);
228     }
229 };
230 
231 } // namespace redfish
232