Wiki-Quellcode von FORMCYCLE-Deploy-Plugin

Zeige letzte Bearbeiter
1 {{content/}}
2
3 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>>doc:Formcycle.UserInterface.Client.Plugins]] einige Vorteile:
4
5 * Plugin-Entwickler können beim Maven-Build das Plugin automatisch am Ende des Builds hochladen. So kann der Entwickler schneller testen.
6 * Eine Installation auf einem Live-System kann so weiter automatisiert werden.
7
8 Das Deploy-Plugin kann sowohl als Mandant-Plugin als auch als System-Plugin installiert werden. Es enthält eine [[Servlet-Aktion>>doc:Formcycle.PluginDevelopment.Types.IPluginServletAction]]. 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.
9
10 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:
11
12 * (**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.
13 * 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>>doc:Formcycle.UserInterface.Client.Plugins]] zu sehen ist.
14 * 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.
15 * 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.
16
17 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.
18
19 == Plugin-Konfiguration ==
20
21 Am Plugin selber kann konfiguriert werden, ob das Deploy-Servlet durch ein Passwort geschützt werden soll. Dieses Passwort muss dann im Klartext beim HTTP-POST-Request mit angegeben werden.
22
23 Zur Konfiguration des Passworts gibt es die eine Plugin-Eigenschaft //token//, diese hat das folgende Format
24
25 {{code language="none"}}
26 hash_method:hashed_value
27 {{/code}}
28
29 Folgende Hash-Methoden stehen zur Verfügung:
30
31 ; plain
32 : Identitätsfunktion, das Passwort im Klartext angegeben.
33 ; sha256
34 : SHA-256-Algorithmus.
35 ; sha384
36 : SHA-384-Algorithmus.
37 ; sha512
38 : SHA-512-Algorithmus.
39
40 Um das Passwort im Klartext beispielsweise auf //admin// festzulegen, wird der folgende Wert für die Plugin-Eigenschaft //token// eingegeben:
41
42 {{code language="none"}}
43 plain:admin
44 {{/code}}
45
46 Um das Passwort mit SHA-256 beispielsweise auf //admin// festzulegen, wird der folgende Wert für die Plugin-Eigenschaft //token// eingegeben:
47
48 {{code language="none"}}
49 sha256:S+32GI3fWXwHHulUMtWmjpQ15EqMvgVYguuO9SKxfNw+ckAGQljP6tKlf1EITnU7
50 {{/code}}
51
52 Der Hash ist gesalzen. Ein gültiger Hash für ein bestimmtes Passwort kann mit dem //create-token//-Servlet erzeugt werden, siehe unten.
53
54
55 == Deploy-Servlet ==
56
57 Im Folgenden wird der Aufbau des HTTP-Requests beschrieben, um ein Plugin zu installieren, zu aktualisieren oder zu löschen.
58
59 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):
60
61 {{code language="none"}}
62 POST http://localhost:8080/formcycle/plugin?name=deploy-plugin&client-id=154 HTTP/1.1
63 {{/code}}
64
65 Die //client-id// muss nicht angegeben werden, wenn das Plugin als System-Plugin installiert ist.
66
67 === Request-Parameter ===
68
69 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:
70
71 ; deploy-action
72 : 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.
73 ; client-id
74 : 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
75 ; client-uuid
76 : 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.
77 ; jar-file
78 : Binärdaten mit der JAR-Datei des Plugins, welches aktualisert oder installiert werden soll.
79 ; token
80 : Das Token (Password) für die Authorisierung des Requests. Nur erforderlich, wenn in der Plugin-Konfiguration ein Token festgelegt wurde.
81 ; plugin-ident
82 : Die Art, wie nach einem vorhandenen Plugin gesucht wird (siehe oben). Folgende Werte sind erlaubt:
83 :; manifest
84 :: Identifiziert ein Plugin anhand eines Eintrags im Manifest.
85 :; id
86 :: Identifiziert ein Plugin anhand seiner Datenbank-ID.
87 :; name
88 :: Identifiziert ein Plugin anhand seines Namens (Dateiname der JAR-Datei)
89 :; uuid
90 :: Identifiziert ein Plugin anhand seiner UUID.
91 ; plugin-identifier
92 : Identifikator des Plugins, welches aktualisiert oder gelöscht werden soll. Die konkrete Bedeutung dieses Parameters ist abhängig von dem Wert von //plugin-ident//:
93 :; plugin-ident=manifest
94 :: //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.
95 :; plugin-ident=id
96 :: //plugin-identifier// muss die gewünschte ID des Plugins enthalten, etwa //53// oder /893//.//
97 :; plugin-ident=name
98 :: //plugin-identifier// muss den gewünschten Names des Plugins enthalten, etwa //my-plugin.jar// oder /foobar.jar//.//
99 :; plugin-ident=uuid
100 :: //plugin-identifier// muss die gewünschte UUID des Plugins enthalten, etwa //03022599-903d-429b-9822-80a324a542fc//.
101 Andernfalls wird das Plugin installiert, falls noch nicht vorhanden, oder aktualisiert, falls vorhanden.
102 ; clear-properties
103 : 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.
104 ; property
105 : 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.
106 ; disallow-install
107 : 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
108 : 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.
109
110 === Deploy-Action ===
111
112 Der Wert des Parameters //deploy-action// gibt an, was genau mit dem Plugin geschehen soll. Es gibt dabei die folgenden Möglichkeiten:
113
114 ; save
115 : Ü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.
116
117 (((
118 {{code language="bash"}}
119 # Installiert oder aktualisiert das Plugin mit dem Implementation-Title com.example:plugin
120 curl -X POST \
121 -F deploy-action=save \
122 -F token=admin \
123 -F plugin-ident=manifest \
124 -F plugin-identifier=Implementation-Title=com.example:plugin \
125 -F "jar-file=@my-plugin.jar" \
126 "http://localhost:8080/formcycle/plugin?client-id=154&name=deploy-plugin"
127 {{/code}}
128 )))
129
130 ; delete
131 : Löscht das angegebene Plugin. Es darf hierbei keine JAR-Datei übertragen werden. Existiert das angegebene Plugin nicht, wird ein Fehler zurückgegeben. Beispiel:
132
133 (((
134 {{code language="bash"}}
135 # Löscht das Plugin mit dem Implementation-Title com.example:plugin
136 curl -X POST \
137 -F deploy-action=delete \
138 -F token=admin \
139 -F plugin-ident=manifest \
140 -F plugin-identifier=Implementation-Title=com.example:plugin \
141 "http://localhost:8080/formcycle/plugin?client-id=154&name=deploy-plugin"
142 {{/code}}
143 )))
144
145 ; activate
146 : 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. Beispiel:
147
148 (((
149 {{code language="bash"}}
150 # Aktiviert das Plugin mit dem Implementation-Title com.example:plugin
151 curl -X POST \
152 -F deploy-action=activate \
153 -F token=admin \
154 -F plugin-ident=manifest \
155 -F plugin-identifier=Implementation-Title=com.example:plugin \
156 "http://localhost:8080/formcycle/plugin?client-id=154&name=deploy-plugin"
157 {{/code}}
158 )))
159
160 ; deactivate
161 : 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. Beispiel:
162
163 (((
164 {{code language="bash"}}
165 # Deaktiviert oder aktualisiert das Plugin mit dem Implementation-Title com.example:plugin
166 curl -X POST \
167 -F deploy-action=deactivate \
168 -F token=admin \
169 -F plugin-ident=manifest \
170 -F plugin-identifier=Implementation-Title=com.example:plugin \
171 "http://localhost:8080/formcycle/plugin?client-id=154&name=deploy-plugin"
172 {{/code}}
173 )))
174
175 ; update-properties
176 : 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:
177 (((
178 {{code language="bash"}}
179 # Löscht alle vorhandenen Plugin-Eigenschaften und setzt dann die Eigenschaft "foo" auf den Wert "bar"
180 curl -X POST \
181 -F deploy-action=update-properties \
182 -F token=admin \
183 -F plugin-ident=manifest \
184 -F plugin-identifier=Implementation-Title=com.example:plugin \
185 -F clear-properties=false \
186 -F property=foo=bar \
187 "http://localhost:8080/formcycle/plugin?client-id=154&name=deploy-plugin"
188 {{/code}}
189 )))
190
191 === Response ===
192
193 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.
194
195 Das JSON-Objekt hat dabei [[die folgende Struktur>>https://json-schema.org/]]:
196
197 {{code language="json"}}
198 {
199 "$schema": "http://json-schema.org/schema",
200 "description": "Represents the response of the deploy plugin servlet.",
201 "required": [
202 "success",
203 "statusCode",
204 "details",
205 "message",
206 "requestParameters"
207 ],
208 "properties": {
209 "success": {
210 "type": "boolean",
211 "title": "Success status",
212 "description": "true if the deploy plugin servlet was executed successfully, or false otherwise"
213 },
214 "statusCode": {
215 "type": "number",
216 "title": "HTTP status code",
217 "description": "The status code of the HTTP request that contains this response."
218 },
219 "details": {
220 "type": "object",
221 "title": "Result details",
222 "description": "Detailed information about the plugin processed by the deploy plugin servlet.",
223 "oneOf": [
224 {
225 "description": "If the deploy plugin servlet was successful, details about the successfully executed action.",
226 "required": [
227 "id",
228 "uuid",
229 "name",
230 "active",
231 "message"
232 ],
233 "properties": {
234 "id": {
235 "type": "number",
236 "title": "Plugin ID",
237 "description": "The database ID of the processed plugin."
238 },
239 "uuid": {
240 "type": "string",
241 "title": "Plugin UUID",
242 "description": "The UUID of the processed plugin."
243 },
244 "name": {
245 "type": "string",
246 "title": "Plugin name",
247 "description": "The name of the processed plugin, i.e. the file name of the plugin JAR file."
248 },
249 "active": {
250 "type": "boolean",
251 "title": "Plugin activation status",
252 "description": "true if the plugin is now active, false if it is now inactive."
253 },
254 "message": {
255 "type": "string",
256 "title": "Result message",
257 "description": "Human-readable message describing the performed action."
258 }
259 }
260 },
261 {
262 "required": [
263 "exceptionType",
264 "exceptionMessage"
265 ],
266 "description": "If the deploy plugin servlet was unsuccessful, details about the error that occurred.",
267 "properties": {
268 "exceptionType": {
269 "type": "string",
270 "title": "Exception type",
271 "description": "The type of the error that occurred, a fully-classified name of the Java exception class."
272 },
273 "exceptionMessage": {
274 "type": "string",
275 "title": "Exception message",
276 "description": "The human-readable message of the error that occurred."
277 }
278 }
279 }
280 ]
281 },
282 "message": {
283 "type": "string",
284 "title": "Result message",
285 "description": "A human-readable message that describes this result."
286 },
287 "requestParameters": {
288 "type": "object",
289 "title": "Request parameters",
290 "description": "The parameters of the request that triggered this response."
291 }
292 }
293 }
294 {{/code}}
295
296 Beispiel für die Antwort beim Aktualisieren eines Plugins:
297
298 {{code language="json"}}
299 {
300 "success": true,
301 "requestParameters": {
302 "plugin-ident": ["manifest"],
303 "name": ["deploy-plugin"],
304 "client-id": ["1"],
305 "deploy-action": ["save"],
306 "plugin-identifier": ["Implementation-Title=com.example:plugin"],
307 "token": ["admin"]
308 },
309 "details": {
310 "name": "my-plugin.jar",
311 "active": true,
312 "id": 203,
313 "message": "Plugin saved successfully.",
314 "uuid": "2fe3e1ba-cb32-434e-9f59-4422f8dabcad"
315 },
316 "message": "Plugin saved successfully.",
317 "statusCode": 200
318 }
319 {{/code}}
320
321 Beispiel für die Antwort beim Löschen, falls das angegebene Plugin nicht gefunden wurde:
322
323 {{code language="json"}}
324 {
325 "success": false,
326 "requestParameters": {
327 "plugin-ident": ["manifest"],
328 "name": ["deploy-plugin"],
329 "client-id": ["1"],
330 "deploy-action": ["delete"],
331 "plugin-identifier": ["Implementation-Title=com.example:plugin"],
332 "token": ["admin"]
333 },
334 "details": {
335 "exceptionType": "java.lang.IllegalArgumentException",
336 "exceptionMessage": "Deploy action 'delete' requires an existing pluign, but none was found."
337 },
338 "message": "class java.lang.IllegalArgumentException: Deploy action 'delete' requires an existing pluign, but none was found.",
339 "statusCode": 404
340 }
341 {{/code}}
342
343
344 == Create-Token-Servlet ==
345
346 Mit diesem Servlet kann ein Hash für ein bestimmtes Klartextpasswort erzeugt werden, welcher dann in der Plugin-Eigenschaft //token// hinterlegt werden kann. Es muss hierbei ein HTTP-GET-Request verwendet werden (Pfad auf den FORMCYCLE-Servet und die Mandant-ID entsprechend ersetzen):
347
348 {{code language="none"}}
349 http://localhost:8080/formcycle/plugin?client-id=1&name=create-token&token=<PASSWORT>&method=<METHOD>
350 {{/code}}
351
352 ; token
353 : Der Klartext des Passwort, zu dem ein Hash ermittelt werden soll.
354 ; method
355 : Methode zum Berechnen des Hashes. Erlaubte Werte sind //plain//, //sha256//, //sha384// und //sha512//. Optional, Standardwert ist //sha256//.
356
357 Als Antwort wird ein JSON zurückgeliefert, welches das gleiche Format wie die Antwort des Deploy-Plugins hat. Beispiel für eine Antwort:
358
359 {{code language="json"}}
360 {
361 "success": true,
362 "requestParameters": {
363 "name": ["create-token"],
364 "client-id": ["1"],
365 "token": ["admin"]
366 },
367 "details": {
368 "method": "sha256",
369 "token": "sha256:S+32GI3fWXwHHulUMtWmjpQ15EqMvgVYguuO9SKxfNw+ckAGQljP6tKlf1EITnU7"
370 },
371 "message": "Hash token created successfully",
372 "statusCode": 200
373 }
374 {{/code}}
375
376 == Maven-Deploy-Plugin ==
377
378 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:
379
380 {{code language="xml"}}
381 <plugin>
382 <groupId>de.xima.fc.maven.plugin</groupId>
383 <artifactId>fc-deploy-plugin-maven-plugin</artifactId>
384 <version>1.1.0</version>
385 <configuration>
386 <url>http://localhost:8080/formcycle</url>
387 <pluginName>deploy-plugin</pluginName>
388 <clientId>52</clientId>
389 <token>admin</token>
390 <deployAction>save</deployAction>
391 <pluginIdent>name</manifest>
392 <pluginIdentifier>my-plugin.jar</pluginIdentifier>
393 <jarFile></jarFile>
394 <disallowInstall>false</disallowInstall>
395 <locale>en</locale>
396 <clearProperties>true</clearProperties>
397 <properties>
398 <property1>value1</property1>
399 <property2>value2</property2>
400 <properties>
401 </configuration>
402 </plugin
403 {{/code}}
404
405 Das Plugin hat die folgenden Optionen zur Konfiguration:
406
407 ; url [Standardwert: //${fcDeployUrl}//]
408 : URL mit Kontextpfad zum FORMCYCLE-Server, etwa //http://localhost:8080/formcycle//
409 ; pluginName [Standardwert: //deploy-plugin//]
410 : Der Name des Deploy-Plugins für den URL-Parameter //name//. In der Regel muss diese Option nicht gesetzt werden, der Standardwert ist ausreichend.
411 ; clientId [Standardwert: //${fcDeployClientId}//]
412 : 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.
413 ; clientUuid
414 : 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.
415 ; token [Standardwert: ${fcDeployToken}]
416 : Passwort für das Servlet-Plugin, falls in der Konfiguration des Deploy-Plugins ein Passwort gesetzt wurde.
417 ; deployAction [Standardwert: //save//]
418 : 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.
419 ; pluginIdent [Standardwert: //manifest//]
420 : Die Art, wie nach einem vorhandenen Plugin gesucht wird. Entspricht dem Parameter //plugin-ident// des Deploy-Plugins, siehe oben.
421 ; pluginIdentifier [Standardwert: //Implementation-Title=${project.groupId}:${project.artifactId}//]
422 : Identifikator des Plugins, welches aktualisiert oder gelöscht werden soll. Entspricht dem Parameter //plugin-identifier// des Deploy-Plugins, siehe oben.
423 ; jarFile [Standartwert: Haupt-Build-Artifakt des Maven-Projekts]
424 : Pfad zur JAR-Datei, die hochgeladen werden soll, relativ zum Basisverzeichnis des Maven-Projekts.
425 ; disallowInstall [Standardwert: //false//]
426 : 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.
427 ; locale [Standardwert: //en//]
428 : Sprache, die für die Installation, Aktualisierung oder Löschung des Plugins genutzt wird. Entspricht dem Parameter //locale// des Deploy-Plugins, siehe oben.
429 ; clearProperties [Standardwert: //false//]
430 : Löscht die Werte aller Plugin-Eigenschaften. Entspricht dem Parameter //clear-properties// des Deploy-Plugins, siehe oben.
431 ; properties
432 : Key-Value-Paare mit Eigenschaften, die an dem Plugin gesetzt werden sollen. Entspricht dem Parameter //clear-properties// des Deploy-Plugins, siehe oben.

Navigation

Copyright 2000-2025