sha256:S+32GI3fWXwHHulUMtWmjpQ15EqMvgVYguuO9SKxfNw+ckAGQljP6tKlf1EITnU7

Der Hash ist gesalzen. Ein gültiger Hash für ein bestimmtes Passwort kann mit dem create-token-Servlet erzeugt werden, siehe unten.

Deploy-Servlet

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):

POST http://localhost:8080/formcycle/plugin?name=deploy-plugin&client-id=154 HTTP/1.1

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

Request-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.

save

Überträgt das angegebene Plugin auf das formcycle-System. Es muss hierbei eine JAR-Datei übertragen werden. Falls das Plugin noch nicht existiert (und der Parameter disallow-install nicht gesetzt ist), wird das Plugin neu installiert und ist dann aktiviert. Andernfalls, falls das Plugin bereits existiert, wird es aktualisiert, dabei bleibt das Plugin aktiviert oder deaktiviert.

delete

Löscht das angegebene Plugin. Es darf hierbei keine JAR-Datei übertragen werden. Existiert das angegebene Plugin nicht, wird ein Fehler zurückgegeben.

activate

Aktiviert das angegebene Plugin. Es darf hierbei keine JAR-Datei übertragen werden. Existiert das angegebene Plugin nicht, wird ein Fehler zurückgegeben. Ist das Plugin bereits aktiviert, wird nicht getan und ein Erfolg zurückgegeben.

deactivate

Deaktiviert das angegebene Plugin. Es darf hierbei keine JAR-Datei übertragen werden. Existiert das angegebene Plugin nicht, wird ein Fehler zurückgegeben. Ist das Plugin bereits deaktiviert, wird nicht getan und ein Erfolg zurückgegeben.

update-properties

Aktualisiert die Eigenschaften des angegebenen Plugins. Es darf hierbei keine JAR-Datei übertragen werden. Entweder die Eigenschaft clear-properties oder property sollte gesetzt sein. Existiert das angegebene Plugin nicht, wird ein Fehler zurückgegeben.

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 (Passwort) 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:

key

Identifiziert ein Plugin des Eintrags Plugin-Key und optional Plugin-File-Key im Manifest.

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=key

plugin-identifier muss den Plugin-Key und optional den Plugin-File-Key enthalten, im Format [key]/[fileKey]. Wird kein Plugin-File-Key benötigt, ist auch der Schrägstrich wegzulassen.

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.

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. Andernfalls wird das Plugin installiert, falls noch nicht vorhanden, oder aktualisiert, falls vorhanden.

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.

Beispiele

# Installiert oder aktualisiert das Plugin mit dem
# Plugin-Key 84477e1c-19d2-4c09-a0a3-ae3457812b7e

curl -X POST \
   -F deploy-action=save \
   -F token=admin \
   -F plugin-ident=key \
   -F plugin-identifier=84477e1c-19d2-4c09-a0a3-ae3457812b7e \
   -F "jar-file=@my-plugin.jar" \
   "http://localhost:8080/formcycle/plugin?client-id=154&name=deploy-plugin"

# Löscht das Plugin mit dem 
# Plugin-Key 84477e1c-19d2-4c09-a0a3-ae3457812b7e

curl -X POST \
   -F deploy-action=delete \
   -F token=admin \
   -F plugin-ident=key \
   -F plugin-identifier=84477e1c-19d2-4c09-a0a3-ae3457812b7e \
   "http://localhost:8080/formcycle/plugin?client-id=154&name=deploy-plugin"

# Aktiviert das Plugin mit dem 
# Plugin-Key 84477e1c-19d2-4c09-a0a3-ae3457812b7e

curl -X POST \
   -F deploy-action=activate \
   -F token=admin \
   -F plugin-ident=key \
   -F plugin-identifier=84477e1c-19d2-4c09-a0a3-ae3457812b7e \
   "http://localhost:8080/formcycle/plugin?client-id=154&name=deploy-plugin"

# Deaktiviert oder aktualisiert das Plugin mit dem
# Plugin-Key 84477e1c-19d2-4c09-a0a3-ae3457812b7e

