ZIP Converter

Der ZIP Converter komprimiert und dekomprimiert Daten in ein ZIP-Archiv.

Eigenschaften (Properties)

Operation

Vom Adapter ausgeführte Operation

Mögliche Werte:

Zip: Komprimiert den bereitgestellten Input in einer Zip-Datei. Es können Verschlüsselungs- und Komprimierungseinstellungen vorgenommen werden.

Erforderliche Parameter

Die Parameter SourcePath oder InputName werden für diesen Vorgang benötigt.
Unzip: Dekomprimiert den bereitgestellten Input am angegebenen Speicherort. Es können auch passwortgeschützte Dateien dekomprimiert werden.

Parameter

`Adapter`	Hauptklasse des Adapters (nicht verändern!) Mögliche Werte: de.softproject.x4.adapter.zipconverter.ZipConverter: Hauptklasse (Standard)
`sourcePath`	Verzeichnispfad zur Datei, die komprimiert/dekomprimiert werden soll. Mögliche Werte: Verzeichnispfad Wenn dieser Parameter nicht gesetzt wird, dann wird die Datei über den Adapter-Input bereitgestellt. In diesem Fall ist der Parameter `inputName` für die Operation `Zip` erforderlich.
`targetPath`	Verzeichnispfad zum Speicherort, an dem der Output gespeichert werden soll ("Zielverzeichnis"). Mögliche Werte: Verzeichnispfad Wenn dieser Parameter nicht gesetzt wird, dann wird die Datei über den Adapter-Output bereitgestellt.
`overwrite`	Legt fest, ob vorhandene Dateien mit dem gleichen Namen überschrieben werden sollen. Mögliche Werte: Aktiviert Wenn `mergeContent` aktiviert ist, dann wird im Output eine Fehlermeldung ausgegeben, da die Datei nicht weiterverarbeitet werden kann. Wenn `mergeContent` deaktiviert ist, dann wird die vorhandene Datei überschrieben. Deaktiviert Wenn `mergeContent` aktiviert ist, dann wird werden die Dateien zusammengeführt. Wenn `mergeContent` deaktiviert ist, dann wird im Output eine Fehlermeldung ausgegeben, da die Datei nicht weiterverarbeitet werden kann.
`mergeContent`	Legt fest, ob vorhandene Dateien mit dem gleichen Namen zusammengeführt werden sollen. Mögliche Werte: Aktiviert Wenn `overwrite` aktiviert ist, dann wird im Output eine Fehlermeldung ausgegeben, da die Datei nicht weiterverarbeitet werden kann. Wenn `overwrite` deaktiviert ist, dann werden die Dateien zusammengeführt. Deaktiviert Wenn `overwrite` aktiviert ist, dann wird die vorhandene Datei überschrieben. Wenn `overwrite` deaktiviert ist, dann wird im Output eine Fehlermeldung ausgegeben, da die Datei nicht weiterverarbeitet werden kann.
`inputName`	Name der Input-Datei. Wird verwendet, wenn der `sourcePath` nicht gesetzt ist. Mögliche Werte: Dateiname der Datei, die als Input empfangen bzw. als Output ausgegeben werden soll
`encryptedFiles`	Gibt an, ob in der Operation verschlüsselte Dateien verarbeitet werden sollen. Bei der Operation `Zip` wird die ausgegebene Zip-Datei passwortgeschützt, bei der Operation `Unzip` wird für das entzippen ein Passwort benötigt. Mögliche Werte: Aktiviert Deaktiviert
`password`	Passwort für verschlüsselte Dateien. Mögliche Werte: Beliebige Zeichenkette
`encryptionMethod`	Gibt an, welche Verschlüsselungsmethode beim Zippen verwendet wird, wenn `encryptedFiles` aktiviert ist. Mögliche Werte: `No encryption`: Keine Verschlüsselung beim Zippen verwenden `AES`: AES-Verschlüsselungsalgorithmus verwenden (Schlüssellänge: 256 Bit) `Standard`: Standard-Verschlüsselungsalgorithmus verwenden
`compressionMethod`	Gibt an, welcher Komprimierungsalgorithmus beim Zippen verwendet wird. Mögliche Werte: `Deflate` (Standard): Verlustfreie Komprimierung, die eine Kombination aus dem LZ77-Algorithmus und Huffman-Codierung verwendet. Weitere Informationen zu dieser Kompressionsstufe hier und hier. Wenn `Deflate` ausgewählt ist, dann kann das Komprimierungslevel mit `CompressionLevel` spezifiziert werden. `Store`: Daten werden nicht komprimiert, sondern in eine einzige Datei gepackt. Das ist nützlich wenn mehrere Daten/Ordner gesendet/empfangen werden sollen und die Dateigröße vernachlässigt werden kann. Es wird keine Zeit für das Verpacken benötigt.
`compressionLevel`	Gibt den Komprimierungsalgorithmus beim Zippen an, wenn für `ompressionMethod` `Deflate` gewählt ist. Mögliche Werte: `Fastest`: Niedrigste Kompressionsstufe, aber sehr schnelle Kompression `Fast`: Niedrige Kompressionsstufe, aber schnelle Kompression `Normal` (Standard): Optimales Verhältnis zwischen Kompressionsstufe und -geschwindigkeit `Maximum`: Hohe Kompressionsstufe, aber langsamere Kompression `Ultra`: Höchste Kompressionsstufe, aber sehr langsame Kompression

