xref: /openbmc/bmcweb/features/redfish/include/redfish.hpp (revision f65fca6a44ded566fa6e993b1b23b2e189a48703)
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     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         requestRoutesUpdateService(app);
88         requestRoutesStorageCollection(app);
89         requestRoutesStorage(app);
90         requestRoutesDrive(app);
91         requestRoutesCable(app);
92         requestRoutesCableCollection(app);
93 #ifdef BMCWEB_INSECURE_ENABLE_REDFISH_FW_TFTP_UPDATE
94         requestRoutesUpdateServiceActionsSimpleUpdate(app);
95 #endif
96         requestRoutesSoftwareInventoryCollection(app);
97         requestRoutesSoftwareInventory(app);
98 
99         requestRoutesSystemLogServiceCollection(app);
100         requestRoutesEventLogService(app);
101         requestRoutesPostCodesEntryAdditionalData(app);
102 
103         requestRoutesPostCodesLogService(app);
104         requestRoutesPostCodesClear(app);
105         requestRoutesPostCodesEntry(app);
106         requestRoutesPostCodesEntryCollection(app);
107 
108 #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
109         requestRoutesSystemDumpService(app);
110         requestRoutesSystemDumpEntryCollection(app);
111         requestRoutesSystemDumpEntry(app);
112         requestRoutesSystemDumpCreate(app);
113         requestRoutesSystemDumpClear(app);
114 
115         requestRoutesBMCDumpService(app);
116         requestRoutesBMCDumpEntryCollection(app);
117         requestRoutesBMCDumpEntry(app);
118         requestRoutesBMCDumpCreate(app);
119         requestRoutesBMCDumpClear(app);
120 #endif
121 
122 #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES
123         requestRoutesJournalEventLogEntryCollection(app);
124         requestRoutesJournalEventLogEntry(app);
125         requestRoutesJournalEventLogClear(app);
126 #endif
127 
128         requestRoutesBMCLogServiceCollection(app);
129 #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL
130         requestRoutesBMCJournalLogService(app);
131         requestRoutesBMCJournalLogEntryCollection(app);
132         requestRoutesBMCJournalLogEntry(app);
133 #endif
134 
135 #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG
136         requestRoutesCrashdumpService(app);
137         requestRoutesCrashdumpEntryCollection(app);
138         requestRoutesCrashdumpEntry(app);
139         requestRoutesCrashdumpFile(app);
140         requestRoutesCrashdumpClear(app);
141         requestRoutesCrashdumpCollect(app);
142 #endif // BMCWEB_ENABLE_REDFISH_CPU_LOG
143 
144         requestRoutesProcessorCollection(app);
145         requestRoutesProcessor(app);
146         requestRoutesOperatingConfigCollection(app);
147         requestRoutesOperatingConfig(app);
148         requestRoutesMemoryCollection(app);
149         requestRoutesMemory(app);
150 
151         requestRoutesSystemsCollection(app);
152         requestRoutesSystems(app);
153         requestRoutesSystemActionsReset(app);
154         requestRoutesSystemResetActionInfo(app);
155         requestRoutesBiosService(app);
156         requestRoutesBiosReset(app);
157 
158 #ifdef BMCWEB_ENABLE_VM_NBDPROXY
159         requestNBDVirtualMediaRoutes(app);
160 #endif // BMCWEB_ENABLE_VM_NBDPROXY
161 
162 #ifdef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES
163         requestRoutesDBusLogServiceActionsClear(app);
164         requestRoutesDBusEventLogEntryCollection(app);
165         requestRoutesDBusEventLogEntry(app);
166         requestRoutesDBusEventLogEntryDownload(app);
167 #endif
168 
169 #ifdef BMCWEB_ENABLE_REDFISH_HOST_LOGGER
170         requestRoutesSystemHostLogger(app);
171         requestRoutesSystemHostLoggerCollection(app);
172         requestRoutesSystemHostLoggerLogEntry(app);
173 #endif
174 
175         requestRoutesMessageRegistryFileCollection(app);
176         requestRoutesMessageRegistryFile(app);
177         requestRoutesMessageRegistry(app);
178 
179         requestRoutesCertificateService(app);
180         requestRoutesCertificateActionGenerateCSR(app);
181         requestRoutesCertificateActionsReplaceCertificate(app);
182         requestRoutesHTTPSCertificate(app);
183         requestRoutesHTTPSCertificateCollection(app);
184         requestRoutesCertificateLocations(app);
185         requestRoutesLDAPCertificateCollection(app);
186         requestRoutesLDAPCertificate(app);
187         requestRoutesTrustStoreCertificateCollection(app);
188         requestRoutesTrustStoreCertificate(app);
189 
190         requestRoutesSystemPCIeFunctionCollection(app);
191         requestRoutesSystemPCIeFunction(app);
192         requestRoutesSystemPCIeDeviceCollection(app);
193         requestRoutesSystemPCIeDevice(app);
194 
195         requestRoutesSensorCollection(app);
196         requestRoutesSensor(app);
197 
198         requestRoutesTaskMonitor(app);
199         requestRoutesTaskService(app);
200         requestRoutesTaskCollection(app);
201         requestRoutesTask(app);
202         requestRoutesEventService(app);
203         requestRoutesEventDestinationCollection(app);
204         requestRoutesEventDestination(app);
205         requestRoutesSubmitTestEvent(app);
206 
207         hypervisor::requestRoutesHypervisorSystems(app);
208 
209         requestRoutesTelemetryService(app);
210         requestRoutesMetricReportDefinitionCollection(app);
211         requestRoutesMetricReportDefinition(app);
212         requestRoutesMetricReportCollection(app);
213         requestRoutesMetricReport(app);
214         requestRoutesTriggerCollection(app);
215         requestRoutesTrigger(app);
216 
217         requestRoutesRedfish(app);
218     }
219 };
220 
221 } // namespace redfish
222