curl -X POST \
   -F deploy-action=deactivate \
   -F token=admin \
   -F plugin-ident=key \
   -F plugin-identifier=84477e1c-19d2-4c09-a0a3-ae3457812b7e \
   "http://localhost:8080/formcycle/plugin?client-id=154&name=deploy-plugin"

# Löscht alle vorhandenen Plugin-Eigenschaften und setzt
# dann die Eigenschaft "foo" auf den Wert "bar"

curl -X POST \
   -F deploy-action=update-properties \
   -F token=admin \
   -F plugin-ident=key \
   -F plugin-identifier=84477e1c-19d2-4c09-a0a3-ae3457812b7e \
   -F clear-properties=false \ 
   -F property=foo=bar \
   "http://localhost:8080/formcycle/plugin?client-id=154&name=deploy-plugin"

Response

Das Deploy-Plugin liefert einen Statuscode und ein JSON-Objekt mit den Details zurück. Der Status-Code ist 2xx, falls das Deploy-Plugin erfolgreich ausgeführt wurde.

Das JSON-Objekt hat dabei die folgende Struktur:

{
    "$schema": "http://json-schema.org/schema",
    "description": "Represents the response of the deploy plugin servlet.",
    "required": [
        "success",
        "statusCode",
        "details",
        "message",
        "requestParameters"
    ],
    "properties": {
        "success": {
            "type": "boolean",
            "title": "Success status",
            "description": "true if the deploy plugin servlet was executed successfully, or false otherwise"
        },
        "statusCode": {
            "type": "number",
            "title": "HTTP status code",
            "description": "The status code of the HTTP request that contains this response."
        },
        "details": {
            "type": "object",
            "title": "Result details",
            "description": "Detailed information about the plugin processed by the deploy plugin servlet.",
            "oneOf": [
                {
                    "description": "If the deploy plugin servlet was successful, details about the successfully executed action.",
                    "required": [
                        "id",
                        "uuid",
                        "name",
                        "active",
                        "message"
                    ],
                    "properties": {
                        "id": {
                            "type": "number",
                            "title": "Plugin ID",
                            "description": "The database ID of the processed plugin."
                        },
                        "uuid": {
                            "type": "string",
                            "title": "Plugin UUID",
                            "description": "The UUID of the processed plugin."
                        },
                        "name": {
                            "type": "string",
                            "title": "Plugin name",
                            "description": "The name of the processed plugin, i.e. the file name of the plugin JAR file."
                        },
                        "active": {
                            "type": "boolean",
                            "title": "Plugin activation status",
                            "description": "true if the plugin is now active, false if it is now inactive."
                        },
                        "message": {
                            "type": "string",
                            "title": "Result message",
                            "description": "Human-readable message describing the performed action."
                        }
                    }
                },
                {
                    "required": [
                        "exceptionType",
                        "exceptionMessage"
                    ],
                    "description": "If the deploy plugin servlet was unsuccessful, details about the error that occurred.",
                    "properties": {
                        "exceptionType": {
                            "type": "string",
                            "title": "Exception type",
                            "description": "The type of the error that occurred, a fully-classified name of the Java exception class."
                        },
                        "exceptionMessage": {
                            "type": "string",
                            "title": "Exception message",
                            "description": "The human-readable message of the error that occurred."
                        }
                    }
                }
            ]
        },
        "message": {
            "type": "string",
            "title": "Result message",
            "description": "A human-readable message that describes this result."
        },
        "requestParameters": {
            "type": "object",
            "title": "Request parameters",
            "description": "The parameters of the request that triggered this response."
        }
    }
}

Beispiel für die Antwort beim Aktualisieren eines Plugins:

{
 "success": true,
 "requestParameters": {
  "plugin-ident": ["key"],
  "name": ["deploy-plugin"],
  "client-id": ["1"],
  "deploy-action": ["save"],
  "plugin-identifier": ["84477e1c-19d2-4c09-a0a3-ae3457812b7e"],
  "token": ["admin"]
 },
 "details": {
  "name": "my-plugin.jar",
  "active": true,
  "id": 203,
  "message": "Plugin saved successfully.",
  "uuid": "2fe3e1ba-cb32-434e-9f59-4422f8dabcad"
 },
 "message": "Plugin saved successfully.",
 "statusCode": 200
}

