Zusammenfassung

• Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Inhalt

...	...	@@ -18,22 +18,15 @@
18	18
19	19	== Plugin-Konfiguration ==
20	20
21		-Am Plugin selber kann konfiguriert werden, ob das Deploy-Servlet durch ein Passwort geschützt werden soll. Dazu gibt es die eine Plugin-Eigenschaft //token//, diese hat das folgende Format
	21	+== HTTP-Request-Aufbau ==
22	22
23		-> hash_method:hashed_value
24		-
25		-Folgende Hash-Methoden stehen zur Verfügung:
26		-
27		-; plain
28		-: asd
29		-
30		-== Deploy-Servlet ==
31		-
32	32	Im Folgenden wird der Aufbau des HTTP-Requests beschrieben, um ein Plugin zu installieren, zu aktualisieren oder zu löschen.
33	33
34	34	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):
35	35
36		-> POST http://localhost:8080/formcycle/plugin?name=deploy-plugin&client-id=154 HTTP/1.1
	27	+{{code language="none"}}
	28	+POST http://localhost:8080/formcycle/plugin?name=deploy-plugin&client-id=154 HTTP/1.1
	29	+{{/code}}
37	37
38	38	Die //client-id// muss nicht angegeben werden, wenn das Plugin als System-Plugin installiert ist.
39	39
...	...	@@ -89,8 +89,8 @@
89	89
90	90	(((
91	91	{{code language="bash"}}
92		-# Installiert oder aktualisiert das Plugin mit dem Implementation-Title com.example:plugin
93	93	curl -X POST \
	86	+ # These options are required
94	94	-F deploy-action=save \
95	95	-F token=admin \
96	96	-F plugin-ident=manifest \
...	...	@@ -105,8 +105,8 @@
105	105
106	106	(((
107	107	{{code language="bash"}}
108		-# Löscht das Plugin mit dem Implementation-Title com.example:plugin
109	109	curl -X POST \
	102	+ # These options are required
110	110	-F deploy-action=delete \
111	111	-F token=admin \
112	112	-F plugin-ident=manifest \
...	...	@@ -116,12 +116,12 @@
116	116	)))
117	117
118	118	; activate
119		-: 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:
	112	+: Aktiviert das angegebene Plugin. Es darf hierbei keine JAR-Datei übertragen werden. Existiert das angegebene Plugin nicht, wird ein Fehler zurückgegeben. Beispiel:
120	120
121	121	(((
122	122	{{code language="bash"}}
123		-# Aktiviert das Plugin mit dem Implementation-Title com.example:plugin
124	124	curl -X POST \
	117	+ # These options are required
125	125	-F deploy-action=activate \
126	126	-F token=admin \
127	127	-F plugin-ident=manifest \
...	...	@@ -131,12 +131,12 @@
131	131	)))
132	132
133	133	; deactivate
134		-: 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:
	127	+: Deaktiviert das angegebene Plugin. Es darf hierbei keine JAR-Datei übertragen werden. Existiert das angegebene Plugin nicht, wird ein Fehler zurückgegeben. Beispiel:
135	135
136	136	(((
137	137	{{code language="bash"}}
138		-# Deaktiviert oder aktualisiert das Plugin mit dem Implementation-Title com.example:plugin
139	139	curl -X POST \
	132	+ # These options are required
140	140	-F deploy-action=deactivate \
141	141	-F token=admin \
142	142	-F plugin-ident=manifest \
...	...	@@ -147,6 +147,7 @@
147	147
148	148	; update-properties
149	149	: 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:
	143	+
150	150	(((
151	151	{{code language="bash"}}
152	152	# Löscht alle vorhandenen Plugin-Eigenschaften und setzt dann die Eigenschaft "foo" auf den Wert "bar"
...	...	@@ -266,53 +266,4 @@
266	266	}
267	267	{{/code}}
268	268
269		-Beispiel für die Antwort beim Aktualisieren eines Plugins:
270		-
271		-{{code language="json"}}
272		-{
273		- "success": true,
274		- "requestParameters": {
275		- "plugin-ident": ["manifest"],
276		- "name": ["deploy-plugin"],
277		- "client-id": ["1"],
278		- "deploy-action": ["save"],
279		- "plugin-identifier": ["Implementation-Title=com.example:plugin"],
280		- "token": ["admin"]
281		- },
282		- "details": {
283		- "name": "my-plugin.jar",
284		- "active": true,
285		- "id": 203,
286		- "message": "Plugin saved successfully.",
287		- "uuid": "2fe3e1ba-cb32-434e-9f59-4422f8dabcad"
288		- },
289		- "message": "Plugin saved successfully.",
290		- "statusCode": 200
291		-}
292		-{{/code}}
293		-
294		-Beispiel für die Antwort beim Löschen, falls das angegebene Plugin nicht gefunden wurde:
295		-
296		-{{code language="json"}}
297		-{
298		- "success": false,
299		- "requestParameters": {
300		- "plugin-ident": ["manifest"],
301		- "name": ["deploy-plugin"],
302		- "client-id": ["1"],
303		- "deploy-action": ["delete"],
304		- "plugin-identifier": ["Implementation-Title=com.example:plugin"],
305		- "token": ["admin"]
306		- },
307		- "details": {
308		- "exceptionType": "java.lang.IllegalArgumentException",
309		- "exceptionMessage": "Deploy action 'delete' requires an existing pluign, but none was found."
310		- },
311		- "message": "class java.lang.IllegalArgumentException: Deploy action 'delete' requires an existing pluign, but none was found.",
312		- "statusCode": 404
313		-}
314		-{{/code}}
315		-
316		-
317	317	== Beispiel für Maven ==
318		-