Zusammenfassung

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

Details

Seiteneigenschaften

Inhalt

...	...	@@ -16,19 +16,28 @@
16	16
17	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	18
19		-== HTTP-Request-Aufbau ==
	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
	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	+
21	21	Im Folgenden wird der Aufbau des HTTP-Requests beschrieben, um ein Plugin zu installieren, zu aktualisieren oder zu löschen.
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"}}
26		-POST http://localhost:8080/formcycle/plugin?name=deploy-plugin&client-id=154 HTTP/1.1
27		-{{/code}}
	36	+> POST http://localhost:8080/formcycle/plugin?name=deploy-plugin&client-id=154 HTTP/1.1
28	28
29	29	Die //client-id// muss nicht angegeben werden, wenn das Plugin als System-Plugin installiert ist.
30	30
31		-=== Request-Parameter
	40	+=== 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
...	...	@@ -57,9 +57,9 @@
57	57	:; plugin-ident=manifest
58	58	:: //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.
59	59	:; plugin-ident=id
60		-:: //plugin-identifier// muss die gewünschte ID des Plugins enthalten, etwa //53// oder /893//.
	69	+:: //plugin-identifier// muss die gewünschte ID des Plugins enthalten, etwa //53// oder /893//.//
61	61	:; plugin-ident=name
62		-:: //plugin-identifier// muss den gewünschten Names des Plugins enthalten, etwa //my-plugin.jar// oder /foobar.jar//.
	71	+:: //plugin-identifier// muss den gewünschten Names des Plugins enthalten, etwa //my-plugin.jar// oder /foobar.jar//.//
63	63	:; plugin-ident=uuid
64	64	:: //plugin-identifier// muss die gewünschte UUID des Plugins enthalten, etwa //03022599-903d-429b-9822-80a324a542fc//.
65	65	Andernfalls wird das Plugin installiert, falls noch nicht vorhanden, oder aktualisiert, falls vorhanden.
...	...	@@ -71,16 +71,17 @@
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
	83	+=== Deploy-Action ===
75	75
76	76	Der Wert des Parameters //deploy-action// gibt an, was genau mit dem Plugin geschehen soll. Es gibt dabei die folgenden Möglichkeiten:
77	77
78	78	; save
79	79	: Ü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.
	89	+
80	80	(((
81	81	{{code language="bash"}}
	92	+# Installiert oder aktualisiert das Plugin mit dem Implementation-Title com.example:plugin
82	82	curl -X POST \
83		- # These options are required
84	84	-F deploy-action=save \
85	85	-F token=admin \
86	86	-F plugin-ident=manifest \
...	...	@@ -89,12 +89,14 @@
89	89	"http://localhost:8080/formcycle/plugin?client-id=154&name=deploy-plugin"
90	90	{{/code}}
91	91	)))
	102	+
92	92	; delete
93	93	: Löscht das angegebene Plugin. Es darf hierbei keine JAR-Datei übertragen werden. Existiert das angegebene Plugin nicht, wird ein Fehler zurückgegeben. Beispiel:
	105	+
94	94	(((
95	95	{{code language="bash"}}
	108	+# Löscht das Plugin mit dem Implementation-Title com.example:plugin
96	96	curl -X POST \
97		- # These options are required
98	98	-F deploy-action=delete \
99	99	-F token=admin \
100	100	-F plugin-ident=manifest \
...	...	@@ -102,12 +102,14 @@
102	102	"http://localhost:8080/formcycle/plugin?client-id=154&name=deploy-plugin"
103	103	{{/code}}
104	104	)))
	117	+
105	105	; activate
106		-: Aktiviert das angegebene Plugin. Es darf hierbei keine JAR-Datei übertragen werden. Existiert das angegebene Plugin nicht, wird ein Fehler zurückgegeben. Beispiel:
	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:
	120	+
107	107	(((
108	108	{{code language="bash"}}
	123	+# Aktiviert das Plugin mit dem Implementation-Title com.example:plugin
109	109	curl -X POST \
110		- # These options are required
111	111	-F deploy-action=activate \
112	112	-F token=admin \
113	113	-F plugin-ident=manifest \
...	...	@@ -115,12 +115,14 @@
115	115	"http://localhost:8080/formcycle/plugin?client-id=154&name=deploy-plugin"
116	116	{{/code}}
117	117	)))
	132	+
118	118	; deactivate
119		-: Deaktiviert das angegebene Plugin. Es darf hierbei keine JAR-Datei übertragen werden. Existiert das angegebene Plugin nicht, wird ein Fehler zurückgegeben. Beispiel:
	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:
	135	+
