Änderungen von Dokument Plugin-Entwicklung

Von Version 5.7
bearbeitet von awa
am 25.02.2022, 13:24
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 12.1
bearbeitet von awa
am 04.12.2022, 00:43
Änderungskommentar: Uploaded new attachment "README.md", version 1.1

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,18 +1,17 @@
1 1  {{content/}}
2 2  
3 -== Plugins für zusätzliche Funktionalitäten ==
4 4  
5 5  {{formcycle/}} bietet ein Vielzahl von Einstiegspunkten für die Erweiterung der Standard-Funktionalitäten durch Plugins. Basierend auf den einzelnen [[Plugin-Typen>>doc:Formcycle.PluginDevelopment.Types.WebHome]] werden diese zu gewissen Zeitpunkten automatisch oder manuell angesprochen und erlauben es somit von der Ersetzung eigener Platzhalter bis hin zur Implementierung eigener Verarbeitungslogik {{formcycle/}} anzupassen. Als fundamentaler erster Schritt für die Entwicklung eigener Plugins ist hierbei das Erstellen eines entsprechenden Java-Projekts anzusehen.
6 6  
7 7  == API-Dokumentation ==
8 8  
9 -Die API-Dokumentation für {{formcycle/}} findet sich hier auf unserer Seite: [[Javadocs>>https://docs.formcycle.eu/]]
8 +Die API-Dokumentation für {{formcycle/}} findet sich hier auf unserer Seite: [[JavaScript und JavaDocs>>https://docs.formcycle.eu/]]
10 10  
11 11  == Maven-Setup ==
12 12  
13 -Zu Beginn der Entwicklung eines Plugins ist es nötig das entsprechende Entwicklungsprojekt aufzusetzten und zu konfigurieren.
12 +Zu Beginn der Entwicklung eines Plugins ist es nötig, das entsprechende Entwicklungsprojekt aufzusetzten und zu konfigurieren.
14 14  
15 -Für letzteres empfehlen wir hierbei das Build-Management-Tool [[Apache Maven>>url:https://maven.apache.org/||rel="__blank"]] zum Einsatz. Andere Build-Tools können prinzipiell benutzt werden, hier können wir aber keine Hilfe bereitstellen.
14 +Für letzteres empfehlen wir hierbei das Build-Management-Tool [[Apache Maven>>url:https://maven.apache.org/||rel="__blank"]] zu verwenden. Andere Build-Tools können prinzipiell auch genutzt werden, hier können wir aber keine Hilfe bereitstellen.
16 16  
17 17  Um die entsprechenden Abhängigkeiten zu {{formcycle case="dat"/}} bereitzustellen, ist das Repository unter der URL [[https:~~/~~/artifactory.xima-services.de/artifactory/fc-plugin-dev>>url:https://artifactory.xima-services.de/artifactory/fc-plugin-dev]] zu benutzen. Dieses enthält alle öffentlich zur Verfügung stehenden Artefakte, welche dem Plugin zur Laufzeit bereitgestellt und während der Entwicklung benötigt werden.
18 18  
... ... @@ -34,7 +34,7 @@
34 34   <enabled>false</enabled>
35 35   </snapshots>
36 36   <id>xima</id>
37 - <name>libs-release</name>
36 + <name>fc-plugin-dev</name>
38 38   <url>https://artifactory.xima-services.de/artifactory/fc-plugin-dev</url>
39 39   </repository>
40 40   </repositories>
... ... @@ -45,7 +45,7 @@
45 45   <enabled>false</enabled>
46 46   </snapshots>
47 47   <id>xima</id>
48 - <name>plugins-release</name>
47 + <name>fc-plugin-dev</name>
49 49   <url>https://artifactory.xima-services.de/artifactory/fc-plugin-dev</url>
50 50   </pluginRepository>
51 51   </pluginRepositories>
... ... @@ -66,23 +66,25 @@
66 66  {{/code}}
67 67  {{/panel}}
68 68  
69 -== Maven-Projekteinrichtung
68 +== Maven-Projekteinrichtung ==
70 70  
71 71  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"]].
72 72  
73 -=== Artekfakte und Abhängigkeiten
72 +=== Artekfakte und Abhängigkeiten ===
74 74  
75 75  {{info}}
76 76  Alle Abhängigkeiten zu {{formcycle case="dat"/}} sind im scope "provided" zu definieren!
77 77  {{/info}}
78 78  
79 -Ausgangspunkt für die Entwicklung von Plugin ist das Maven-Artefakt //fc-plugin-common//. Dieses enthält die einzelnen Plugin-Schnittstellen und steht auch auf [[unserere Downloadseite zur Verfügung>>url:http://artifactory.xima-services.de/artifactory/fc-plugin-dev/de/xima/fc/fc-plugin-common||target="_blank"]].
78 +Eine fertige einfache //pom.xml// können Sie [[hier herunterladen>>attach:pom.xml||rel="__blank"]].
80 80  
80 +Ausgangspunkt für die Entwicklung von Plugin ist das Maven-Artefakt //fc-plugin-common//. Dieses enthält die einzelnen Plugin-Schnittstellen und steht auch auf [[unsererer Downloadseite zur Verfügung>>url:http://artifactory.xima-services.de/artifactory/fc-plugin-dev/de/xima/fc/fc-plugin-common||rel="noopener noreferrer" target="_blank"]].
81 +
81 81  In der //pom.xml// des Plugin-Projekts kann diese Abhängigkeit wie folgt eingebunden werden:
82 82  
83 83  {{code language="xml"}}
84 84   <properties>
85 - <xfc.version>7.0.10</xfc.version>
86 + <xfc.version>7.2.1</xfc.version>
86 86   </properties>
87 87  
88 88   <dependencies>
... ... @@ -95,7 +95,7 @@
95 95   </dependencies>
96 96  {{/code}}
97 97  
98 -Ferner steht je nach Tiefe der Integration in die bestehende Umgebung von {{formcycle case="dat"/}} und dessen Benutzung als höchste Implementierung das Artefakt //fc-logic// zur Verfügung. Dieses wird wie folgt als weitere (oder einzige) Abhängigkeit definiert:
99 +Ferner steht je nach Tiefe der Integration in die bestehende Umgebung von {{formcycle case="dat"/}} und deren Benutzung als höchste Implementierung das Artefakt //fc-logic// zur Verfügung. Dieses wird wie folgt als weitere (oder einzige) Abhängigkeit definiert:
99 99  
100 100  {{code language="xml"}}
101 101   <dependency>
... ... @@ -106,23 +106,44 @@
106 106   </dependency>
107 107  {{/code}}
108 108  
109 -Eine entsprechende Benutzung ist vor allem bei der Verwendung der Datenbankschnittstelle sowie bei der Implementierung von eigenen Verarbeitungen nötig. Eine Vorlage für ein somit entstehendes Project Object Model finden Sie [[hier>>attach:pom.xml||rel="__blank"]].
110 +Eine entsprechende Benutzung ist vor allem bei der Verwendung der Datenbankschnittstelle sowie bei der Implementierung von eigenen Verarbeitungen nötig.
110 110  
111 -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).
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). Solche Abhängigkeit sind auch im Scope //provided// zu definieren. Eine einfache Möglichkeit, Fehler zu vermeiden, ist das Importieren der FORMCYCLE-Bom:
112 112  
113 -=== Manifest und Fat JAR
114 +{{code language="xml"}}
115 + <dependencyManagement>
116 + <dependencies>
117 + <!--Import dependency versions from FORMCYCLE -->
118 + <dependency>
119 + <groupId>de.xima.fc</groupId>
120 + <artifactId>fc</artifactId>
121 + <version>${xfc.version}</version>
122 + <type>pom</type>
123 + <scope>import</scope>
124 + </dependency>
125 + </dependencies>
126 + </dependencyManagement>
127 +{{/code}}
114 114  
129 +Dann einfach die gewünschte Abhängigkeit ohne {{code}}<version>...</version>{{/code}} definieren. Wenn FORMCYCLE die Abhängigkeit schon enthält, gibt es keinen Build-Fehler. Andernfalls muss diese im Plugin mitgeliefert werden. In dem Fall die Version hinzufügen und den Provided-Scope entfernen.
130 +
131 +=== Manifest und Fat JAR ===
132 +
115 115  In der //META-INF/MANIFEST.MF// in der Plugin-JAR-Datei sollten folgende Informationen stehen:
116 116  
117 117  ; formcycle-version-requirement
118 -: Erforderlich. Version von {{formcycle/}}, für die das Plugin gedacht ist.Ist erforderlich, damit {{formcycle/}} bei der Installation die Kompatibilität prüfen kann.
136 +: 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 119  ; Implementation-Version
120 -: Erforderlich. Version des Plugins, wird etwa in der Oberfläche angezeigt.
138 +: Erforderlich. Version des Plugins; Diese wird z.B. in der Oberfläche angezeigt.
139 +; Plugin-Key
140 +: Erforderlch. Wird zur Identifizierung des Plugin innherhalb von {{formcycle/}} verwendet, und auch von etwa dem Deploy-Plugin oder Server-Plugin. Empfohlener Wert ist {{code}}${project.groupId}:${project.artifactId}{{/code}}.
121 121  ; Build-Time oder Build-Timestamp
122 -: Optional, wird bei SNAPSHOT-Versionen mit angezeigt, um den SNAPSHOT zu identifizieren.
123 -; Implementation-Title
124 -: Optional, wird standardmäßig etwa vom Deploy-Plugin verwendet, um das Plugin zu identifzieren.
142 +: Optional. Wird bei SNAPSHOT-Versionen mit angezeigt, um den SNAPSHOT zu identifizieren.
125 125  
144 +{{info}}
145 +Bis einschließlich Version 7.x von {{formcycle/}} ist noch {{code}}Implementation-Title{{/code}} mit dem gleichen Wert wie {{code}}Plugin-Key{{/code}} erforderlich.
146 +{{/info}}
147 +
126 126  Diese Informationen können wie unten beschrieben mittels des //maven-assembly-plugin// in die Manifest-Datei geschrieben werden.
127 127  
128 128  Weiterhin ist beim Bauen zu beachten, dass eine sogenannte Fat-JAR gebaut werden muss. Abhängigkeiten zu {{formcycle case="dat"/}} sowie anderen Bibliotheken, welche bereits durch {{formcycle case="acc"/}} mitgeliefert werden, sollten wie bereits erwähnt im scope //provided// eingebunden werden. Falls im Plugin aber noch andere Abhängigkeiten benutzt werden, müssen diese in der JAR-Datei inkludiert werden (Fat JAR).
... ... @@ -137,7 +137,7 @@
137 137   <maven-assembly-plugin.version>3.3.0</maven-assembly-plugin.version>
138 138   </properties>
139 139   <build>
140 - <finalName>${project.parent.artifactId}</finalName>
162 + <finalName>${project.artifactId}</finalName>
141 141   <plugins>
142 142   <plugin>
143 143   <groupId>org.apache.maven.plugins</groupId>
... ... @@ -151,7 +151,7 @@
151 151   <goal>single</goal>
152 152   </goals>
153 153   <configuration>
154 - <finalName>${project.parent.artifactId}</finalName>
176 + <finalName>${project.artifactId}</finalName>
155 155   <appendAssemblyId>false</appendAssemblyId>
156 156   <descriptorRefs>
157 157   <descriptorRef>jar-with-dependencies</descriptorRef>
... ... @@ -201,7 +201,7 @@
201 201   Auswahl eines Archetypes beim Erstellen eines Maven-Projekts in Eclipse
202 202  {{/figure}}
203 203  
204 -Für einige häufig verwendete Plugin-Typen stehen [[Maven-Archetypes>>url:https://maven.apache.org/guides/introduction/introduction-to-archetypes.html||target="_blank"]] bereits, um schnell ein Maven-Projekt aufsetzen zu können.
226 +Für einige häufig verwendete Plugin-Typen stehen [[Maven-Archetypes>>url:https://maven.apache.org/guides/introduction/introduction-to-archetypes.html||rel="noopener noreferrer" target="_blank"]] bereits, um schnell ein Maven-Projekt aufsetzen zu können.
205 205  
206 206  Voraussetzung für die Verwendung ist, dass in den //~~/.m2/settings.xml// wie oben beschrieben das XIMA-Artifactory eingerichtet wurde. Dann kann etwa über die Kommandozeile wie folgt eine Archetype generiert werden:
207 207  
... ... @@ -211,13 +211,15 @@
211 211  
212 212  Es werden dann einige wenige Informationen wie die gewünschten Maven-Koordinaten des neuen Plugin-Projekts abgefragt und anschließend ein neues vorkonfiguriertes Projekt erstellt.
213 213  
214 -Alle vorhandenen Archetypes und deren Versionen können im [[Archetype-Katalog>>url:https://artifactory.xima-services.de/artifactory/libs-release-local/archetype-catalog.xml||target="_blank"]] eingesehen werden.
236 +Alle vorhandenen Archetypes und deren Versionen können im [[Archetype-Katalog>>url:https://artifactory.xima-services.de/artifactory/libs-release-local/archetype-catalog.xml||rel="noopener noreferrer" target="_blank"]] eingesehen werden.
215 215  
216 216  In Eclipse kann der Archetype-Katalog in den Einstellungen hinzugefügt werden. Bei der Erstellung eines neuen Maven-Projekt werden dann alle verfügbaren Archetypes angezeigt:
217 217  
218 -{{code language="plaintext"}}https://artifactory.xima-services.de/artifactory/libs-release-local/archetype-catalog.xml{{/code}}
240 +{{code language="plaintext"}}
241 +https://artifactory.xima-services.de/artifactory/libs-release-local/archetype-catalog.xml
242 +{{/code}}
219 219  
220 -== Deploy-Plugin
244 +== Deploy-Plugin ==
221 221  
222 222  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:
223 223  
... ... @@ -224,39 +224,40 @@
224 224  * Ein Maven-Plugin, welches nach dem Bauen das Plugin via HTTP an einen laufenden {{formcycle/}}-Server sendet
225 225  * Ein Plugin für {{formcycle/}}, welche die Gegenstelle in {{formcycle/}} bereitstellt und das Plugin aus dem HTTP-Request in {{formcycle/}} installiert.
226 226  
227 -Weitere Details können im [[Hilfe-Artikel zum Deploy-Plugin>>doc:Formcycle.PluginDocumentation.FormcycleDeployPluginPlugin]] nachgelesen werden. Für die meisten Fälle reicht folgende Konfiguration in der //pom.xml// des Plugin-Projekts aus:
251 +Weitere Details können im [[Hilfe-Artikel zum Deploy-Plugin>>doc:Formcycle.PluginDocumentation.FormcycleDeployPluginPlugin]] nachgelesen werden. Für die meisten Fälle ist kene Konfiguration in der //pom.xml// erforderlich. Es empfiehlt sich aber, wenigstens die Version festzusetzen:
228 228  
229 229  {{code language="xml"}}
230 230   <properties>
231 - <fc-deploy-plugin-maven-plugin.version>7.0.1<fc-deploy-plugin-maven-plugin.version/>
255 + <fc-deploy-plugin-maven-plugin.version>7.0.1<fc-deploy-plugin-maven-plugin.version></fc-deploy-plugin-maven-plugin>
232 232   <build>
233 233   <plugins>
234 - <plugin>
258 + <plugin>
235 235   <groupId>de.xima.fc.maven.plugin</groupId>
236 236   <artifactId>fc-deploy-plugin-maven-plugin</artifactId>
237 237   <version>${fc-deploy-plugin-maven-plugin.version}</version>
238 - <executions>
239 - <execution>
240 - <id>upload</id>
241 - <phase>install</phase>
242 - <goals>
243 - <goal>deploy</goal>
244 - </goals>
245 - </execution>
246 - </executions>
247 247   </plugin>
248 248   </plugins>
249 249   </build>
250 250  {{/code}}
251 251  
252 -Sofern das Deploy-Plugin bereits in {{formcycle/}} installiert ist, kann das Plugin-Projekt dann beim Bauen wie folgt hochgeladen werden:
267 +Sofern das Deploy-Plugin bereits in {{formcycle/}} installiert ist, kann das Plugin-Projekt dann wie folgt gebaut und hochgeladen werden:
253 253  
254 254  {{code language="bash"}}
255 -mvn clean install -DfcDeployUrl=http://localhost:8080/xima-formcycle -DfcDeployToken=admin
270 +mvn fc-deploy:deploy
256 256  {{/code}}
257 257  
258 -Wird Eclipse benutzt, kann auch eine Launch-Configuration mit den //fcDeployUrl// und dem //fcDeployToken// angelegt werden.
273 +Es wird hierbei davon ausgegangen, dass {{formcycle/}} unter der Standard-URL {{code}}http://localhost:8080/xima-formcycle{{/code}} läuft und das Standard-Passwort "admin" für das Deploy-Plugin verwendet wird. Ist dies nicht der Fall, können die Werte auch angepasst werden:
259 259  
275 +{{code language="bash"}}
276 +mvn package fc-deploy:deploy -DfcDeployUrl=http://localhost:8080/xima-formcycle -DfcDeployToken=admin
277 +{{/code}}
278 +
279 +{{info}}
280 +Bis einschließlich Version 7.x von {{formcycle/}} und dem Maven-Plugin ist es noch erforderlich, die package-Phase explizit aufzuführen. Zudem müssen die URL und das Passwort angegeben werden. Ab Version 8.x sind die Standardwerte gesetzt und die package-Phase wird automatisch ausgeführt.
281 +{{/info}}
282 +
283 +Soll das Plugin im Bereich eines bestimmten Mandanten registriert werden, so kann dies über den zusätzlichen Launch-Configuration Parameter //fcDeployClientId //erreicht werden. Dieser Parameter muss als Wert die Id des Mandanten enthalten.
284 +
260 260  == FC-Server-Plugin ==
261 261  
262 262  Zum Testen eines Plugins ist es erforderlich, einen laufenden {{formcycle/}}-Server zu haben. Zur Vereinfachung der Entwicklung gibt es das //fc-server-maven-plugin//, welches mittels eines einzigen Befehls ein fertig eingerichtetes {{formcycle/}} lokal startet, wo auch bereits das Deploy-Plugin vorinstalliert ist.
... ... @@ -264,10 +264,28 @@
264 264  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:
265 265  
266 266  {{code language="bash"}}
267 -mvn fc-server:run-ms-war -DxfcVersion=7.0.10
292 +# Aktuelle Version starten
293 +mvn fc-server:run-ms-war
294 +
295 +# Spezifische Version starten
296 +mvn de.xima.fc.maven.plugin:fc-server-maven-plugin:7.0.4:run-ms-war -DxfcVersion=7.0.16
268 268  {{/code}}
269 269  
270 -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
299 +{{info}}
300 +Wir empfehlen die Nutzung von Java 11. Bei Nutzung von Java 17 kann es aktuell zu Problemen beim Starten von {{formcycle/}} kommen.
301 +{{/info}}
271 271  
272 -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.
303 +{{info}}
304 +Bis einschließlich Version 7.x von {{formcycle/}} und dem Maven-Plugin ist es noch erforderlich, die package-Phase explizit aufzuführen: {{code}}mvn package fc-server:run-ms-war{{/code}}. Ab Version 8.x geschieht dies automatisch.
305 +{{/info}}
273 273  
307 +{{info}}
308 +Die Major- und Minor-Version des Maven-Plugins sollte immer der Major- und Minor-Version des zu startenden {{formcycle case="gen"/}} entsprechen. Für {{formcycle/}} 7.0.x sollte also das Maven-Plugin in Version 7.0.x verwendet werde, für {{formcycle/}} 7.1.x das Maven-Plugin in Version 7.1.x usw.
309 +{{/info}}
310 +
311 +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}}).
312 +
313 +Falls der Befehl in einem Maven-Projekt eines {{formcycle/}}-Plugins ausgeführt wird, dann wird das Plugin automatisch gebaut und nach dem Starten des Servers hochgeladen und installiert. Zudem wird versucht, die {{formcycle/}}-Version aus dem Plugin-Projekt auszulesen.
314 +
315 +Dies funktioniert auch in einem Ordner ohne Maven-Projekt. Falls keine {{formcycle/}}-Version angegeben ist, wird eine Standard-Version genommen, abhängig von der Maven-Plugin-Version.
316 +
pom.xml
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.rth
1 +XWiki.awa
Größe
... ... @@ -1,1 +1,1 @@
1 -2.2 KB
1 +5.8 KB
Inhalt
... ... @@ -2,55 +2,89 @@
2 2   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
3 3   <modelVersion>4.0.0</modelVersion>
4 4  
5 + <!-- MUST BE FILLED IN -->
5 5   <groupId></groupId>
6 6   <artifactId></artifactId>
7 7   <version></version>
8 - <packaging>jar</packaging>
9 -
10 10   <name></name>
11 11  
11 + <packaging>jar</packaging>
12 +
12 12   <properties>
13 13   <!-- Configuration -->
14 14   <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
15 15  
16 16   <!-- Dependencies -->
17 - <xfc-version>7.0.9</xfc-version>
18 + <xfc.version>7.2.1</xfc.version>
19 + <junit-jupiter.version>5.6.0</junit-jupiter.version>
18 18  
19 19   <!-- Plugins -->
20 - <maven-compiler-plugin-version>3.8.1</maven-compiler-plugin-version>
21 - <maven-jar-plugin-version>3.1.0</maven-jar-plugin-version>
22 + <maven-surefire-plugin.version>2.22.2</maven-surefire-plugin.version>
23 + <maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
24 + <maven-jar-plugin.version>3.1.0</maven-jar-plugin.version>
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>
27 + <fc-server-maven-plugin.version>7.0.1</fc-server-maven-plugin.version>
22 22   </properties>
23 23  
24 - <repositories>
25 - <repository>
26 - <id>xima</id>
27 - <name>fc-plugin-dev</name>
28 - <url>http://artifactory.xima-services.de/artifactory/fc-plugin-dev</url>
29 - </repository>
30 - </repositories>
31 -
32 32   <dependencies>
31 + <!-- Reference FORMCYCLE libraries. The plugin is installed in a running -->
32 + <!-- FORMCYCLE system, , so you do not need to include the FORMCYCLE libraries -->
33 + <!-- in the plugin JAR. This is done by setting the scope to "provided" -->
33 33   <dependency>
34 34   <groupId>de.xima.fc</groupId>
35 - <artifactId>fc-plugin-common</artifactId>
36 - <version>${xfc-version}</version>
36 + <artifactId>fc-logic</artifactId>
37 + <version>${xfc.version}</version>
37 37   <scope>provided</scope>
38 38   </dependency>
39 39  
41 + <!-- JUnit for writing unit tests -->
40 40   <dependency>
41 - <groupId>de.xima.fc</groupId>
42 - <artifactId>fc-logic</artifactId>
43 - <version>${xfc-version}</version>
44 - <scope>provided</scope>
43 + <groupId>org.junit.jupiter</groupId>
44 + <artifactId>junit-jupiter</artifactId>
45 + <version>${junit-jupiter.version}</version>
46 + <scope>test</scope>
45 45   </dependency>
48 +
49 + <!-- You can add additional dependencies here. -->
50 + <!-- Some common libraries as apache-commons and guava are provided by -->
51 + <!-- FORMCYCLE and can be set to scope=provided. -->
52 +
46 46   </dependencies>
47 47  
48 48   <build>
56 + <finalName>${project.artifactId}</finalName>
57 +
49 49   <plugins>
59 +
60 + <!-- Upload the plugin to a running FORMCYCLE server as part of the Maven build process -->
61 + <!-- mvn package fc-deploy:deploy -DfcDeployUrl=http://localhost:8080/xima-formcycle -DfcDeployToken=admin -->
50 50   <plugin>
63 + <groupId>de.xima.fc.maven.plugin</groupId>
64 + <artifactId>fc-deploy-plugin-maven-plugin</artifactId>
65 + <version>${fc-deploy-plugin-maven-plugin.version}</version>
66 + </plugin>
67 +
68 + <!-- Start a preconfigured FORMCYCLE server-->
69 + <!-- mvn fc-server:run-ms-war -->
70 + <plugin>
71 + <groupId>de.xima.fc.maven.plugin</groupId>
72 + <artifactId>fc-server-maven-plugin</artifactId>
73 + <version>${fc-server-maven-plugin.version}</version>
74 + <configuration>
75 + <bootstrap>
76 + <pluginManagement>
77 + <deployMavenProject>true</deployMavenProject>
78 + </pluginManagement>
79 + </bootstrap>
80 + </configuration>
81 + </plugin>
82 +
83 + <!-- Configure the compilation process. At least Java 11 is required. -->
84 + <plugin>
51 51   <groupId>org.apache.maven.plugins</groupId>
52 52   <artifactId>maven-compiler-plugin</artifactId>
53 - <version>${maven-compiler-plugin-version}</version>
87 + <version>${maven-compiler-plugin.version}</version>
54 54   <configuration>
55 55   <release>11</release>
56 56   <encoding>UTF-8</encoding>
... ... @@ -59,10 +59,11 @@
59 59   </configuration>
60 60   </plugin>
61 61  
96 + <!-- Configure how the JAR is created, including manifest entries -->
62 62   <plugin>
63 63   <groupId>org.apache.maven.plugins</groupId>
64 64   <artifactId>maven-jar-plugin</artifactId>
65 - <version>${maven-jar-plugin-version}</version>
100 + <version>${maven-jar-plugin.version}</version>
66 66   <configuration>
67 67   <archive>
68 68   <manifest>
... ... @@ -69,11 +69,59 @@
69 69   <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
70 70   </manifest>
71 71   <manifestEntries>
72 - <formcycle-version-requirement>${xfc-version}</formcycle-version-requirement>
107 + <formcycle-version-requirement>${xfc.version}</formcycle-version-requirement>
108 + <Build-Timestamp>${maven.build.timestamp}</Build-Timestamp>
109 + <Implementation-Title>${project.groupId}:${project.artifactId}</Implementation-Title>
110 + <Implementation-Vendor-Id>${project.groupId}</Implementation-Vendor-Id>
111 + <Implementation-Version>${project.version}</Implementation-Version>
73 73   </manifestEntries>
74 74   </archive>
75 75   </configuration>
76 76   </plugin>
116 +
117 + <!-- Build a fat JAR with all dependencies included -->
118 + <plugin>
119 + <groupId>org.apache.maven.plugins</groupId>
120 + <artifactId>maven-assembly-plugin</artifactId>
121 + <version>${maven-assembly-plugin.version}</version>
122 + <executions>
123 + <execution>
124 + <id>fat-jar</id>
125 + <phase>package</phase>
126 + <goals>
127 + <goal>single</goal>
128 + </goals>
129 + <configuration>
130 + <finalName>${project.artifactId}</finalName>
131 + <appendAssemblyId>false</appendAssemblyId>
132 + <descriptorRefs>
133 + <descriptorRef>jar-with-dependencies</descriptorRef>
134 + </descriptorRefs>
135 + <archive>
136 + <manifest>
137 + <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
138 + </manifest>
139 + <manifestEntries>
140 + <formcycle-version-requirement>${xfc.version}</formcycle-version-requirement>
141 + <Build-Timestamp>${maven.build.timestamp}</Build-Timestamp>
142 + <Plugin-Key>${project.groupId}:${project.artifactId}</Plugin-Key>
143 + <Implementation-Title>${project.groupId}:${project.artifactId}</Implementation-Title>
144 + <Implementation-Vendor-Id>${project.groupId}</Implementation-Vendor-Id>
145 + <Implementation-Version>${project.version}</Implementation-Version>
146 + </manifestEntries>
147 + </archive>
148 + </configuration>
149 + </execution>
150 + </executions>
151 + </plugin>
152 +
153 + <!-- Use JUnit to run test classes -->
154 + <plugin>
155 + <groupId>org.apache.maven.plugins</groupId>
156 + <artifactId>maven-surefire-plugin</artifactId>
157 + <version>${maven-surefire-plugin.version}</version>
158 + </plugin>
77 77   </plugins>
78 78   </build>
79 79  </project>
162 +
README.md
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.awa
Größe
... ... @@ -1,0 +1,1 @@
1 +15.7 KB
Inhalt
... ... @@ -1,0 +1,526 @@
1 +Maven plugin for starting a FORMCYCLE server, similar to the Jetty maven plugin, but initializes the FORMCYCLE application.
2 +
3 +## TL;DR
4 +
5 +Version 8:
6 +
7 +```bash
8 +# Standalone
9 +mvn de.xima.fc.maven.plugin:fc-server-maven-plugin:8.0.0:ms -DxfcVersion=8.0.4
10 +
11 +# FORMCYCLE plugin project
12 +mvn fc-server:run-ms-war
13 +```
14 +
15 +Version 7:
16 +
17 +> mvn de.xima.fc.maven.plugin:fc-server-maven-plugin:7.0.4:ms -DxfcVersion=7.0.16
18 +
19 +See [changelog](./CHANGELOG.md) for a list of versions.
20 +
21 +## Table of contents
22 +
23 +[[_TOC_]]
24 +
25 +## Versioning
26 +
27 +* The major and minor version are always equal to the FORMCYCLE major version against which the project was built.
28 +* The patch version is for the plugin.
29 +
30 +## Building
31 +
32 +```bash
33 +mvn clean install
34 +```
35 +
36 +## Release
37 +
38 +* Update version via `mvn versions:set -DnewVersion=1.2.3`
39 +* Add release notes to `CHANGELOG.md`
40 +* Upload code to github
41 +* `mvn clean deploy`
42 +* Add a tag `git tag -a 1.2.3` and push via `git push origin 1.2.3`
43 +* Set next development version `mvn versions:set -DnewVersion=1.2.4-SNAPSHOT`
44 +
45 +## Site
46 +
47 +```bash
48 +mvn site
49 +mvn site:stage
50 +```
51 +
52 +The open `target/staging/index.html` in a browser. See `target/staging/fc-server-maven-plugin/plugin-info.html`
53 +for the MOJO documentation.
54 +
55 +## Terms
56 +
57 +A "FORMCYCLE plugin project" is Maven project packaged as a fat jar, with a (possibly transitive)
58 +compile dependency on `de.xima.fc:fc-plugin-common` in the `provided` scope.
59 +
60 +A Maven project "packaged as a fat jar" is Maven project with its `packaging` set to `jar` and
61 +that includes a plugin execution for either the `maven-assembly-plugin` or the `maven-shade-plugin`.
62 +
63 +## Goals
64 +
65 +See the site above for more in-depth info.
66 +
67 +* `ms` Intended for use as a command line tool to start a server without a Maven project:
68 + `mvn fc-server:ms`.
69 +* `run-ms-war` Intended for use as a command line tool to start a server on an existing
70 + [FORMCYCLE plugin project](#terms): `mvn fc-server:ms`.
71 +* `start-ms-war` Goal for integration into an existing lifecycle defined in a pom.xml, should be
72 + bound to a particular phase. Does not block by default.
73 +
74 +## Usage
75 +
76 +This is a Maven plugin with several goals. You can run it via the command line:
77 +
78 +```bash
79 +# When you have no Maven project
80 +mvn fc-server:ms
81 +
82 +# When you have an existing FORMYCLE plugin project
83 +mvn fc-server:run-ms-war
84 +```
85 +
86 +If the command is run from within an existing Maven project, it first packages the project, then starts the server and finally (if `-DdeployMavenProject=true` is set), installs the main artifact file of the Mavne project automatically into the started FORMCYCLE instance.
87 +
88 +The first command can be used in a directory without a Maven project.
89 +
90 +If the second command is run on an existing [FORMCYCLE plugin project](#terms), it first packages that project, then
91 +starts the server and finally installs the main artifact file of the Maven project automatically into the started
92 +FORMCYCLE instance.
93 +
94 +If Maven cannot find the plugin or you need to run a specific version of the plugin, you have to use the full coordinates:
95 +
96 +> mvn de.xima.fc.maven.plugin:fc-server-maven-plugin:8.0.0-SNAPSHOT:run-ms-war
97 +
98 +To get Maven to find the plugin without the full name, either add the plugin to `<plugin>` section of your `pom.xml` or add the following to the `~/.m2/settings.xml`:
99 +
100 +```xml
101 +<settings>
102 + <pluginGroups>
103 + <pluginGroup>de.xima.fc.maven.plugin</pluginGroup>
104 + </pluginGroups>
105 +</settings>
106 +```
107 +
108 +If you want to configure the plugin, you can do so via a `<plugin>` section in the `pom.xml`. See the
109 +site above for documentation. Below are some example configurations.
110 +
111 +### Use a different FORMCYCLE version
112 +
113 +The FORMCYCLE version defaults to the version against which the version of the plugin was built. The plugin major and minor version always follow the FORMCYCLE version, e.g. plugin version 7.0.9 will default to some `7.0.x` release of FORMCYCLE.
114 +
115 +To set the version of the FORMCYCLE app:
116 +
117 +```xml
118 +<plugin>
119 + <groupId>de.xima.fc.maven.plugin</groupId>
120 + <artifactId>fc-server-maven-plugin</artifactId>
121 + <version>${fc-server-maven-plugin.version}</version>
122 + <configuration>
123 + <xfcVersion>7.0.7</xfcVersion>
124 + </configuration>
125 +</plugin>
126 +```
127 +
128 +Note that you can also use:
129 +
130 +> mvn fc-server:ms -DxfcVersion=7.0.7
131 +
132 +You may have to use a different version of the plugin for older FC versions (major and minor plugin version always follow the FC version)
133 +
134 +> mvn de.xima.fc.maven.plugin:fc-server-maven-plugin:7.0.4:ms -DxfcVersion=7.0.16
135 +
136 +### Use a custom FORMCYCLE war file
137 +
138 +If you need to, you can also use a custom FORMCYCLE WAR file, e.g. a local build etc.
139 +
140 +
141 +```xml
142 +<plugin>
143 + <groupId>de.xima.fc.maven.plugin</groupId>
144 + <artifactId>fc-server-maven-plugin</artifactId>
145 + <version>${fc-server-maven-plugin.version}</version>
146 + <configuration>
147 + <warFile>/path/to/formcycle.war</warFile>
148 + </configuration>
149 +</plugin>
150 +```
151 +
152 +You can also use specify this setting on the command line:
153 +
154 +> mvn fc-server:ms -DwarFile=/path/to/formcycle.war
155 +
156 +### Change servlet container settings
157 +
158 +You can change the server context path and port:
159 +
160 +```xml
161 +<plugin>
162 + <groupId>de.xima.fc.maven.plugin</groupId>
163 + <artifactId>fc-server-maven-plugin</artifactId>
164 + <version>${fc-server-maven-plugin.version}</version>
165 + <configuration>
166 + <contextPath>form-server</contextPath>
167 + <port>8099</port>
168 + </configuration>
169 +</plugin>
170 +```
171 +
172 +You can also use specify these settings on the command line:
173 +
174 +> mvn fc-server:ms -DcontextPath=form-server -Dport=8090
175 +
176 +### Change app persistence directory
177 +
178 +All FORMCYCLE specific data such as the log files, configuration files or temporary files are stored in the application directory in the `target` folder. You can use a different app directory if you want.
179 +
180 +```xml
181 +<plugin>
182 + <groupId>de.xima.fc.maven.plugin</groupId>
183 + <artifactId>fc-server-maven-plugin</artifactId>
184 + <version>${fc-server-maven-plugin.version}</version>
185 + <configuration>
186 + <appDir>${project.basedir}/xfc-server</appDir>
187 + </configuration>
188 +</plugin>
189 +```
190 +
191 +You can also use specify this setting on the command line:
192 +
193 +> mvn fc-server:ms -DappDir=target/apps/xfc-server
194 +
195 +### Use a different servlet container
196 +
197 +By default, Jetty is used, but this can be changed:
198 +
199 +```xml
200 +<plugin>
201 + <groupId>de.xima.fc.maven.plugin</groupId>
202 + <artifactId>fc-server-maven-plugin</artifactId>
203 + <version>${fc-server-maven-plugin.version}</version>
204 + <configuration>
205 + <container>tomcat:9</container>
206 + </configuration>
207 +</plugin>
208 +```
209 +
210 +You can also use specify this setting on the command line:
211 +
212 +> mvn fc-server:ms -Dcontainer=tomcat:9
213 +
214 +By default, supported values are currently
215 +
216 +* `jetty:10` - Jetty Servlet Container Version 10.x
217 +* `tomcat:9` - Apache Tomcat Version 9.x
218 +
219 +To use a custom container, include a `de.xima.servletcontainer.api.IServletContainerProvider` in
220 +the classpath and specify the corresponding name.
221 +
222 +### Use in-memory H2 database
223 +
224 +By default, the H2 database is stored in a file, so the data is persisted when you restart the server. But you can also use an in-memory database:
225 +
226 +```xml
227 +<plugin>
228 + <groupId>de.xima.fc.maven.plugin</groupId>
229 + <artifactId>fc-server-maven-plugin</artifactId>
230 + <version>${fc-server-maven-plugin.version}</version>
231 + <configuration>
232 + <h2Storage>ram</h2Storage>
233 + </configuration>
234 +</plugin>
235 +```
236 +
237 +You can also use specify this setting on the command line:
238 +
239 +> mvn fc-server:ms -Dh2Storage=ram
240 +
241 +### Use a different database
242 +
243 +Include the driver via `dbDrivers` and configure the `database.properties`:
244 +
245 +```xml
246 +<plugin>
247 + <groupId>de.xima.fc.maven.plugin</groupId>
248 + <artifactId>fc-server-maven-plugin</artifactId>
249 + <version>${fc-server-maven-plugin.version}</version>
250 + <configuration>
251 + <dbDrivers>
252 + <dbDriver>postgresql</dbDriver>
253 + </dbDrivers>
254 + <databaseProperties>
255 + <properties>
256 + <property>
257 + <name>db.connection.dbms.shortname</name>
258 + <value>postgresql</value>
259 + </property>
260 + <property>
261 + <name>db.connection.jdbcurl</name>
262 + <value>jdbc:postgresql://localhost:5432/my_database</value>
263 + </property>
264 + <property>
265 + <name>db.connection.login.username</name>
266 + <value>USERNAME</value>
267 + </property>
268 + <property>
269 + <name>db.connection.login.password</name>
270 + <value>PASSWORD</value>
271 + </property>
272 + </properties>
273 + </databaseProperties>
274 + </configuration>
275 +</plugin>
276 +```
277 +
278 +You can also use specify this setting on the command line (separate multiple drivers with a comma):
279 +
280 +> mvn fc-server:ms -DaddDbDrivers=postgresql,h2 -DdbShortname=postgresql -DdbJdbcUrl=jdbc:postgresql://localhost:5432/my_database -DdbUsername=USERNAME -DdbPassword=PASSWORD
281 +
282 +Supported database drivers are
283 +
284 +* `h2`
285 +* `mariadb`
286 +* `mysql`
287 +* `oracle`
288 +* `postgresql`
289 +* `sqlserver`
290 +* `custom` (does not add any driver, add your own driver via `dependencies`)
291 +
292 +### Create default clients
293 +
294 +You can add additional clients to be created when the FORMCYCLE app starts. When the client exists already, it is updated with the configured settings. Clients are identified by their `name`.
295 +
296 +```xml
297 +<plugin>
298 + <groupId>de.xima.fc.maven.plugin</groupId>
299 + <artifactId>fc-server-maven-plugin</artifactId>
300 + <version>${fc-server-maven-plugin.version}</version>
301 + <configuration>
302 + <bootstrap>
303 + <clientManagement>
304 + <!-- Do not create the default client -->
305 + <excludeDefaults>true</excludeDefaults>
306 + <clients>
307 + <!-- Create a default client -->
308 + <client>
309 + <baseSettings>
310 + <name>myforms</name>
311 + <alias>Formular</alias>
312 + <languageTag>de</languageTag>
313 + <baseUrl>http://10.42.42.50/form-server</baseUrl>
314 + <description>Client for testing forms</description>
315 + </baseSettings>
316 + <adminUser>
317 + <userName>awa</userName>
318 + <email>awa@xima.de</email>
319 + <givenName>Andre</givenName>
320 + <lastName>Wachsmuth</lastName>
321 + <password>12345678</password>
322 + </adminUser>
323 + </client>
324 + </clients>
325 + </clientManagement>
326 + </bootstrap>
327 + </configuration>
328 +</plugin>
329 +```
330 +
331 +### Including additional plugins
332 +
333 +You can include additional plugins that should be installed after the FORMYCLE app was started:
334 +
335 +```xml
336 +<plugin>
337 + <groupId>de.xima.fc.maven.plugin</groupId>
338 + <artifactId>fc-server-maven-plugin</artifactId>
339 + <version>${fc-server-maven-plugin.version}</version>
340 + <configuration>
341 + <bootstrap>
342 + <pluginManagement>
343 + <plugins>
344 + <!-- You can specify a Maven coordinate when the plugin is available via Maven -->
345 + <plugin>
346 + <location>de.xima.fc.plugin:fc-plugin-bundle-leitfaden:2.0.22</location>
347 + </plugin>
348 + <!-- You can also specify a local path -->
349 + <plugin>
350 + <location>/path/to/some-plugin.jar</location>
351 + </plugin>
352 + </plugins>
353 + </pluginManagement>
354 + </bootstrap>
355 + </configuration>
356 +</plugin>
357 +```
358 +
359 +You can also use specify this setting on the command line:
360 +
361 +> mvn fc-server:ms -DaddSystemPlugins=de.xima.fc.plugin:fc-plugin-bundle-leitfaden:2.0.22
362 +
363 +Supported plugin sources:
364 +
365 +* Store coordinate:
366 + * `store:/1ce83c47-7b8d-4da8-844e-723cf5e3c426/2.0.7`(no double slash!)
367 + * in general: `store://[itemKey]/[version]/[fileName]?store=[storeKey]&server=[baseUrl]`
368 + * only the `itemKey` and `version` are required
369 +* Maven coordinate
370 + * `-DaddSystemPlugins=de.xima.fc.plugin:fc-plugin-bundle-leitfaden:2.0.22`
371 +* File:
372 + * `-DaddSystemPlugins=/home/user/Downloads/myPlugin.jar`
373 +* URL:
374 + * `-DaddSystemPlugins=https://example.com/plugin.jar`
375 +
376 +### Use a different or no license
377 +
378 +By default, a demo license is used. To use a different license:
379 +
380 +```xml
381 +<plugin>
382 + <groupId>de.xima.fc.maven.plugin</groupId>
383 + <artifactId>fc-server-maven-plugin</artifactId>
384 + <version>${fc-server-maven-plugin.version}</version>
385 + <configuration>
386 + <licenseFile>/path/to/license.lic</licenseFile>
387 + </configuration>
388 +</plugin>
389 +```
390 +
391 +You can also use specify this setting on the command line:
392 +
393 +> mvn fc-server:ms -DlicenseFile=/path/to/license.lic
394 +
395 +Sometimes you may want to start the server without a preinstalled license:
396 +
397 +```xml
398 +<plugin>
399 + <groupId>de.xima.fc.maven.plugin</groupId>
400 + <artifactId>fc-server-maven-plugin</artifactId>
401 + <version>${fc-server-maven-plugin.version}</version>
402 + <configuration>
403 + <licenseFile>builtin:none</licenseFile>
404 + </configuration>
405 +</plugin>
406 +```
407 +
408 +The value for `licenseFile` can be either
409 +* a file path
410 + * `file:/path/to/license.lic`
411 +* a file URI
412 + * `file:/path/to/license.lic`
413 +* a builtin URI:
414 + * `builtin:<name>`
415 + * `builtin:demo` Uses a simple demo license.
416 + * `builtin:none` Uses no license.
417 +
418 +### Deploy current plugin project on startup
419 +
420 +By default, the `run-ms-war` goal checks whether the current Maven project is a
421 +[FORMCYCLE plugin project](#terms). If so, it automatically picks up the main artifact file
422 +of the project and installs the plugin after the FORMCYCLE app was started.
423 +
424 +To configure this behavior, add the following configuration in your pom:
425 +
426 +```xml
427 +<plugin>
428 + <groupId>de.xima.fc.maven.plugin</groupId>
429 + <artifactId>fc-server-maven-plugin</artifactId>
430 + <version>${fc-server-maven-plugin.version}</version>
431 + <configuration>
432 + <deployMavenProject>true</deployMavenProject>
433 + </configuration>
434 +</plugin>
435 +```
436 +
437 +You can also use specify this setting on the command line:
438 +
439 +> mvn fc-server:run-ms-war -DdeployMavenProject=false
440 +
441 +### Include additional dependencies
442 +
443 +Sometimes you may want to include additional dependencies in the classpath, e.g. for custom servlet container
444 +providers or database drivers.
445 +
446 +You can add additional dependencies on a per-execution basis like this:
447 +
448 +```xml
449 +<plugin>
450 + <groupId>de.xima.fc.maven.plugin</groupId>
451 + <artifactId>fc-server-maven-plugin</artifactId>
452 + <version>${fc-server-maven-plugin.version}</version>
453 + <executions>
454 + <execution>
455 + <goals>
456 + <goal>run-ms-war</goal>
457 + </goals>
458 + <phase>package</phase>
459 + <configuration>
460 + <dependencies>
461 + <dependency>
462 + <groupId>com.ibm.db2</groupId>
463 + <artifactId>jcc</artifactId>
464 + <version>11.5.8.0</version>
465 + </dependency>
466 + </dependencies>
467 + </configuration>
468 + </execution>
469 + </executions>
470 +</plugin>
471 +```
472 +
473 +You can also use specify this setting on the command line (separate multiple dependenies with a comma):
474 +
475 +> mvn fc-server:run-ms-war -DaddDependencies=com.ibm.db2:jcc:com.ibm.db2
476 +
477 +### Skip execution for multi-module projects
478 +
479 +By default, the `run-ms-war` goal skips execution when run on a Maven project that is not a
480 +[FORMCYCLE plugin project](#terms). This can be useful e.g. when you have a multi-module project
481 +where only one project is a FORMYCLE plugin. You can then simply invoke `mvn fc-server:run-ms-war`
482 +on the parent project. This builds the entire project until it reaches the FORMCYCE plugin, at which
483 +point it starts the server and installs the built plugin.
484 +
485 +To disable this default behavior, use `-DskipNonPluginProject=false` or use the following configuration in your pom:
486 +
487 +```xml
488 +<plugin>
489 + <groupId>de.xima.fc.maven.plugin</groupId>
490 + <artifactId>fc-server-maven-plugin</artifactId>
491 + <version>${fc-server-maven-plugin.version}</version>
492 + <configuration>
493 + <skipNonPluginProject>true</skipNonPluginProject>
494 + </configuration>
495 +</plugin>
496 +```
497 +
498 +You can also force the execution to be always skipped via the `skip` parameter in your pom:
499 +
500 +
501 +```xml
502 +<plugin>
503 + <groupId>de.xima.fc.maven.plugin</groupId>
504 + <artifactId>fc-server-maven-plugin</artifactId>
505 + <version>${fc-server-maven-plugin.version}</version>
506 + <configuration>
507 + <skip>true</skip>
508 + </configuration>
509 +</plugin>
510 +```
511 +
512 +You can also use specify this setting on the command line:
513 +
514 +> mvn fc-server:run-ms-war -Dskip.fc.server
515 +
516 +### Remote debugging
517 +
518 +To remote debug the the application server, start it with
519 +
520 +> MAVEN_OPTS=-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=1044 mvn fc-server:ms
521 +
522 +Then attach the debugger to port 1044.
523 +
524 +Note: When you start this goal from within your IDE, you usually do no need to specify this manually
525 +as your IDE will usually attach to the JVM process automatically already.
526 +