Zusammenfassung

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

Details

Seiteneigenschaften

Inhalt

...	...	@@ -1,5 +3,3 @@
1		-[[**Plugin-Download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/fc-plugin-deploy-plugin&fileid=12657||target="_blank"]] (erfordert Anmeldung)
2		-
3	3	Hinweis zum Namen: Es ist ein Plugin zum Deployen von Plugins in {{formcycle/}}, daher //FORMCYCLE-Deploy-Plugin-Plugin//.
4	4
5	5	{{content/}}
...	...	@@ -9,8 +9,6 @@
9	9	* Plugin-Entwickler können beim Maven-Build das Plugin automatisch am Ende des Builds hochladen. So kann der Entwickler schneller testen.
10	10	* Eine Installation auf einem Live-System kann so weiter automatisiert werden.
11	11
12		-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.
13		-
14	14	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.
15	15
16	16	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:
...	...	@@ -75,17 +75,7 @@
75	75	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:
76	76
77	77	; deploy-action
78		-: Aktion, welche mit dem Plugin durchgeführt werden soll. Erlaubte Werte sind //save//, //update-properties//, //activate//, //deactivate// und //delete//.
79		-:; save
80		-:: Ü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.
81		-:; delete
82		-:: Löscht das angegebene Plugin. Es darf hierbei keine JAR-Datei übertragen werden. Existiert das angegebene Plugin nicht, wird ein Fehler zurückgegeben.
83		-:; activate
84		-:: 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.
85		-:; deactivate
86		-:: 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.
87		-:; update-properties
88		-:: 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.
89	89	; client-id
90	90	: 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
91	91	; client-uuid
...	...	@@ -93,7 +93,7 @@
93	93	; jar-file
94	94	: Binärdaten mit der JAR-Datei des Plugins, welches aktualisert oder installiert werden soll.
95	95	; token
96		-: 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.
97	97	; plugin-ident
98	98	: Die Art, wie nach einem vorhandenen Plugin gesucht wird (siehe oben). Folgende Werte sind erlaubt:
99	99	:; manifest
...	...	@@ -123,10 +123,13 @@
123	123	; locale
124	124	: 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.
125	125
126		-=== Beispiele ===
	112	+=== Deploy-Action ===
127	127
128		-;
	114	+Der Wert des Parameters //deploy-action// gibt an, was genau mit dem Plugin geschehen soll. Es gibt dabei die folgenden Möglichkeiten:
129	129
	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	+
130	130	(((
131	131	{{code language="bash"}}
132	132	# Installiert oder aktualisiert das Plugin mit dem Implementation-Title com.example:plugin
...	...	@@ -140,6 +140,9 @@
140	140	{{/code}}
141	141	)))
142	142
	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	+
143	143	(((
144	144	{{code language="bash"}}
145	145	# Löscht das Plugin mit dem Implementation-Title com.example:plugin
...	...	@@ -152,6 +152,9 @@
152	152	{{/code}}
153	153	)))
154	154
	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	+
155	155	(((
156	156	{{code language="bash"}}
157	157	# Aktiviert das Plugin mit dem Implementation-Title com.example:plugin
...	...	@@ -164,6 +164,9 @@
164	164	{{/code}}
165	165	)))
166	166
	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	+
167	167	(((
168	168	{{code language="bash"}}
169	169	# Deaktiviert oder aktualisiert das Plugin mit dem Implementation-Title com.example:plugin
...	...	@@ -176,6 +176,9 @@
176	176	{{/code}}
177	177	)))
178	178
	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	+
179	179	(((
180	180	{{code language="bash"}}
181	181	# Löscht alle vorhandenen Plugin-Eigenschaften und setzt dann die Eigenschaft "foo" auf den Wert "bar"
...	...	@@ -345,7 +345,7 @@
345	345
346	346	== Create-Token-Servlet ==
347	347
348		-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):
349	349
350	350	{{code language="none"}}
351	351	http://localhost:8080/formcycle/plugin?client-id=1&name=create-token&token=<PASSWORT>&method=<METHOD>
...	...	@@ -554,18 +554,18 @@
554	554
555	555	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.
556	556
557		-== Versionshistorie ==
	558	+== Changelog
558	558
559	559	In diesem Abschnitt werden die vorhandenen Versionen des Deploy-Plugins und die jeweiligen Änderungen in dieser Version beschrieben.
560	560
561		-=== 1.1.0 ===
	562	+=== 1.1.0
562	562
563	563	* Anpassungen für {{formcycle/}} 6.4.
564	564
565		-=== 1.0.1 ===
	566	+=== 1.0.1
566	566
567	567	* Verbesserte Fehlerbehandlung bei der Plugin-Installation.
568	568
569		-=== 1.0.0 ===
	570	+=== 1.0.0
570	570
571	571	* Initialer Release