Chapter 2. Getting started

Procedure

1. Add the following <plugin> to your application’s pom.xml file:

   [...]
   <plugin>
       <groupId>org.jboss.windup.plugin</groupId>
       <artifactId>mtr-maven-plugin</artifactId>
       <version>1.1.1.GA-redhat-00001</version>
       <executions>
           <execution>
               <id>run-windup</id>
               <phase>package</phase>
               <goals>
                   <goal>windup</goal>
               </goals>
           </execution>
       </executions>
       <configuration>
           <target>eap:7</target> 1
       </configuration>
   </plugin>
   [...]

   1

   Specify a migration target. At least one migration target must be supplied within the configuration.

2. Add --add-modules=java.se to the MAVEN_OPTS environment variable.

   export MAVEN_OPTS=--add-modules=java.se

3. Build the project:

   $ mvn clean install

   You can access the generated reports.

1. Include the following plugin inside the parent project’s pom.xml. The following is a sample pom.xml for a parent module.

   <plugin>
       <groupId>org.jboss.windup.plugin</groupId>
       <artifactId>mtr-maven-plugin</artifactId>
       <version>1.1.1.GA-redhat-00001</version>
       <inherited>false</inherited>
       <executions>
           <execution>
               <id>run-windup</id>
               <phase>package</phase>
               <goals>
                   <goal>windup</goal>
               </goals>
           </execution>
       </executions>
       <configuration>
           <input>${project.basedir}</input>
           <target>eap:7</target> 1
           <windupHome>>/PATH/TO/CLI/<</windupHome>
       </configuration>
   </plugin>

   1

   Specify a migration target. At least one migration target must be supplied within the configuration.

   This pom.xml file differs from the default in the following attributes:

   • inherited: Defined at the plugin level, this attribute indicates whether or not this configuration should be used in child modules. Set to false for performance improvements.
   • input: Specifies the path to the directory containing the projects to be analyzed. This attribute defaults to {project.basedir}/src/main, and should be defined if the parent project does not have source code to analyze.

   • windupHome: A path to an extracted copy of the MTR CLI. This attribute is optional, but is recommended as a performance improvement.

     The above example demonstrates a set of recommended arguments.

2. Build the parent project. During the build process the Maven plugin runs against all children in the project without further configuration.

   $ mvn clean install

3. Once completed, you can access the generated reports. This report contains the analysis for the parent and all children.