Deploying into Spring Boot

Procedure

1. Navigate to https://developers.redhat.com/launch.

2. Click START.

   The launcher wizard prompts you to log in to your Red Hat account.

3. Click the Log in or register button and then log in.
4. On the Launcher page, click the Deploy an Example Application button.
5. On the Create Example Application page, type the name, fuse-circuit-breaker, in the Create Example Application as field.
6. Click Select an Example.

7. In the Example dialog, select the Circuit Breaker option. A Select a Runtime dropdown menu appears.

   1. From the Select a Runtime dropdown, select Fuse.
   2. From the version dropdown menu, select 7.12 (Red Hat Fuse) (do not select the 2.21.2 (Community) version).
   3. Click Save.
8. On the Create Example Application page, click Download.
9. When you see the Your Application is Ready dialog, click Download.zip. Your browser downloads the generated booster project (packaged as a ZIP file).
10. Use an archive utility to extract the generated project to a convenient location on your local file system.

1. Open a shell prompt and build the project from the command line, using Maven:

   cd PROJECT_DIR
   mvn clean package

   Copy to Clipboard Toggle word wrap

2. Open a new shell prompt and start the name service, as follows:

   cd name-service
   mvn spring-boot:run -DskipTests -Dserver.port=8081

   Copy to Clipboard Toggle word wrap

   As Spring Boot starts up, you should see some output like the following:

   ...
   2017-12-08 15:44:24.223  INFO 22758 --- [           main] o.a.camel.spring.SpringCamelContext      : Total 1 routes, of which 1 are started
   2017-12-08 15:44:24.227  INFO 22758 --- [           main] o.a.camel.spring.SpringCamelContext      : Apache Camel 2.20.0 (CamelContext: camel-1) started in 0.776 seconds
   2017-12-08 15:44:24.234  INFO 22758 --- [           main] org.jboss.fuse.boosters.cb.Application   : Started Application in 4.137 seconds (JVM running for 4.744)

   Copy to Clipboard Toggle word wrap

