Mit dem Deploy-Plugin können Plugins automatisch in die FORMCYCLE-Anwendung hochgeladen und dort installiert werden. Dies hat gegenüber der manuellen Installation über das entsprechende Menü im Backend einige Vorteile:

• Plugin-Entwickler können beim Maven-Build das Plugin automatisch am Ende des Builds hochladen. So kann der Entwickler schneller testen.
• Eine Installation auf einem Live-System kann so weiter automatisiert werden.

Das Deploy-Plugin kann sowohl als Mandant-Plugin als auch als System-Plugin installiert werden. Es enthält eine Servlet-Aktion. Per HTTP-Post-Request wird eine Plugin-JAR-Datei an den FORMCYCLE-Server gesendet. Die weiteren Parameter im HTTP-Request bestimmen, was nun weiter mit dem Plugin geschieht, etwa ob es nur installiert oder auch aktiviert werden soll.

Falls das hochgeladene Plugin bereits existiert, ist es in der Regel ist es sinnvoll, dieses zu ersetzen. Dazu ist es erforderlich, anzugeben, über welchen Identifikator ein Plugin identifiziert wird. Es gibt hierbei vier Möglichkeiten, die dieses Plugin erlaubt:

• (empfohlen) Das Plugin wird anhand eines Eintrags im Manifest identifiziert. Dieses muss in der Plugin-JAR-Datei im Pfad META-INF/MANIFEST.MF liegen. Beim Bau der JAR-Datei muss ein entsprechender eindeutiger Eintrag in das Manifest geschrieben werden, etwa die Group-ID und Artifact-ID. Diese Methode hat den Vorteil, dass der Identifikator sich nie ändern wird und unabhängig von internen IDs und Dateinamen ist.
• Das Plugin wird anhand seines Namens identifiziert, also dem Namen der ursprünglich hochgeladenen JAR-Datei. Dies ist der Name, wie er auch in der Oberfläche zu sehen ist. 
• Das Plugin wird anhand seiner internen Datenbank-ID identifiziert. Diese ist aktuell nicht an der Oberfläche zu sehen. Diese Option sollte nur von Entwicklern genutzt werden.
• Das Plugin wird anhand seiner internen UUID identifiziert. Diese ist aktuell nicht an der Oberfläche zu sehen. Diese Option sollte nur von Entwicklern genutzt werden.

Standardmäßig ist eine Servlet-Aktion für alle frei zugänglich. Da es in der Regel unerwünscht ist, dass jeder (auch unangemeldete) Nutzer Plugins installieren kann, kann das Deploy-Plugin durch ein Passwort abgesichert werden. Dazu muss in der Plugin-Konfiguration der Passwort-Hash hinterlegt werden und das Passwort dann im HTTP-POST-Request mitgesendet werden.

HTTP-Request-Aufbau

Im Folgenden wird der Aufbau des HTTP-Requests beschrieben, um ein Plugin zu installieren, zu aktualisieren oder zu löschen.

Es muss immer ein HTTP-Post-Request verwendet werden und sich an folgende URL richten (Namen des FORMCYCLE-Servers entsprechend anpassen):

Die client-id muss nicht angegeben werden, wenn das Plugin als System-Plugin installiert ist. 

Parameter

Die Parameter können direkt als URL-Parameter, als multipart/form-data oder als application/x-www-form-urlencoded übergeben werden. Folgende Parameter werden vom Deploy-Plugin unterstützt und können übergeben werden:

deploy-action

Aktion, welche mit dem Plugin durchgeführt werden soll. Erlaubte Werte sind save, update-properties, activate, deactivate und delete. Ein Erklärung zu diesen Aktionen findet sich unten.

client-id

ID des Mandanten, in dem ein Plugin installiert, aktualisiert oder gelöscht werden soll. Es darf nur entweder client-id oder client-uuid angegeben werden

client-uuid

UUID des Mandanten, in dem ein Plugin installiert, aktualisiert oder gelöscht werden soll. Es darf nur entweder client-id oder client-uuid angegeben werden. Es ist zu beachten, dass der Aufruf eines als Mandant-Plugin installierten Servlet-Aktion immer der Parameter client-id erforderlich ist.

jar-file

Binärdaten mit der JAR-Datei des Plugins, welches aktualisert oder installiert werden soll.

token

Das Token (Password) für die Authorisierung des Requests. Nur erforderlich, wenn in der Plugin-Konfiguration ein Token festgelegt wurde.

plugin-ident

Die Art, wie nach einem vorhandenen Plugin gesucht wird (siehe oben). Folgende Werte sind erlaubt:

manifest

Identifiziert ein Plugin anhand eines Eintrags im Manifest.

id

Identifiziert ein Plugin anhand seiner Datenbank-ID.

name

Identifiziert ein Plugin anhand seines Namens (Dateiname der JAR-Datei)

uuid

Identifiziert ein Plugin anhand seiner UUID.

plugin-identifier

Identifikator des Plugins, welches aktualisiert oder gelöscht werden soll. Die konkrete Bedeutung dieses Parameters ist abhängig von dem Wert von plugin-ident:

plugin-ident=manifest

plugin-identifier muss den Namen der Manifest-Eigenschaft und dessen Wert enthalten, im Format ATTRIBUTE_NAME=VALUE. Wird zum Beispiel Implementation-Title=com.example.fc.plugin:my-plugin übergeben wird, wird nach einem existierenden Plugin gesucht, welches im Manifest in der Eigenschaft Implementation-Title den Wert com.example.fc.plugin:my-plugin stehen hat.

plugin-ident=id

plugin-identifier muss die gewünschte ID des Plugins enthalten, etwa 53 oder /893.

plugin-ident=name

plugin-identifier muss den gewünschten Names des Plugins enthalten, etwa my-plugin.jar oder /foobar.jar.

plugin-ident=uuid

plugin-identifier muss die gewünschte UUID des Plugins enthalten, etwa 03022599-903d-429b-9822-80a324a542fc.
Andernfalls wird das Plugin installiert, falls noch nicht vorhanden, oder aktualisiert, falls vorhanden.

clear-properties

Entweder true oder false. Wenn true, werden alle Plugin-Eigenschaften entfernt beziehungsweise deren Werte geleert. Dies wird ausgeführt, bevor die neu zu setzenden Plugin-Eigenschaften (Parameter /property) angewendet werden.

property

Name und Wert einer Plugin-Eigenschaft, die an der Plugin-Konfiguration gesetzt werden soll, im Format key=value. Dieser HTTP-Parameter kann mehrfach angegeben werden, um mehrere Plugin-Eigenschafte zu setzen. Wird etwa database.username=max übergeben, wird die Plugin-Eigenschaft database.username auf max gesetzt.

disallow-install

Entweder true oder false. Ist diese Option auf true gesetzt und existiert das Plugin noch nicht (bezüglich der angegebenen plugin-ident und plugin-identifier), wird das Plugin nicht neu installiert und eine Fehlermeldung zurückgegeben. ; locale

Die Sprache, welche während der Installation, Aktualisierung oder Löschung des Plugins verwendet werden soll, etwa en oder de. Beeinflusst nur einige Fehlermeldungen und kann in der Regel weggelassen werden.

Beispiel für Maven