120	120	(((
121	121	{{code language="bash"}}
	138	+# Deaktiviert oder aktualisiert das Plugin mit dem Implementation-Title com.example:plugin
122	122	curl -X POST \
123		- # These options are required
124	124	-F deploy-action=deactivate \
125	125	-F token=admin \
126	126	-F plugin-ident=manifest \
...	...	@@ -128,9 +128,10 @@
128	128	"http://localhost:8080/formcycle/plugin?client-id=154&name=deploy-plugin"
129	129	{{/code}}
130	130	)))
	147	+
131	131	; update-properties
132	132	: 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:
133		- (((
	150	+(((
134	134	{{code language="bash"}}
135	135	# Löscht alle vorhandenen Plugin-Eigenschaften und setzt dann die Eigenschaft "foo" auf den Wert "bar"
136	136	curl -X POST \
...	...	@@ -141,10 +141,161 @@
141	141	-F clear-properties=false \
142	142	-F property=foo=bar \
143	143	"http://localhost:8080/formcycle/plugin?client-id=154&name=deploy-plugin"
144		-{{/code}})))
	161	+{{/code}}
	162	+)))
145	145
146		-== Response
	164	+== Response ==
147	147
	166	+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.
148	148
	168	+Das JSON-Objekt hat dabei [[die folgende Struktur>>https://json-schema.org/]]:
149	149
	170	+{{code language="json"}}
	171	+{
	172	+ "$schema": "http://json-schema.org/schema",
	173	+ "description": "Represents the response of the deploy plugin servlet.",
	174	+ "required": [
	175	+ "success",
	176	+ "statusCode",
	177	+ "details",
	178	+ "message",
	179	+ "requestParameters"
	180	+ ],
	181	+ "properties": {
	182	+ "success": {
	183	+ "type": "boolean",
	184	+ "title": "Success status",
	185	+ "description": "true if the deploy plugin servlet was executed successfully, or false otherwise"
	186	+ },
	187	+ "statusCode": {
	188	+ "type": "number",
	189	+ "title": "HTTP status code",
	190	+ "description": "The status code of the HTTP request that contains this response."
	191	+ },
	192	+ "details": {
	193	+ "type": "object",
	194	+ "title": "Result details",
	195	+ "description": "Detailed information about the plugin processed by the deploy plugin servlet.",
	196	+ "oneOf": [
	197	+ {
	198	+ "description": "If the deploy plugin servlet was successful, details about the successfully executed action.",
	199	+ "required": [
	200	+ "id",
	201	+ "uuid",
	202	+ "name",
	203	+ "active",
	204	+ "message"
	205	+ ],
	206	+ "properties": {
	207	+ "id": {
	208	+ "type": "number",
	209	+ "title": "Plugin ID",
	210	+ "description": "The database ID of the processed plugin."
	211	+ },
	212	+ "uuid": {
	213	+ "type": "string",
	214	+ "title": "Plugin UUID",
	215	+ "description": "The UUID of the processed plugin."
	216	+ },
	217	+ "name": {
	218	+ "type": "string",
	219	+ "title": "Plugin name",
	220	+ "description": "The name of the processed plugin, i.e. the file name of the plugin JAR file."
	221	+ },
	222	+ "active": {
	223	+ "type": "boolean",
	224	+ "title": "Plugin activation status",
	225	+ "description": "true if the plugin is now active, false if it is now inactive."
	226	+ },
	227	+ "message": {
	228	+ "type": "string",
	229	+ "title": "Result message",
	230	+ "description": "Human-readable message describing the performed action."
	231	+ }
	232	+ }
	233	+ },
	234	+ {
	235	+ "required": [
	236	+ "exceptionType",
	237	+ "exceptionMessage"
	238	+ ],
	239	+ "description": "If the deploy plugin servlet was unsuccessful, details about the error that occurred.",
	240	+ "properties": {
	241	+ "exceptionType": {
	242	+ "type": "string",
	243	+ "title": "Exception type",
	244	+ "description": "The type of the error that occurred, a fully-classified name of the Java exception class."
	245	+ },
	246	+ "exceptionMessage": {
	247	+ "type": "string",
	248	+ "title": "Exception message",
	249	+ "description": "The human-readable message of the error that occurred."
	250	+ }
	251	+ }
	252	+ }
	253	+ ]
	254	+ },
	255	+ "message": {
	256	+ "type": "string",
	257	+ "title": "Result message",
	258	+ "description": "A human-readable message that describes this result."
	259	+ },
	260	+ "requestParameters": {
	261	+ "type": "object",
	262	+ "title": "Request parameters",
	263	+ "description": "The parameters of the request that triggered this response."
	264	+ }
	265	+ }
	266	+}
	267	+{{/code}}
	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	+
150	150	== Beispiel für Maven ==
	318	+