From 516d0b6c2f2ab35a59b123d9fbe6958da8458583 Mon Sep 17 00:00:00 2001
From: ulrich
Date: Wed, 20 Nov 2024 12:20:52 +0000
Subject: [PATCH] Dokumentation in Arbeit: FileEraser fertig dokumentiert, kleinere Anpassungen
---
src/de/uhilger/neon/fm/FileEraser.java | 22 ++++++++++++++++++++--
src/de/uhilger/neon/fm/package-info.java | 2 ++
2 files changed, 22 insertions(+), 2 deletions(-)
diff --git a/src/de/uhilger/neon/fm/FileEraser.java b/src/de/uhilger/neon/fm/FileEraser.java
index 064e219..4de6588 100644
--- a/src/de/uhilger/neon/fm/FileEraser.java
+++ b/src/de/uhilger/neon/fm/FileEraser.java
@@ -26,13 +26,31 @@
import java.util.logging.Logger;
/**
- *
+ * Die Klasse FileEraser liefert Methoden zum Loeschen
+ * von Dateien und Ordnern als Reaktion auf entsprechende
+ * Aufrufe mittels HTTP DELETE
+ *
* @author Ulrich Hilger
* @version 0.1, 08.11.2024
*/
public class FileEraser extends AbstractFileActor {
- public void run(HttpExchange exchange) {
+ /**
+ * <p>Diese Mthode ist als Reaktion auf einen HTTP DELETE aufruf an
+ * folgenden URL gedacht</p>
+ *
+ * <pre>
+ * Dateien und Ordner loeschen:
+ * http://localhost:[port]/[kontext]/pfad/zum/ordner/
+ * Body: Liste mit Datei- und Ordnernamen, die aus dem im URL
+ * angegebenen Ordner geloescht werden sollen, z.B. ["test.txt","dok"]
+ * Hiermit werden die Datei test.txt und der Ordner dok geloescht.
+ * Das Loeschen geschieht rekursiv, einschliesslich aller Unterordner
+ * </pre>
+ *
+ * @param exchange Das Objekt mit Infos zu HTTP-Request, -Response usw.
+ */
+ public void delete(HttpExchange exchange) {
try {
init(exchange);
String[] dateiNamen = dateiliste(exchange);
diff --git a/src/de/uhilger/neon/fm/package-info.java b/src/de/uhilger/neon/fm/package-info.java
index 921000f..a78d39b 100644
--- a/src/de/uhilger/neon/fm/package-info.java
+++ b/src/de/uhilger/neon/fm/package-info.java
@@ -6,6 +6,8 @@
* Fuer die Ausfuehrung der auf diese Weise via HTTP bereitgestellten Dateioperationen
* werden die Klassen der Package de.uhilger.fm verwendet.
*
+ * Die folgenden HTTP-Aufrufe werden von dieser Package als HTTP-Aufrufe implementiert:
+ *
* <pre>
* GET (Klasse FileList)
* - Dateiinhalt ausliefern (URL ohne Slash am Ende) FileContent + FileList
--
Gitblit v1.9.3