Änderungen von Dokument Plugin-Entwicklung


Von Version 6.3
bearbeitet von gru
am 25.02.2022, 13:53
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 10.2
bearbeitet von awa
am 25.02.2022, 22:48
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.gru
1 +XWiki.awa
Inhalt
... ... @@ -65,11 +65,11 @@
65 65  {{/code}}
66 66  {{/panel}}
67 67  
68 -== Maven-Projekteinrichtung
68 +== Maven-Projekteinrichtung ===
69 69  
70 70  Im Folgenden werden einige Punkte beschrieben, die beim Einrichten eines Maven-Projekts für ein {{formcycle/}}-Plugin beachtet werden müssen. Für den schnellen Einstieg gibt auch einige [[Maven-Archetypes>>||anchor="HMaven-Archetypes"]].
71 71  
72 -=== Artekfakte und Abhängigkeiten
72 +=== Artekfakte und Abhängigkeiten ===
73 73  
74 74  {{info}}
75 75  Alle Abhängigkeiten zu {{formcycle case="dat"/}} sind im scope "provided" zu definieren!
... ... @@ -111,18 +111,18 @@
111 111  
112 112  Ferner ist zu beachten, dass sämtliche Abhängigkeiten zu {{formcycle case="dat"/}} im scope //provided //anzugeben sind. Dies verhindert neben Classpath-Problemen auch das unnötige Anschwellen der Plugin-Größe. Ebenso sollten diesbezüglich Abhängigkeiten auf bereits von {{formcycle case="dat"/}} benutzten und damit bereitstehenden Bibliotheken wiederverwendet werden (z.B. diverse Apache Commons-Implementierungen).
113 113  
114 -=== Manifest und Fat JAR
114 +=== Manifest und Fat JAR ===
115 115  
116 116  In der //META-INF/MANIFEST.MF// in der Plugin-JAR-Datei sollten folgende Informationen stehen:
117 117  
118 118  ; formcycle-version-requirement
119 -: Erforderlich. Version von {{formcycle/}}, für die das Plugin gedacht ist.Ist erforderlich, damit {{formcycle/}} bei der Installation die Kompatibilität prüfen kann.
119 +: Erforderlich. Version von {{formcycle/}}, für die das Plugin gedacht ist. Ist erforderlich, damit {{formcycle/}} bei der Installation die Kompatibilität prüfen kann.
120 120  ; Implementation-Version
121 -: Erforderlich. Version des Plugins, wird etwa in der Oberfläche angezeigt.
121 +: Erforderlich. Version des Plugins; Diese wird z.B. in der Oberfläche angezeigt.
122 122  ; Build-Time oder Build-Timestamp
123 -: Optional, wird bei SNAPSHOT-Versionen mit angezeigt, um den SNAPSHOT zu identifizieren.
123 +: Optional. Wird bei SNAPSHOT-Versionen mit angezeigt, um den SNAPSHOT zu identifizieren.
124 124  ; Implementation-Title
125 -: Optional, wird standardmäßig etwa vom Deploy-Plugin verwendet, um das Plugin zu identifzieren.
125 +: Optional. Wird standardmäßig etwa vom Deploy-Plugin verwendet, um das Plugin zu identifzieren.
126 126  
127 127  Diese Informationen können wie unten beschrieben mittels des //maven-assembly-plugin// in die Manifest-Datei geschrieben werden.
128 128  
... ... @@ -218,7 +218,7 @@
218 218  
219 219  {{code language="plaintext"}}https://artifactory.xima-services.de/artifactory/libs-release-local/archetype-catalog.xml{{/code}}
220 220  
221 -== Deploy-Plugin
221 +== Deploy-Plugin ==
222 222  
223 223  Um beim Entwickeln nicht jedes Mal eine neue Plugin-Version manuell über die Oberfläche hochladen zu müssen, kann das Deploy-Plugin verwendet werden. Dieses besteht aus 2 Teilen:
224 224  
... ... @@ -239,7 +239,7 @@
239 239   <executions>
240 240   <execution>
241 241   <id>upload</id>
242 - <phase>install</phase>
242 + <phase>package</phase>
243 243   <goals>
244 244   <goal>deploy</goal>
245 245   </goals>
... ... @@ -253,7 +253,7 @@
253 253  Sofern das Deploy-Plugin bereits in {{formcycle/}} installiert ist, kann das Plugin-Projekt dann beim Bauen wie folgt hochgeladen werden:
254 254  
255 255  {{code language="bash"}}
256 -mvn clean install -DfcDeployUrl=http://localhost:8080/xima-formcycle -DfcDeployToken=admin
256 +mvn package fc-deploy:deploy -DfcDeployUrl=http://localhost:8080/xima-formcycle -DfcDeployToken=admin
257 257  {{/code}}
258 258  
259 259  Wird Eclipse benutzt, kann auch eine Launch-Configuration mit den //fcDeployUrl// und dem //fcDeployToken// angelegt werden.
... ... @@ -265,10 +265,10 @@
265 265  Sofern wie oben beschrieben in //~~/.m2/settings.xml// die //pluginGroup// hinterlegt wurde, kann in einem beliebiegen Verzeichnis wie folgt ein {{formcycle/}}-Server per Maven gestartet werden:
266 266  
267 267  {{code language="bash"}}
268 -mvn fc-server:run-ms-war -DxfcVersion=7.0.10
268 +mvn package fc-server:run-ms-war -DxfcVersion=7.0.10
269 269  {{/code}}
270 270  
271 -Nach kurzer Wartezeit (beim ersten Mal kann es länger dauern) ist dann ein {{formcycle/}}-Server gestartet. Die URL steht am Ende in der Kommandozeile, standardmäßig http://localhost:8080/xima-formcycle
271 +Nach kurzer Wartezeit (beim ersten Mal kann es länger dauern) ist dann ein {{formcycle/}}-Server gestartet. Die URL steht am Ende in der Kommandozeile, standardmäßig http://localhost:8080/xima-formcycle Der Zugang für den Superadmin ist {{code language="plaintext"}}sadmin{{/code}} (Passwort {{code language="plaintext"}}admin{{/code}}), der Zugang für den Mandantadministrator {{code language="plaintext"}}admin{{/code}} (Passwort {{code language="plaintext"}}/admin_{{/code}}).
272 272  
273 273  Dies funktioniert auch in einem Ordner ohne Maven-Projekt. Falls keine {{formcycle/}} angegeben ist, wird eine Standard-Version genommen. Wird der Befehl innerhalb eines Plugin-Maven-Projekts ausgeführt, wird versucht, die Version von {{formcycle/}} aus dem Plugin-Projekt auszulesen.
274 274  
pom.xml
Größe
... ... @@ -1,1 +1,1 @@
1 -6.1 KB
1 +5.7 KB
Inhalt
... ... @@ -23,18 +23,10 @@
23 23   <maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
24 24   <maven-jar-plugin.version>3.1.0</maven-jar-plugin.version>
25 25   <maven-assembly-plugin.version>3.3.0</maven-assembly-plugin.version>
26 - <fc-deploy-plugin-maven-plugin.version>7.0.1<fc-deploy-plugin-maven-plugin.version/>
26 + <fc-deploy-plugin-maven-plugin.version>7.0.1</fc-deploy-plugin-maven-plugin.version>
27 27   <fc-server-maven-plugin.version>7.0.1</fc-server-maven-plugin.version>
28 28   </properties>
29 29  
30 - <repositories>
31 - <repository>
32 - <id>xima</id>
33 - <name>fc-plugin-dev</name>
34 - <url>http://artifactory.xima-services.de/artifactory/fc-plugin-dev</url>
35 - </repository>
36 - </repositories>
37 -
38 38   <dependencies>
39 39   <!-- Reference FORMCYCLE libraries. The plugin is installed in a running -->
40 40   <!-- FORMCYCLE system, , so you do not need to include the FORMCYCLE libraries -->
... ... @@ -66,20 +66,11 @@
66 66   <plugins>
67 67  
68 68   <!-- Upload the plugin to a running FORMCYCLE server as part of the Maven build process -->
69 - <!-- mvn clean install -DfcDeployUrl=http://localhost:8080/xima-formcycle -DfcDeployToken=admin -->
61 + <!-- mvn package fc-deploy:deploy -DfcDeployUrl=http://localhost:8080/xima-formcycle -DfcDeployToken=admin -->
70 70   <plugin>
71 71   <groupId>de.xima.fc.maven.plugin</groupId>
72 72   <artifactId>fc-deploy-plugin-maven-plugin</artifactId>
73 73   <version>${fc-deploy-plugin-maven-plugin.version}</version>
74 - <executions>
75 - <execution>
76 - <id>upload</id>
77 - <phase>install</phase>
78 - <goals>
79 - <goal>deploy</goal>
80 - </goals>
81 - </execution>
82 - </executions>
83 83   </plugin>
84 84  
85 85   <!-- Start a preconfigured FORMCYCLE server-->