From 0bb2132bf9b51c50bd892ba6de6d89e95c7a36eb Mon Sep 17 00:00:00 2001
From: ulrich
Date: Wed, 13 Nov 2024 17:58:49 +0000
Subject: [PATCH] Dokumentation in Arbeit

---
 src/de/uhilger/fm/package-info.java |   62 +++++++++++++++++++++++++++++++
 1 files changed, 62 insertions(+), 0 deletions(-)

diff --git a/src/de/uhilger/fm/package-info.java b/src/de/uhilger/fm/package-info.java
index 666fdce..8df813f 100644
--- a/src/de/uhilger/fm/package-info.java
+++ b/src/de/uhilger/fm/package-info.java
@@ -1,10 +1,72 @@
 /**
  * Klassen fuer das Dateimanagement. 
  * 
+ * Die folgenden Funktionen sind enthalten:
+ * 
+ * <pre>
+ * 
  * 
  * Dateiinhalt abrufen:       
  *    String json = new Lister().liste(ordnerName, ctx, basisOrdner);
+ *
  * 
  * 
+ * 
+ * 
+ * Ordnerinhalt auflisten:    
+ *   GET http://localhost:[port]/[kontext]/pfad/zum/ordner/
+ * 
+ * Dateiinhalt aendern (ueberschreiben) oder neu anlegen:       
+ *   PUT http://localhost:[port]/[kontext]/pfad/zur/datei.txt  
+ *   Body: Neuer Dateiinhalt
+ * 
+ * Datei neu anlegen (ohne Ueberschreiben):
+ *   POST http://localhost:[port]/[kontext]/pfad/zur/datei.txt
+ *   Body: Dateiinhalt
+ *   Erzeugt eine neue Datei mit einer laufenden Nummer, falls
+ *   die per URL angegebene Datei schon existiert
+ * 
+ * Ordner anlegen:
+ *   POST http://localhost:[port]/[kontext]/pfad/zum/ordner/
+ *   erzeugt einen HTTP-Fehler 422, wenn der Ordner schon existiert
+ * 
+ * Dateien und Ordner loeschen:
+ *   DELETE 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
+ * 
+ * Kopieren von Dateien und Ordnern:
+ *   PUT http://localhost[port]/[kontext]/pfad/zum/zielordner/?copyFrom=/pfad/zum/quellordner/
+ *   Body: Liste mit Datei- und Ordnernamen, die einschliesslich aller Unterordner 
+ *         kopiert werden sollen, z.B. ["anleitung.adoc","dok","ordner-2","bild.jpg"]
+ * 
+ * Verschieben von Dateien und Ordnern:
+ *   PUT http://localhost[port]/[kontext]/pfad/zum/zielordner/?moveFrom=/pfad/zum/quellordner/
+ *   Body: Liste mit Datei- und Ordnernamen, die einschliesslich aller Unterordner 
+ *         verschoben werden sollen, z.B. ["anleitung.adoc","dok","ordner-2","bild.jpg"]
+ * 
+ * Duplizieren einer Datei:
+ *   PUT http://localhost:[port]/[kontext]/pfad/zur/datei.txt?duplicate=true
+ * 
+ * Umbenennen einer Datei oder eines Ordners:
+ *   PUT http://localhost:[port]/[kontext]/pfad/zur/datei.txt?renameTo=neuer-name.txt
+ *   PUT http://localhost:[port]/[kontext]/pfad/zum/ordner/?renameTo=neuer-ordnername
+ *   Das Umbenennen erfolgt nur, wenn am betreffenden Ort eine Datei bzw. ein Ordner 
+ *   mit dem neuen Namen noch nicht existiert.
+ * 
+ * Packen eines Ordners:
+ *   PUT http://localhost:[port]/[kontext]/pfad/zum/archiv/packdaten/?zip
+ *   Packt (komprimiert) den Ordner mitsamt Inhalt. Mit obigem URL liegt 
+ *   anschliessend im Ordner 'archiv' eine Datei 'packdaten.zip'.
+ * 
+ * Entpacken einer ZIP-Datei:
+ *   PUT http://localhost:[port]/[kontext]/pfad/zu/dateien/archiv.zip?unzip
+ *   Entpackt die im URL angegebene Datei. Mit obigem URL liegt anschliessend 
+ *   der Inhalt der Datei 'archiv.zip' im Ordner 'dateien'.
+ * 
+ * 
+ * </pre>
  */
 package de.uhilger.fm;
\ No newline at end of file

--
Gitblit v1.9.3