Zusammenfassung

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

Details

Seiteneigenschaften

Dokument-Autor

...	...	@@ -1,1 +1,1 @@
1		-XWiki.tkr
	1	+XWiki.awa

Inhalt

...	...	@@ -7,8 +7,6 @@
7	7	* Plugin-Entwickler können beim Maven-Build das Plugin automatisch am Ende des Builds hochladen. So kann der Entwickler schneller testen.
8	8	* Eine Installation auf einem Live-System kann so weiter automatisiert werden.
9	9
10		-Um Plugins einfach deployen zu können, empfiehlt sich der Quick Start über das Maven-Deploy-Plugin (siehe Kapitel 4. unten). Es folgt zunächst eine genaue Beschreibung des Plugins.
11		-
12	12	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.
13	13
14	14	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:
...	...	@@ -73,17 +73,7 @@
73	73	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:
74	74
75	75	; deploy-action
76		-: Aktion, welche mit dem Plugin durchgeführt werden soll. Erlaubte Werte sind //save//, //update-properties//, //activate//, //deactivate// und //delete//.
77		-:; save
78		-:: Ü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.
79		-:; delete
80		-:: Löscht das angegebene Plugin. Es darf hierbei keine JAR-Datei übertragen werden. Existiert das angegebene Plugin nicht, wird ein Fehler zurückgegeben.
81		-:; activate
82		-:: 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.
83		-:; deactivate
84		-:: 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.
85		-:; update-properties
86		-:: 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.
	74	+: 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.
87	87	; client-id
88	88	: 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
89	89	; client-uuid
...	...	@@ -91,7 +91,7 @@
91	91	; jar-file
92	92	: Binärdaten mit der JAR-Datei des Plugins, welches aktualisert oder installiert werden soll.
93	93	; token
94		-: Das Token (Passwort) für die Authorisierung des Requests. Nur erforderlich, wenn in der Plugin-Konfiguration ein Token festgelegt wurde.
	82	+: Das Token (Password) für die Authorisierung des Requests. Nur erforderlich, wenn in der Plugin-Konfiguration ein Token festgelegt wurde.
95	95	; plugin-ident
96	96	: Die Art, wie nach einem vorhandenen Plugin gesucht wird (siehe oben). Folgende Werte sind erlaubt:
97	97	:; manifest
...	...	@@ -121,10 +121,13 @@
121	121	; locale
122	122	: 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.
123	123
124		-=== Beispiele ===
	112	+=== Deploy-Action ===
125	125
126		-;
	114	+Der Wert des Parameters //deploy-action// gibt an, was genau mit dem Plugin geschehen soll. Es gibt dabei die folgenden Möglichkeiten:
127	127
	116	+; save
	117	+: Ü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.
	118	+
128	128	(((
129	129	{{code language="bash"}}
130	130	# Installiert oder aktualisiert das Plugin mit dem Implementation-Title com.example:plugin
...	...	@@ -138,6 +138,9 @@
138	138	{{/code}}
139	139	)))
140	140
	132	+; delete
	133	+: Löscht das angegebene Plugin. Es darf hierbei keine JAR-Datei übertragen werden. Existiert das angegebene Plugin nicht, wird ein Fehler zurückgegeben. Beispiel:
	134	+
141	141	(((
142	142	{{code language="bash"}}
143	143	# Löscht das Plugin mit dem Implementation-Title com.example:plugin
...	...	@@ -150,6 +150,9 @@
150	150	{{/code}}
151	151	)))
152	152
	147	+; activate
	148	+: 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:
	149	+
153	153	(((
154	154	{{code language="bash"}}
155	155	# Aktiviert das Plugin mit dem Implementation-Title com.example:plugin
...	...	@@ -162,6 +162,9 @@
162	162	{{/code}}
163	163	)))
164	164
	162	+; deactivate
	163	+: 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:
	164	+
165	165	(((
166	166	{{code language="bash"}}
167	167	# Deaktiviert oder aktualisiert das Plugin mit dem Implementation-Title com.example:plugin
...	...	@@ -174,6 +174,9 @@
174	174	{{/code}}
175	175	)))
176	176
	177	+; update-properties
	178	+: 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:
	179	+
177	177	(((
178	178	{{code language="bash"}}
179	179	# Löscht alle vorhandenen Plugin-Eigenschaften und setzt dann die Eigenschaft "foo" auf den Wert "bar"
...	...	@@ -343,7 +343,7 @@
343	343
344	344	== Create-Token-Servlet ==
345	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. 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/}}-Servet und die Mandant-ID entsprechend ersetzen):
	349	+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	347
348	348	{{code language="none"}}
349	349	http://localhost:8080/formcycle/plugin?client-id=1&name=create-token&token=<PASSWORT>&method=<METHOD>
...	...	@@ -552,18 +552,18 @@
552	552
553	553	Hinweis: IDE wie Eclipse und IntelliJ erlauben es, eine Build-Konfiguration für das Plugin-Projekt zu erstellen, wo die Parameter //fcDeployUrl//, //fcDeployClientId// und //fcDeployToken// hinterlegt werden können.
554	554
555		-== Versionshistorie ==
	558	+== Versionshistorie
556	556
557	557	In diesem Abschnitt werden die vorhandenen Versionen des Deploy-Plugins und die jeweiligen Änderungen in dieser Version beschrieben.
558	558
559		-=== 1.1.0 ===
	562	+=== 1.1.0
560	560
561	561	* Anpassungen für {{formcycle/}} 6.4.
562	562
563		-=== 1.0.1 ===
	566	+=== 1.0.1
564	564
565	565	* Verbesserte Fehlerbehandlung bei der Plugin-Installation.
566	566
567		-=== 1.0.0 ===
	570	+=== 1.0.0
568	568
569	569	* Initialer Release