WIP - some documentation

lib/framework/APSettingsService.h

@@ -1,7 +1,7 @@
 #ifndef APSettingsConfig_h
 #define APSettingsConfig_h
 
-#include <SettingsService.h>
+#include <AdminSettingsService.h>
 #include <DNSServer.h>
 #include <IPAddress.h>
 

lib/framework/AdminSettingsService.h

@@ -0,0 +1,46 @@
+#ifndef AdminSettingsService_h
+#define AdminSettingsService_h
+
+#include <SettingsService.h>
+
+class AdminSettingsService : public SettingsService {
+  
+  public:  
+    AdminSettingsService(FS* fs, SecurityManager* securityManager, char const* servicePath, char const* filePath):
+      SettingsService(fs, servicePath, filePath), _securityManager(securityManager) {
+    }
+
+  protected:
+    // will validate the requests with the security manager
+    SecurityManager* _securityManager;
+
+    void fetchConfig(AsyncWebServerRequest *request) {
+      // verify the request against the predicate
+      Authentication authentication = _securityManager->authenticateRequest(request);
+      if (!getAuthenticationPredicate()(authentication)) {
+        request->send(401);
+        return;
+      }
+      // delegate to underlying implemetation
+      SettingsService::fetchConfig(request);
+    }
+
+    void updateConfig(AsyncWebServerRequest *request, JsonDocument &jsonDocument) {
+      // verify the request against the predicate
+      Authentication authentication = _securityManager->authenticateRequest(request);
+      if (!getAuthenticationPredicate()(authentication)) {
+        request->send(401);
+        return;
+      }
+      // delegate to underlying implemetation
+      SettingsService::updateConfig(request, jsonDocument);
+    }
+
+    // override this to replace the default authentication predicate, IS_ADMIN
+    AuthenticationPredicate getAuthenticationPredicate() {
+      return AuthenticationPredicates::IS_ADMIN;
+    }
+
+};
+
+#endif // end AdminSettingsService

lib/framework/NTPSettingsService.h

@@ -1,7 +1,7 @@
 #ifndef NTPSettingsService_h
 #define NTPSettingsService_h
 
-#include <SettingsService.h>
+#include <AdminSettingsService.h>
 
 #include <TimeLib.h>
 #include <NtpClientLib.h>

lib/framework/OTASettingsService.h

@@ -1,7 +1,7 @@
 #ifndef OTASettingsService_h
 #define OTASettingsService_h
 
-#include <SettingsService.h>
+#include <AdminSettingsService.h>
 
 #if defined(ESP8266)
   #include <ESP8266mDNS.h>

lib/framework/SecuritySettingsService.h

@@ -1,7 +1,7 @@
 #ifndef SecuritySettingsService_h
 #define SecuritySettingsService_h
 
-#include <SettingsService.h>
+#include <AdminSettingsService.h>
 #include <SecurityManager.h>
 
 #define SECURITY_SETTINGS_FILE "/config/securitySettings.json"

lib/framework/SettingsService.h

@@ -78,43 +78,4 @@ protected:
 
 };
 
-class AdminSettingsService : public SettingsService {
-  public:  
-    AdminSettingsService(FS* fs, SecurityManager* securityManager, char const* servicePath, char const* filePath):
-      SettingsService(fs, servicePath, filePath), _securityManager(securityManager) {
-    }
-
-  protected:
-    // will validate the requests with the security manager
-    SecurityManager* _securityManager;
-
-    void fetchConfig(AsyncWebServerRequest *request) {
-      // verify the request against the predicate
-      Authentication authentication = _securityManager->authenticateRequest(request);
-      if (!getAuthenticationPredicate()(authentication)) {
-        request->send(401);
-        return;
-      }
-      // delegate to underlying implemetation
-      SettingsService::fetchConfig(request);
-    }
-
-    void updateConfig(AsyncWebServerRequest *request, JsonDocument &jsonDocument) {
-      // verify the request against the predicate
-      Authentication authentication = _securityManager->authenticateRequest(request);
-      if (!getAuthenticationPredicate()(authentication)) {
-        request->send(401);
-        return;
-      }
-      // delegate to underlying implemetation
-      SettingsService::updateConfig(request, jsonDocument);
-    }
-
-    // override to override the default authentication predicate, IS_ADMIN
-    AuthenticationPredicate getAuthenticationPredicate() {
-      return AuthenticationPredicates::IS_ADMIN;
-    }
-
-};
-
 #endif // end SettingsService

lib/framework/WiFiSettingsService.h

@@ -1,7 +1,7 @@
 #ifndef WiFiSettingsService_h
 #define WiFiSettingsService_h
 
-#include <SettingsService.h>
+#include <AdminSettingsService.h>
 #include <IPAddress.h>
 
 #define WIFI_SETTINGS_FILE "/config/wifiSettings.json"