Statuswerte

`1`	Die Adapter-Operation wurde erfolgreich ausgeführt.
`-1`	Bei der Ausführung des Adapters ist ein Fehler aufgetreten.

Input

Der Adapter erwartet Input in folgender Struktur:

Beide Operationen (Zip / Unzip) können mit zwei verschiedenen Herkunfts- bzw. Zielorten arbeiten:
- Input/Output
- Verzeichnispfad für Input/Output
Basierend auf diesen zwei Möglichkeiten können für beide Operationen verschiedene Inputs verwendet werden:
- Parameter sourcePath ist gesetzt: Input vom Verzeichnis, dass im Verzeichnispfad angegeben ist.
- Parameter sourcePath ist nicht gesetzt: Input des Parameters
Basierend auf diesen zwei Möglichkeiten können für beide Operationen verschiedene Outputs verwendet werden:
- Parameter targetPath ist gesetzt: Das Ergebnis der Operation wird am Speicherort abgelegt, der als Verzeichnispfad angegeben ist.
- Parameter targetPath ist nicht gesetzt:
  - Eine XML-Datei mit einem Eintrag für jede Input-Datei, die in der Input-Zip-Datei enthalten ist, wird ausgegeben.
  - Der Inhalt der Zip-Datei wird am Speicherort abgelegt, der als Verzeichnispfad angegeben ist.

Output

Der Adapter liefert abhängig von der ausgeführten Operation unterschiedliche Arten von Dokumenten zurück.

Zip-Operation ohne targetPath: Zip-Datei wird im Adapter-Output bereitgestellt.
Zip-Operation mit targetPath: Zip-Datei wird im Zielverzeichnis abgelegt.
Unzip-Operation ohne targetPath: Eine XML-Datei, die die verschiedenen Dateien innerhalb der Zip-Datei enthält, wird im Adapter-Output bereitgestellt. Die XML-Datei hat folgende Struktur:
Beispiel-Output für die Operation Unzip

XML
```
<?xml version="1.0" encoding="UTF-8" ?>
<Zip>
	<File size="209" name="testToZip.xml" comment="...">PD94bWwgdmVyc2lvgj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPFJvb3RFbGVtZW50P</File>
</Zip>
```
Unzip-Operation mit targetPath: Der Inhalt der Zip-Datei wird im Zielverzeichnis abgelegt.