3. Open a new shell prompt and start the greetings service, as follows:

   cd greetings-service
   mvn spring-boot:run -DskipTests

   Copy to Clipboard Toggle word wrap

   As Spring Boot starts up, you should see some output like the following:

   ...
   2017-12-08 15:46:58.521  INFO 22887 --- [           main] o.a.c.c.s.CamelHttpTransportServlet      : Initialized CamelHttpTransportServlet[name=CamelServlet, contextPath=]
   2017-12-08 15:46:58.524  INFO 22887 --- [           main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8080 (http)
   2017-12-08 15:46:58.536  INFO 22887 --- [           main] org.jboss.fuse.boosters.cb.Application   : Started Application in 6.263 seconds (JVM running for 6.819)

   Copy to Clipboard Toggle word wrap

   The greetings service exposes a REST endpoint at the URL, http://localhost:8080/camel/greetings.

4. Go to http://localhost:8080

   When you open this page, it invokes the Greeting Service:

   

   View larger image

   

   This page also provides a link to the Hystrix dashboard, which monitors the state of the circuit breaker.

   

   View larger image

   

5. To demonstrate the circuit breaker functionality provided by Camel Hystrix, kill the backend name service by pressing Ctrl+C while in the window of the shell prompt where the name service is running.

   Now that the name service is unavailable, the circuit breaker kicks in to prevent the greetings service from hanging when it is invoked.

6. Observe the changes in the Hystrix Monitor dashboard and in the Greeting Service output:

   

   View larger image

   

1. Download the project and extract the archive on your local filesystem.

2. Build the project:

   cd PROJECT_DIR
   mvn clean package

   Copy to Clipboard Toggle word wrap

3. Run the service:

   mvn spring-boot:run

   Copy to Clipboard Toggle word wrap

4. Open a web browser to http://localhost:8080. This page invokes a Greeting Service every 5 seconds. The Greetings Service responds by using the booster.nameToGreetvalue from the target/classes/application.properties file.

   The Greeting Service prints a greeting to “default” every five seconds:

   

   View larger image

   

5. Modify the booster.nameToGreet value:

   1. Open the target/classes/application.properties file in an editor.

   2. Change the value of the booster.nameToGreetvalue from default to another value, for example Thomas:

      booster.nameToGreetvalue=Thomas

      Copy to Clipboard Toggle word wrap
6. In the Terminal window, stop the service by pressing CTRL+C.

7. Run the service again:

   mvn spring-boot:run

   Copy to Clipboard Toggle word wrap

8. In the web browser, return to the http://localhost:8080 page to view the changed value in the Greeting Service’s results window.

   

   View larger image

   

1. Download the project and extract the archive on your local filesystem.

2. Build the project:

   cd PROJECT_DIR
   mvn clean package

   Copy to Clipboard Toggle word wrap

3. Run the service:

   mvn spring-boot:run

   Copy to Clipboard Toggle word wrap
4. Open a web browser to: http://localhost:8080

5. To execute the example HTTP GET request, click the camel/greetings/{name} button.

   A new web browser window opens with the localhost:8080/camel/greetings/Jacopo URL. The default value of the URL {name} parameter is Jacopo.

   The JSON response appears in the browser window:

   

   View larger image

   

6. To change the value of the {name} parameter, change the URL. For example, to change the name to Thomas, use this URL: localhost:8080/camel/greetings/Thomas.

   The updated JSON response appears in the browser window:

   

   View larger image

   

7. To view the REST API’s Swagger page, click the API Swagger page button.

   The API swagger page opens in a browser window.

   

   View larger image

   

Procedure

1. To manually add the Keycloak Spring Boot starter, add the following to your project’s pom.xml.

   <dependency>
           <groupId>org.keycloak</groupId>
           <artifactId>keycloak-spring-boot-starter</artifactId>
   </dependency>

   Copy to Clipboard Toggle word wrap

2. Add the Adapter BOM dependency.

   <dependencyManagement>
     <dependencies>
           <dependency>
             <groupId>org.keycloak.bom</groupId>
             <artifactId>keycloak-adapter-bom</artifactId>
             <version>3.4.17.Final-redhat-00001</version>
             <type>pom</type>
             <scope>import</scope>
           </dependency>
     </dependencies>
   </dependencyManagement>

   Copy to Clipboard Toggle word wrap

3. Configure your Spring Boot project to use Keycloak. Instead of a keycloak.json file, you can configure the realm for the Spring Boot Keycloak adapter using the normal Spring Boot configuration. For example, add following configuration to src/main/resources/application.properties file.

   keycloak.realm = demorealm
   keycloak.auth-server-url = http://127.0.0.1:8080/auth
   keycloak.ssl-required = external
   keycloak.resource = demoapp
   keycloak.credentials.secret = 11111111-1111-1111-1111-111111111111
   keycloak.use-resource-role-mappings = true

   Copy to Clipboard Toggle word wrap

   You can disable the Keycloak Spring Boot Adapter (for example in tests) by setting keycloak.enabled = false. To configure a Policy Enforcer, unlike keycloak.json, policy-enforcer-config must be used instead of just policy-enforcer.

4. Specify the Java EE security configuration in the web.xml. The Spring Boot Adapter will set the login-method to KEYCLOAK and configure the security-constraints at the time of startup. An example configuration is given below.

   keycloak.securityConstraints[0].authRoles[0] = admin
   keycloak.securityConstraints[0].authRoles[1] = user
   keycloak.securityConstraints[0].securityCollections[0].name = insecure stuff
   keycloak.securityConstraints[0].securityCollections[0].patterns[0] = /insecure
   
   
   keycloak.securityConstraints[1].authRoles[0] = admin
   keycloak.securityConstraints[1].securityCollections[0].name = admin stuff
   keycloak.securityConstraints[1].securityCollections[0].patterns[0] = /admin

   Copy to Clipboard Toggle word wrap

   Note: If you plan to deploy your Spring Application as a WAR then do not use the Spring Boot Adapter. Use the dedicated adapter for the application server or servlet container you are using. Your Spring Boot should also contain a web.xml file.

Procedure

1. Add jasypt dependency to your project’s pom.xml file.

   <dependency>
       <groupId>com.github.ulisesbocchio</groupId>
       <artifactId>jasypt-spring-boot-starter</artifactId>
       <version>3.0.3</version>
   </dependency>

   Copy to Clipboard Toggle word wrap

2. Add Maven repository to your project’s pom.xml.

   <repository>
   <id>jasypt-basic</id>
   <name>Jasypt Repository</name>
   <url>https://repo1.maven.org/maven2/</url>
   </repository>

   Copy to Clipboard Toggle word wrap

3. Add the Jasypt Maven plugin to your project as well as it allows you to use the Maven commands for encryption and decryption.

   <plugin>
      <groupId>com.github.ulisesbocchio</groupId>
      <artifactId>jasypt-maven-plugin</artifactId>
      <version>3.0.3</version>
    </plugin>

   Copy to Clipboard Toggle word wrap

4. Add the plugin repository to pom.xml.

   <pluginRepository>
      <id>jasypt-basic</id>
      <name>Jasypt Repository</name>
      <url>https://repo1.maven.org/maven2/</url>
   </pluginRepository>

   Copy to Clipboard Toggle word wrap

5. To encrypt the username and password listed in the application.properties file, wrap these values inside DEC() as shown below.

   spring.datasource.username=DEC(root)
   spring.datasource.password=DEC(Password@1)

   Copy to Clipboard Toggle word wrap

6. Run the following command to encrypt the username and password.

   mvn jasypt:encrypt -Djasypt.encryptor.password=mypassword

   Copy to Clipboard Toggle word wrap

   This replaces the DEC() placeholders in the application.properties file with the encrypted value, for example,

   spring.datasource.username=ENC(3UtB1NhSZdVXN9xQBwkT0Gn+UxR832XP+tOOfFTlNL57FiMM7BWPRTeychVtLLhB)
   spring.datasource.password=ENC(4ErqElyCHjjFnqPOCZNAaTdRC7u7yJSy16UsHtVkwPIr+3zLyabNmQwwpFo7F7LU)

   Copy to Clipboard Toggle word wrap

7. To decrypt the credentials in the Spring application configuration file, run following command.

   mvn jasypt:decrypt -Djasypt.encryptor.password=mypassword

   Copy to Clipboard Toggle word wrap

   This prints out the content of the application.properties file as it was before the encryption. However, this does not update the configuration file.

Procedure

1. Add the following dependency to your Spring Boot pom.xml file:

   <dependency>
       <groupId>org.apache.camel</groupId>
       <artifactId>camel-spring-boot-starter</artifactId>
   </dependency>

   Copy to Clipboard Toggle word wrap

2. Add the classes with your Camel routes as shown in the snippet below. Once these routes are added to the class path the routes are started automatically.

   package com.example;
   
   import org.apache.camel.builder.RouteBuilder;
   import org.springframework.stereotype.Component;
   
   @Component
   public class MyRoute extends RouteBuilder {
   
       @Override
       public void configure() throws Exception {
           from("timer:foo")
             .to("log:bar");
       }
   }

   Copy to Clipboard Toggle word wrap

3. Optional. To keep the main thread blocked so that Camel stays up, do one of the following.

   1. Include the spring-boot-starter-web dependency,

   2. Or add camel.springboot.main-run-controller=true to your application.properties or application.yml file.

      You can customize the Camel application in the application.properties or application.yml file with camel.springboot.* properties.

4. Optional. To refer to a custom bean by using the bean’s ID name, configure the options in the src/main/resources/application.properties (or the application.yml) file. The following example shows how the xslt component refers to a custom bean by using the bean ID.

   1. Refer to a custom bean by the id myExtensionFactory.

      camel.component.xslt.saxon-extension-functions=myExtensionFactory

      Copy to Clipboard Toggle word wrap

   2. Then create the custom bean using Spring Boot @Bean annotation.

      @Bean(name = "myExtensionFactory")
      public ExtensionFunctionDefinition myExtensionFactory() {
          }

      Copy to Clipboard Toggle word wrap

      Or, for a Jackson ObjectMapper, in the camel-jackson data-format:

      camel.dataformat.json-jackson.object-mapper=myJacksonMapper

      Copy to Clipboard Toggle word wrap

Procedure

1. Define the properties either in the application.properties file:  

   route.from = jms:invoices

   Copy to Clipboard Toggle word wrap

   Or set the Camel properies as the system properties, for example:

   java -Droute.to=jms:processed.invoices -jar mySpringApp.jar

   Copy to Clipboard Toggle word wrap

2. Use the configured properties as placeholders in Camel route as follows.

   @Component
   public class MyRouter extends RouteBuilder {
   
     @Override
     public void configure() throws Exception {
       from("{{route.from}}").to("{{route.to}}");
     }
   
   }

   Copy to Clipboard Toggle word wrap

Procedure

1. Specify the include or exclude patterns in your unit test classes as properties to @SpringBootTest annotation, as shown below:

   @RunWith(CamelSpringBootRunner.class)
   @SpringBootTest(classes = {MyApplication.class);
      properties = {"camel.springboot.java-routes-include-pattern=**/Foo*"})
   public class FooTest {

   Copy to Clipboard Toggle word wrap

   In the FooTest class, the include pattern is **/Foo*, which represents an Ant style pattern. Here, the pattern starts with a double asterisk, which matches with any leading package name. /Foo* means the class name must start with Foo, for example, FooRoute.

2. Run the test using the following maven command:

   mvn test -Dtest=FooTest

   Copy to Clipboard Toggle word wrap

1. Add patch-maven-plugin to your project’s pom.xml file. The version of the patch-maven-plugin must be the same as the version of the Fuse BOM.

   <build>
       <plugins>
           <plugin>
               <groupId>org.jboss.redhat-fuse</groupId>
               <artifactId>patch-maven-plugin</artifactId>
               <version>${version.org.jboss-redhat-fuse}</version>
               <extensions>true</extensions>
           </plugin>
       </plugins>
   </build>

   Copy to Clipboard Toggle word wrap

2. When you run any one of the mvn clean deploy or mvn validate or mvn dependency:tree commands, the plugin searches through the project modules to check whether one of Red Hat Fuse BOMs is used. Only two are considered as the supported BOMs:

   • org.jboss.redhat-fuse:fuse-karaf-bom: for Fuse Karaf BOM
   • org.jboss.redhat-fuse:fuse-springboot-bom: for Fuse Spring Boot BOM

3. If none of the above BOMs are found, the plugin will display following messages:

   $ mvn clean install
   [INFO] Scanning for projects...
   [INFO]
   
   ========== Red Hat Fuse Maven patching ==========
   
   [INFO] [PATCH] No project in the reactor uses Fuse Karaf or Fuse Spring Boot BOM. Skipping patch processing.
   [INFO] [PATCH] Done in 3ms

   Copy to Clipboard Toggle word wrap

4. If both Fuse BOMs are found, the patch-maven-plugin stops with the following warning:

   $ mvn clean install
   [INFO] Scanning for projects...
   [INFO]
   
   ========== Red Hat Fuse Maven patching ==========
   
   [WARNING] [PATCH] Reactor uses both Fuse Karaf and Fuse Spring Boot BOMs. Please use only one. Skipping patch processing.
   [INFO] [PATCH] Done in 3ms

   Copy to Clipboard Toggle word wrap

5. The patch-maven-plugin attempts to fetch one of the following Maven metadata values.

   • For the projects with Fuse Karaf BOM, the org.jboss.redhat-fuse/fuse-karaf-patch-metadata/maven-metadata.xml is resolved. This is the metadata for the artifact with the org.jboss.redhat-fuse:fuse-karaf-patch-metadata:RELEASE coordinates.

   • For the projects with Fuse Spring Boot BOM project, the org.jboss.redhat-fuse/fuse-springboot-patch-metadata/maven-metadata.xml is resolved. This is the metadata for the artifact with the org.jboss.redhat-fuse:fuse-springboot-patch-metadata:RELEASE coordinates.

     Example metadata generated by Maven

     <?xml version="1.0" encoding="UTF-8"?>
     <metadata>
       <groupId>org.jboss.redhat-fuse</groupId>
       <artifactId>fuse-springboot-patch-metadata</artifactId>
       <versioning>
         <release>7.8.1.fuse-sb2-781025</release>
         <versions>
           <version>7.8.0.fuse-sb2-780025</version>
           <version>7.7.0.fuse-sb2-770010</version>
           <version>7.7.0.fuse-770010</version>
           <version>7.8.1.fuse-sb2-781025</version>
         </versions>
         <lastUpdated>20201023131724</lastUpdated>
       </versioning>
     </metadata>

     Copy to Clipboard Toggle word wrap

6. The patch-maven-plugin parses the metadata to select the version which is applicable to the current project. This is possible only for the Maven projects using Fuse BOM with version 7.8.xxx. Only the metadata that matches the version range 7.8, 7.9 or later is applicable and only the latest version of the metadata is fetched.

7. The patch-maven-plugin collects a list of remote Maven repositories to be used when downloading the patch metadata identified by groupId, artifactId and version found in previous steps. These Maven repositories are the ones that are listed in the project’s <repositories> elements in the active profiles and also the repositories from settings.xml file.

   $ mvn clean install
   [INFO] Scanning for projects...
   [INFO]
   
   ========== Red Hat Fuse Maven patching ==========
   
   [INFO] [PATCH] Reading patch metadata and artifacts from 2 project repositories
   [INFO] [PATCH]  - local-nexus: http://everfree.forest:8081/repository/maven-releases/
   [INFO] [PATCH]  - central: https://repo.maven.apache.org/maven2
   Downloading from local-nexus: http://everfree.forest:8081/repository/maven-releases/org/jboss/redhat-fuse/fuse-springboot-patch-metadata/maven-metadata.xml
   ...

   Copy to Clipboard Toggle word wrap

8. Optionally, if you wish to use a offline repository, you can use -Dpatch option to specify a ZIP file which is produced by fuse-karaf/fuse-karaf-patch-repository or fuse-springboot/fuse-springboot-patch-repository modules of jboss-fuse/redhat-fuse project. These ZIP files have the same internal structure as the Maven repository structure. For example,

   $ mvn clean install -Dpatch=../../../test/resources/patch-3.zip
   [INFO] Scanning for projects...
   [INFO]
   
   ========== Red Hat Fuse Maven patching ==========
   
   [INFO] [PATCH] Reading metadata and artifacts from /data/sources/github.com/jboss-fuse/redhat-fuse/fuse-tools/patch-maven-plugin/src/test/resources/patch-3.zip
   Downloading from fuse-patch: zip:file:/tmp/patch-3.zip-1742974214598205745/org/jboss/redhat-fuse/fuse-springboot-patch-metadata/maven-metadata.xml
   Downloaded from fuse-patch: zip:file:/tmp/patch-3.zip-1742974214598205745/org/jboss/redhat-fuse/fuse-springboot-patch-metadata/maven-metadata.xml (406 B at 16 kB/s)
   Downloading from fuse-patch: zip:file:/tmp/patch-3.zip-1742974214598205745/org/jboss/redhat-fuse/fuse-springboot-patch-metadata/7.8.0.fuse-sb2-781023/fuse-springboot-patch-metadata-7.8.0.fuse-sb2-781023.xml
   Downloaded from fuse-patch: zip:file:/tmp/patch-3.zip-1742974214598205745/org/jboss/redhat-fuse/fuse-springboot-patch-metadata/7.8.0.fuse-sb2-781023/fuse-springboot-patch-metadata-7.8.0.fuse-sb2-781023.xml (926 B at 309 kB/s)
   [INFO] [PATCH] Resolved patch descriptor: /home/user/.m2/repository/org/jboss/redhat-fuse/fuse-springboot-patch-metadata/7.8.0.fuse-sb2-781023/fuse-springboot-patch-metadata-7.8.0.fuse-sb2-781023.xml
   ...

   Copy to Clipboard Toggle word wrap

9. Whether the metadata comes from remote repository, local repository or ZIP file, it is analyzed by the patch-maven-plugin. The fetched metadata contains list of CVEs and for each CVE we have a list of affected Maven artifacts (specified by glob patterns and version ranges) together with a version that contains a fix for a given CVE. For example,

   <?xml version="1.0" encoding="UTF-8" ?>
   
   <metadata xmlns="urn:redhat:fuse:patch-metadata:1">
       <product-bom groupId="org.jboss.redhat-fuse" artifactId="fuse-springboot-bom" versions="[7.8,7.9)" />
       <cves>
           <cve id="CVE-2020-xyz" description="Jetty can be configured to listen on port 8080"
                   cve-link="https://nvd.nist.gov/vuln/detail/CVE-2020-xyz"
                   bz-link="https://bugzilla.redhat.com/show_bug.cgi?id=42">
               <affects groupId="org.eclipse.jetty" artifactId="jetty-*" versions="[9.4,9.4.32)" fix="9.4.32.v20200930" />
               <affects groupId="org.eclipse.jetty.http2" artifactId="http2-*" versions="[9.4,9.4.32)" fix="9.4.32.v20200930" />
           </cve>
       </cves>
       <fixes />
   </metadata>

   Copy to Clipboard Toggle word wrap

10. Finally a list of fixes specified in patch metadata is consulted when iterating over all managed dependencies in current project. These dependencies (and managed dependencies) that match are changed to fixed versions. For example:

    $ mvn clean install -U
    [INFO] Scanning for projects...
    [INFO
    
    ========== Red Hat Fuse Maven patching ==========
    
    [INFO] [PATCH] Reading patch metadata and artifacts from 2 project repositories
    [INFO] [PATCH]  - local-nexus: http://everfree.forest:8081/repository/maven-releases/
    [INFO] [PATCH]  - central: https://repo.maven.apache.org/maven2
    Downloading from local-nexus: http://everfree.forest:8081/repository/maven-releases/org/jboss/redhat-fuse/fuse-springboot-patch-metadata/maven-metadata.xml
    Downloading from central: https://repo.maven.apache.org/maven2/org/jboss/redhat-fuse/fuse-springboot-patch-metadata/maven-metadata.xml
    Downloaded from local-nexus: http://everfree.forest:8081/repository/maven-releases/org/jboss/redhat-fuse/fuse-springboot-patch-metadata/maven-metadata.xml (363 B at 4.3 kB/s)
    [INFO] [PATCH] Resolved patch descriptor: /home/user/.m2/repository/org/jboss/redhat-fuse/fuse-springboot-patch-metadata/7.8.0.fuse-sb2-780032/fuse-springboot-patch-metadata-7.8.0.fuse-sb2-780032.xml
    [INFO] [PATCH] Patch metadata found for org.jboss.redhat-fuse/fuse-springboot-bom/[7.8,7.9)
    [INFO] [PATCH]  - patch contains 1 CVE fix
    [INFO] [PATCH] Processing managed dependencies to apply CVE fixes... (https://nvd.nist.gov/vuln/detail/CVE-2020-xyz, https://bugzilla.redhat.com/show_bug.cgi?id=42_
    [INFO] [PATCH] - CVE-2020-xyz: Jetty can be configured to expose itself on port 8080
    [INFO] [PATCH]   Applying change org.eclipse.jetty/jetty-*/[9.4,9.4.32) -> 9.4.32.v20200930
    [INFO] [PATCH]    - managed dependency: org.eclipse.jetty/jetty-alpn-client/9.4.30.v20200611 -> 9.4.32.v20200930
    ...
    [INFO] [PATCH]    - managed dependency: org.eclipse.jetty/jetty-openid/9.4.30.v20200611 -> 9.4.32.v20200930
    [INFO] [PATCH]   Applying change org.eclipse.jetty.http2/http2-*/[9.4,9.4.32) -> 9.4.32.v20200930
    [INFO] [PATCH]    - managed dependency: org.eclipse.jetty.http2/http2-client/9.4.30.v20200611 -> 9.4.32.v20200930
    ...
    [INFO] [PATCH] Done in 635ms
    
    =================================================

    Copy to Clipboard Toggle word wrap