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