Änderungen von Dokument Plugin-Entwicklung

Von Version 11.1
bearbeitet von awa
am 04.12.2022, 00:41
Änderungskommentar: Uploaded new attachment "pom.xml", version 1.8
Auf Version 12.1
bearbeitet von awa
am 04.12.2022, 00:43
Änderungskommentar: Uploaded new attachment "README.md", version 1.1

Zusammenfassung

Details

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 +