From a9ce27642a6280f95664b0140a356e6f4ade91b1 Mon Sep 17 00:00:00 2001
From: ulrich <undisclosed>
Date: Wed, 20 Nov 2024 14:58:09 +0000
Subject: [PATCH] API-Doku ergaenzt
---
src/de/uhilger/neon/fm/FileManipulator.java | 39 +++++++++++++++++++++++++++++++++++++--
1 files changed, 37 insertions(+), 2 deletions(-)
diff --git a/src/de/uhilger/neon/fm/FileManipulator.java b/src/de/uhilger/neon/fm/FileManipulator.java
index 33e008f..63209db 100644
--- a/src/de/uhilger/neon/fm/FileManipulator.java
+++ b/src/de/uhilger/neon/fm/FileManipulator.java
@@ -28,7 +28,7 @@
import java.io.IOException;
/**
- * Ein Klasse fuer Aenderungen an bestehenden Dateien.
+ * Aenderungen an bestehenden Dateien.
*
* @author Ulrich Hilger
* @version 0.1, 07.11.2024
@@ -56,11 +56,46 @@
* - Liste mit Dateien kopieren (?copyFrom=quelle): url=ziel, Dateiliste im Body
* - Liste mit Dateien verschieben (?moveFrom=quelle): url=Ziel, Dateiliste im Body
* - einzelne Datei duplizieren (?duplicate): url=Zieldatei
- * - einzelne Datei umbenennen (?renameTo=neuer Name): url=Datei oder -odner
+ * - einzelne Datei umbenennen (?renameTo=neuer Name): url=Datei oder -ordner
* - Ordner packen (?zip): url=Ordner
* - Zip-Datei entpacken (?unzip): url=Datei
* </pre>
*
+ *
+ * <pre>
+ * <p>HTTP PUT /pfad/zur/datei.txt ueberschreibt eine bestehende Datei mit dem im Body
+ * uebergebenen Inhalt oder legt eine Datei mit diesem Inhalt an</p>
+ *
+ * HTTP PUT /pfad/zum/zielordner?copyFrom=/pfad/zum/quellordner
+ * kopiert die Liste der Datei- oder Ordnernamen im Body
+ * der Anfrage vom Pfad in 'copyFrom' zum Pfad dieser Anfrage. Jede Datei, die
+ * im Ziel bereits existiert, bekommt im Ziel einen neuen Namen mit einer
+ * laufenden Nummer. Bei Ordnern, die im Ziel bereits existieren, bekommt der
+ * betreffende Ordner im Ziel zunaechst einen neuen Namen mit einer laufenden
+ * Nummer, dann wird der Quellordner ans Ziel kopiert.
+ *
+ * HTTP PUT /pfad/zum/zielordner?moveFrom=/pfad/zum/quellordner
+ * verschiebt die Liste der Datei- oder Ordnernamen im
+ * Body der Anfrage vom Pfad in 'moveFrom' zum Pfad dieser Anfrage. Jede Datei,
+ * die im Ziel bereits existiert, bekommt im Ziel einen neuen Namen mit einer
+ * laufenden Nummer. Bei Ordnern, die im Ziel bereits existieren, bekommt der
+ * betreffende Ordner im Ziel zunaechst einen neuen Namen mit einer laufenden
+ * Nummer, dann wird der Quellordner ans Ziel kopiert.
+ *
+ * HTTP PUT /pfad/zur/datei.txt?duplicate legt eine Kopie der Datei an
+ *
+ * HTTP PUT /pfad/zur/datei.txt?renameTo=neuer Name benennt die Datei oder den Ordner um,
+ * sofern der neue Name noch nicht vergeben ist
+ *
+ * HTTP PUT /pfad/zum/ordner?zip' packt den Ordner
+ *
+ * HTTP PUT /pfad/zur/datei.zip?unzip' entpackt eine Datei
+ *
+ * Eine Dateiliste im Body sieht z.B. wie folgt aus
+ * ["test.txt","dok","weitere-datei.bin","bild.jpg"]
+ *
+ * </pre>
+ *
* @param exchange das Objekt mit Infos zu HTTP-Request, -Response usw.
*/
public void change(HttpExchange exchange) {
--
Gitblit v1.9.3