Beispiel für die Antwort beim Löschen, falls das angegebene Plugin nicht gefunden wurde:

{
 "success": false,
 "requestParameters": {
  "plugin-ident": ["key"],
  "name": ["deploy-plugin"],
  "client-id": ["1"],
  "deploy-action": ["delete"],
  "plugin-identifier": ["84477e1c-19d2-4c09-a0a3-ae3457812b7e"],
  "token": ["admin"]
 },
 "details": {
  "exceptionType": "java.lang.IllegalArgumentException",
  "exceptionMessage": "Deploy action 'delete' requires an existing pluign, but none was found."
 },
 "message": "class java.lang.IllegalArgumentException: Deploy action 'delete' requires an existing pluign, but none was found.",
 "statusCode": 404
}

Create-Token-Servlet

Mit diesem Servlet kann ein Hash für ein bestimmtes Klartextpasswort erzeugt werden, welcher dann in der Plugin-Eigenschaft token hinterlegt werden kann. Dies ist wichtig, wenn das Deployen von jedem Beliebigem Nutzer verhindert werden soll. Es muss hierbei ein HTTP-GET-Request verwendet werden (Pfad auf den formcycle-Server und die Mandant-ID entsprechend ersetzen):

http://localhost:8080/formcycle/plugin?client-id=1&name=create-token&token=<PASSWORD>&method=<METHOD>

token

Der Klartext des Passwort, zu dem ein Hash ermittelt werden soll.

method

Methode zum Berechnen des Hashes. Erlaubte Werte sind plain, sha256, sha384 und sha512. Optional, Standardwert ist sha256.

Als Antwort wird ein JSON zurückgeliefert, welches das gleiche Format wie die Antwort des Deploy-Plugins hat. Beispiel für eine Antwort:

{
 "success": true,
 "requestParameters": {
  "name": ["create-token"],
  "client-id": ["1"],
  "token": ["admin"]
 },
 "details": {
  "method": "sha256",
  "token": "sha256:S+32GI3fWXwHHulUMtWmjpQ15EqMvgVYguuO9SKxfNw+ckAGQljP6tKlf1EITnU7"
 },
 "message": "Hash token created successfully",
 "statusCode": 200
}

Maven-Deploy-Plugin

Um ein Plugin nach dem Bauen über Maven in formcycle hochzuladen, gibt es auch ein Maven-Plugin, welches das Deploy-Servlet anspricht. Dieses ist über die Artifactory von XIMA erhältlich, falls man die entsprechenden Rechte hierfür hat:

Empfehlung für Plugin-Projekt

Während das Plugin zahlreiche Einstellunsgmöglichkeiten anbietet, reichen meist die Standardwerte aus. Empfohlen wird das folgende Vorgehen bei der Entwicklung von Plugin-Projekten.

Folgendes Schnippsel sollte in der Profil-Sektion der pom.xml eingefügt werden:

<build>
  <plugins>
    <plugin>
      <groupId>de.xima.fc.maven.plugin</groupId>
      <artifactId>fc-deploy-plugin-maven-plugin</artifactId>
      <version>${fc-deploy-plugin-maven-plugin.version}</version>
    </plugin>
  </plugins>
</build>

Das Plugin wird dann anhand seiner Standard-ID identifiziert, die seit Version 8 von formcycle jedes Plugin haben muss. Hierzu muss der Wert korrekt im Manifest gesetzt werden. Dies kann etwa über das maven-assembly-plugin geschehen:

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-assembly-plugin</artifactId>
      <version>${maven-assembly-plugin.version}</version>
      <executions>
        <execution>
          <id>fat-jar</id>
          <configuration>
            <archive>
              <manifestEntries>
                <Plugin-Repository>none</Plugin-Repository>
                <Plugin-Key>PLUGIN_ID</Plugin-Key>
              </manifestEntries>
            </archive>
          </configuration>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

Nun kann das Plugin über Maven gebaut und hochgeladen werden. 

mvn fc-deploy:deploy

