Extension Maven Plugin
Last modified by Thomas Mortagne on 2020/03/26 08:29
Various extension-oriented mojos for Maven builds.
WAR Mojo
Generate a complete extension descriptor (.xed file) for all the jars packaged in a WAR (next to each one) as well as for the WAR itself (in /META-INF/).
To execute it:
<plugin>
<groupId>org.xwiki.commons</groupId>
<artifactId>xwiki-commons-tool-extension-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>war</goal>
</goals>
</execution>
</executions>
</plugin>
<groupId>org.xwiki.commons</groupId>
<artifactId>xwiki-commons-tool-extension-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>war</goal>
</goals>
</execution>
</executions>
</plugin>
Register Mojo
Generate complete extension descriptor (.xed file) for the current artifact in /META-INF/.
<plugin>
<groupId>org.xwiki.commons</groupId>
<artifactId>xwiki-commons-tool-extension-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>register</goal>
</goals>
</execution>
</executions>
</plugin>
<groupId>org.xwiki.commons</groupId>
<artifactId>xwiki-commons-tool-extension-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>register</goal>
</goals>
</execution>
</executions>
</plugin>
XIP Mojo and extension
Generate a xip package containing the dependencies of the current project by default. It's mostly used in conjunction with xip extensions as a packaging tool.
To use it:
<packaging>xip</packaging>
Common parameters
All the Mojos above share a list of parameters. Some of them are described here.
disabledComponents
This parameter allows to specify a list of components to unregister from the component manager.
Example of an usage:
<configuration>
<disabledComponents>
<disabledComponent>
<type>com.xpn.xwiki.doc.MandatoryDocumentInitializer</type>
<role>XWiki.XWikiServerXwiki</role>
</disabledComponent>
</disabledComponents>
</configuration>
<disabledComponents>
<disabledComponent>
<type>com.xpn.xwiki.doc.MandatoryDocumentInitializer</type>
<role>XWiki.XWikiServerXwiki</role>
</disabledComponent>
</disabledComponents>
</configuration>
Note that if the role is not filled or given, the default hint will be used.