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/pcie_slots.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     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         requestRoutesPCIeSlots(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 #endif
125 
126 #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES
127         requestRoutesJournalEventLogEntryCollection(app);
128         requestRoutesJournalEventLogEntry(app);
129         requestRoutesJournalEventLogClear(app);
130 #endif
131 
132         requestRoutesBMCLogServiceCollection(app);
133 #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL
134         requestRoutesBMCJournalLogService(app);
135         requestRoutesBMCJournalLogEntryCollection(app);
136         requestRoutesBMCJournalLogEntry(app);
137 #endif
138 
139 #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG
140         requestRoutesCrashdumpService(app);
141         requestRoutesCrashdumpEntryCollection(app);
142         requestRoutesCrashdumpEntry(app);
143         requestRoutesCrashdumpFile(app);
144         requestRoutesCrashdumpClear(app);
145         requestRoutesCrashdumpCollect(app);
146 #endif // BMCWEB_ENABLE_REDFISH_CPU_LOG
147 
148         requestRoutesProcessorCollection(app);
149         requestRoutesProcessor(app);
150         requestRoutesOperatingConfigCollection(app);
151         requestRoutesOperatingConfig(app);
152         requestRoutesMemoryCollection(app);
153         requestRoutesMemory(app);
154 
155         requestRoutesSystemsCollection(app);
156         requestRoutesSystems(app);
157         requestRoutesSystemActionsReset(app);
158         requestRoutesSystemResetActionInfo(app);
159         requestRoutesBiosService(app);
160         requestRoutesBiosReset(app);
161 
162 #ifdef BMCWEB_ENABLE_VM_NBDPROXY
163         requestNBDVirtualMediaRoutes(app);
164 #endif // BMCWEB_ENABLE_VM_NBDPROXY
165 
166 #ifdef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES
167         requestRoutesDBusLogServiceActionsClear(app);
168         requestRoutesDBusEventLogEntryCollection(app);
169         requestRoutesDBusEventLogEntry(app);
170         requestRoutesDBusEventLogEntryDownload(app);
171 #endif
172 
173 #ifdef BMCWEB_ENABLE_REDFISH_HOST_LOGGER
174         requestRoutesSystemHostLogger(app);
175         requestRoutesSystemHostLoggerCollection(app);
176         requestRoutesSystemHostLoggerLogEntry(app);
177 #endif
178 
179         requestRoutesMessageRegistryFileCollection(app);
180         requestRoutesMessageRegistryFile(app);
181         requestRoutesMessageRegistry(app);
182 
183         requestRoutesCertificateService(app);
184         requestRoutesCertificateActionGenerateCSR(app);
185         requestRoutesCertificateActionsReplaceCertificate(app);
186         requestRoutesHTTPSCertificate(app);
187         requestRoutesHTTPSCertificateCollection(app);
188         requestRoutesCertificateLocations(app);
189         requestRoutesLDAPCertificateCollection(app);
190         requestRoutesLDAPCertificate(app);
191         requestRoutesTrustStoreCertificateCollection(app);
192         requestRoutesTrustStoreCertificate(app);
193 
194         requestRoutesSystemPCIeFunctionCollection(app);
195         requestRoutesSystemPCIeFunction(app);
196         requestRoutesSystemPCIeDeviceCollection(app);
197         requestRoutesSystemPCIeDevice(app);
198 
199         requestRoutesSensorCollection(app);
200         requestRoutesSensor(app);
201 
202         requestRoutesTaskMonitor(app);
203         requestRoutesTaskService(app);
204         requestRoutesTaskCollection(app);
205         requestRoutesTask(app);
206         requestRoutesEventService(app);
207         requestRoutesEventDestinationCollection(app);
208         requestRoutesEventDestination(app);
209         requestRoutesSubmitTestEvent(app);
210 
211         hypervisor::requestRoutesHypervisorSystems(app);
212 
213         requestRoutesTelemetryService(app);
214         requestRoutesMetricReportDefinitionCollection(app);
215         requestRoutesMetricReportDefinition(app);
216         requestRoutesMetricReportCollection(app);
217         requestRoutesMetricReport(app);
218         requestRoutesTriggerCollection(app);
219         requestRoutesTrigger(app);
220 
221         // Note, this must be the last route registered
222         requestRoutesRedfish(app);
223     }
224 };
225 
226 } // namespace redfish
227