Chapter 7. Getting Started with OptaPlanner and Quarkus

Procedure

1. Open the Maven ~/.m2/settings.xml file in a text editor or integrated development environment (IDE).

   Note

   If there is not a settings.xml file in the ~/.m2/ directory, copy the settings.xml file from the $MAVEN_HOME/.m2/conf/ directory into the ~/.m2/ directory.

2. Add the following lines to the <profiles> element of the settings.xml file:

   <!-- Configure the Maven repository -->
   <profile>
     <id>red-hat-enterprise-maven-repository</id>
     <repositories>
       <repository>
         <id>red-hat-enterprise-maven-repository</id>
         <url>https://maven.repository.redhat.com/ga/</url>
         <releases>
           <enabled>true</enabled>
         </releases>
         <snapshots>
           <enabled>false</enabled>
         </snapshots>
       </repository>
     </repositories>
     <pluginRepositories>
       <pluginRepository>
         <id>red-hat-enterprise-maven-repository</id>
         <url>https://maven.repository.redhat.com/ga/</url>
         <releases>
           <enabled>true</enabled>
         </releases>
         <snapshots>
           <enabled>false</enabled>
         </snapshots>
       </pluginRepository>
     </pluginRepositories>
   </profile>

3. Add the following lines to the <activeProfiles> element of the settings.xml file and save the file.

   <activeProfile>red-hat-enterprise-maven-repository</activeProfile>

Procedure

1. Download the Red Hat build of Quarkus Maven repository ZIP file from the Software Downloads page of the Red Hat Customer Portal (login required).
2. Expand the downloaded archive.
3. Change directory to the ~/.m2/ directory and open the Maven settings.xml file in a text editor or integrated development environment (IDE).

4. Add the following lines to the <profiles> element of the settings.xml file, where QUARKUS_MAVEN_REPOSITORY is the path of the Quarkus Maven repository that you downloaded. The format of QUARKUS_MAVEN_REPOSITORY must be file://$PATH, for example file:///home/userX/rh-quarkus-1.11.6.GA-maven-repository/maven-repository.

   <!-- Configure the Quarkus Maven repository -->
   <profile>
     <id>red-hat-enterprise-maven-repository</id>
     <repositories>
       <repository>
         <id>red-hat-enterprise-maven-repository</id>
         <url>QUARKUS_MAVEN_REPOSITORY</url>
         <releases>
           <enabled>true</enabled>
         </releases>
         <snapshots>
           <enabled>false</enabled>
         </snapshots>
       </repository>
     </repositories>
     <pluginRepositories>
       <pluginRepository>
         <id>red-hat-enterprise-maven-repository</id>
         <url>QUARKUS_MAVEN_REPOSITORY</url>
         <releases>
           <enabled>true</enabled>
         </releases>
         <snapshots>
           <enabled>false</enabled>
         </snapshots>
       </pluginRepository>
     </pluginRepositories>
   </profile>

5. Add the following lines to the <activeProfiles> element of the settings.xml file and save the file.

   <activeProfile>red-hat-enterprise-maven-repository</activeProfile>

Procedure

1. Open https://code.quarkus.redhat.com in your web browser:
2. Specify details about your project:
3. Enter a group name for your project. The format of the name follows the Java package naming convention, for example, com.example.
4. Enter a name that you want to use for Maven artifacts generated from your project, for example code-with-quarkus.

5. Select Build Tool > Maven to specify that you want to create a Maven project. The build tool that you choose determines the items:

   • The directory structure of your generated project
   • The format of configuration files used in your generated project

   • The custom build script and command for compiling and starting your application that code.quarkus.redhat.com displays for you after you generate your project

     Note

     Red Hat provides support for using code.quarkus.redhat.com to create OptaPlanner Maven projects only. Generating Gradle projects is not supported by Red Hat.

6. Enter a version to be used in artifacts generated from your project. The default value of this field is 1.0.0-SNAPSHOT. Using semantic versioning is recommended, but you can use a different type of versioning if you prefer.

7. Enter the package name of artifacts that the build tool generates when you package your project.

   According to the Java package naming conventions the package name should match the group name that you use for your project, but you can specify a different name.

   Note

   The code.quarkus.redhat.com website automatically uses the latest release of OptaPlanner. You can manually change the BOM version in the pom.xml file after you generate your project.

8. Select the following extensions to include as dependencies:

   • RESTEasy JAX-RS (quarkus-resteasy)
   • RESTEasy Jackson (quarkus-resteasy-jackson)
   • OptaPlanner AI constraint solver(optaplanner-quarkus)

   • OptaPlanner Jackson (optaplanner-quarkus-jackson)

     Red Hat provides different levels of support for individual extensions on the list, which are indicated by labels next to the name of each extension:

     • SUPPORTED extensions are fully supported by Red Hat for use in enterprise applications in production environments.
     • TECH-PREVIEW extensions are subject to limited support by Red Hat in production environments under the Technology Preview Features Support Scope.
     • DEV-SUPPORT extensions are not supported by Red Hat for use in production environments, but the core functionalities that they provide are supported by Red Hat developers for use in developing new applications.

     • DEPRECATED extension are planned to be replaced with a newer technology or implementation that provides the same functionality.

       Unlabeled extensions are not supported by Red Hat for use in production environments.

9. Select Generate your application to confirm your choices and display the overlay screen with the download link for the archive that contains your generated project. The overlay screen also shows the custom command that you can use to compile and start your application.
10. Select Download the ZIP to save the archive with the generated project files to your system.
11. Extract the contents of the archive.

12. Navigate to the directory that contains your extracted project files:

    cd <directory_name>

13. Compile and start your application in development mode:

    ./mvnw compile quarkus:dev