Von Version < 1.5 >
bearbeitet von awa
am 12.03.2020, 10:52
Auf Version < 1.10 >
bearbeitet von awa
am 12.03.2020, 11:02
< >
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -22,13 +22,13 @@
22 22  
23 23  Es muss immer ein HTTP-Post-Request verwendet werden und [[sich an folgende URL richten>>doc:Formcycle.PluginDevelopment.Types.IPluginServletAction]] (Namen des FORMCYCLE-Servers entsprechend anpassen):
24 24  
25 -{{code language="none}}
25 +{{code language="none"}}
26 26  POST http://localhost:8080/formcycle/plugin?name=deploy-plugin&client-id=154 HTTP/1.1
27 27  {{/code}}
28 28  
29 29  Die //client-id// muss nicht angegeben werden, wenn das Plugin als System-Plugin installiert ist.
30 30  
31 -=== Parameter
31 +=== Request-Parameter
32 32  
33 33  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:
34 34  
... ... @@ -38,10 +38,10 @@
38 38  : 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
39 39  ; client-uuid
40 40  : 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.
41 -; token
42 -: Das Token (Password) für die Authorisierung des Requests. Nur erforderlich, wenn in der Plugin-Konfiguration ein Token festgelegt wurde.
43 43  ; jar-file
44 44  : Binärdaten mit der JAR-Datei des Plugins, welches aktualisert oder installiert werden soll.
43 +; token
44 +: Das Token (Password) für die Authorisierung des Requests. Nur erforderlich, wenn in der Plugin-Konfiguration ein Token festgelegt wurde.
45 45  ; plugin-ident
46 46  : Die Art, wie nach einem vorhandenen Plugin gesucht wird (siehe oben). Folgende Werte sind erlaubt:
47 47  :; manifest
... ... @@ -71,4 +71,27 @@
71 71  : 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
72 72  : 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.
73 73  
74 +=== Deploy-Action
75 +
76 +Der Wert des Parameters //deploy-action// gibt an, was genau mit dem Plugin geschehen soll. Es gibt dabei die folgenden Möglichkeiten:
77 +
78 +; update-properties
79 +: 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. Beispiel:
80 + (((
81 +{{code language="bash"}}
82 +# Löscht alle vorhandenen Plugin-Eigenschaften und setzt dann die Eigenschaft "foo" auf den Wert "bar"
83 + curl -X POST \
84 + -F deploy-action=update-properties \
85 + -F token=admin \
86 + -F plugin-ident=manifest \
87 + -F plugin-identifier=Implementation-Title=com.example:plugin \
88 + -F clear-properties=false \
89 + -F property=foo=bar \
90 + "http://localhost:8080/formcycle/plugin?client-id=154&name=deploy-plugin"
91 +{{/code}})))
92 +
93 +== Response
94 +
95 +
96 +
74 74  == Beispiel für Maven ==
Copyright 2000-2025