mvn fc-deploy:deploy \
  -DfcDeployUrl=http://host:8082/fc \
  -DfcDeployToken=pass \
  -DfcDeployClientId=42

Konfiguration

Bei Bedarf können auch weitere Einstellungen getroffen werden:

<plugin>
    <groupId>de.xima.fc.maven.plugin</groupId>
    <artifactId>fc-deploy-plugin-maven-plugin</artifactId>
    <version>${fc-deploy-plugin-maven-plugin.version}</version>
    <configuration>
        <url>http://localhost:8080/formcycle</url>
        <pluginName>deploy-plugin</pluginName>
        <clientId>52</clientId>
        <token>admin</token>
        <deployAction>save</deployAction>
        <pluginIdent>key</manifest>
        <pluginIdentifier>PLUGIN_ID</pluginIdentifier>
        <jarFile></jarFile>
        <disallowInstall>false</disallowInstall>
        <locale>en</locale>
        <clearProperties>true</clearProperties>
        <properties>
            <property1>value1</property1>
            <property2>value2</property2>
        <properties>
   </configuration>
</plugin>

Das Plugin hat die folgenden Optionen zur Konfiguration:

url [Standardwert: http://localhost:8080/xima-formcycle]

URL mit Kontextpfad zum FORMCYCLE-Server, etwa http://localhost:8080/formcycle Kann auch gesetzt werden über die System-Property -DfcDeployUrl=...

pluginName [Standardwert: deploy-plugin]

Der Name des Deploy-Plugins für den URL-Parameter name. In der Regel muss diese Option nicht gesetzt werden, der Standardwert ist ausreichend.

clientId [Standardwert: <leer>]

ID des Mandanten, für den das Plugin installiert, aktualisiert oder gelöscht werden soll. Entspricht dem Parameter client-id des Deploy-Plugins, siehe oben. Kann auch gesetzt werden über die System-Property -DfcDeployClientId=...

clientUuid

Alternative zu clientID. UUID des Mandanten, für den das Plugin installiert, aktualisiert oder gelöscht werden soll. Entspricht dem Parameter client-uuid des Deploy-Plugins, siehe oben.

token [Standardwert: admin]

Passwort für das Servlet-Plugin, falls in der Konfiguration des Deploy-Plugins ein Passwort gesetzt wurde. Kann auch gesetzt werden über die System-Property -DfcDeployToken=... 

deployAction [Standardwert: save]

Aktion, welche mit dem Plugin durchgeführt werden soll. Erlaubte Werte sind save, update-properties, activate, deactivate und delete. Entspricht dem Parameter deploy-action des Deploy-Plugins, siehe oben.

pluginIdent [Standardwert: manifest]

Die Art, wie nach einem vorhandenen Plugin gesucht wird. Entspricht dem Parameter plugin-ident des Deploy-Plugins, siehe oben.

pluginIdentifier [Standardwert: (Plugin-Key aus Manifest des Plugins)]

Identifikator des Plugins, welches aktualisiert oder gelöscht werden soll. Entspricht dem Parameter plugin-identifier des Deploy-Plugins, siehe oben.

jarFile [Standartwert: Haupt-Build-Artifakt des Maven-Projekts]

Pfad zur JAR-Datei, die hochgeladen werden soll, relativ zum Basisverzeichnis des Maven-Projekts.

disallowInstall [Standardwert: false]

Wenn true und das Plugin noch nicht existiert, wird abgebrochen und ein Fehler zurückgegeben. Entspricht dem Parameter disallow-install des Deploy-Plugins, siehe oben.

locale [Standardwert: en]

Sprache, die für die Installation, Aktualisierung oder Löschung des Plugins genutzt wird. Entspricht dem Parameter locale des Deploy-Plugins, siehe oben.

clearProperties [Standardwert: false]

Löscht die Werte aller Plugin-Eigenschaften. Entspricht dem Parameter clear-properties des Deploy-Plugins, siehe oben.

properties

Key-Value-Paare mit Eigenschaften, die an dem Plugin gesetzt werden sollen. Entspricht dem Parameter property des Deploy-Plugins, siehe oben.