Red Hat Fuse 7.0
Migration Guide
Migrating to Red Hat Fuse 7.0
Last Updated: 2019-08-09
Red Hat Fuse 7.0 Migration Guide
Migrating to Red Hat Fuse 7.0
Legal Notice
Copyright © 2019 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative CommonsAttribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA isavailable athttp://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you mustprovide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert,Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift,Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United Statesand other countries.
Linux ® is the registered trademark of Linus Torvalds in the United States and other countries.
Java ® is a registered trademark of Oracle and/or its affiliates.
XFS ® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United Statesand/or other countries.
MySQL ® is a registered trademark of MySQL AB in the United States, the European Union andother countries.
Node.js ® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by theofficial Joyent Node.js open source or commercial project.
The OpenStack ® Word Mark and OpenStack logo are either registered trademarks/service marksor trademarks/service marks of the OpenStack Foundation, in the United States and othercountries and are used with the OpenStack Foundation's permission. We are not affiliated with,endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
Abstract
Use this guide to help you when when upgrading to the latest version of Red Hat Fuse.
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Table of Contents
CHAPTER 1. MIGRATION PATHS FOR FUSE 7.01.1. MIGRATION PATH FOR FUSE 7.0 ON KARAF1.2. MIGRATION PATH FOR FUSE 7.0 ON EAP1.3. DEPRECATED AND REMOVED FEATURES
CHAPTER 2. APACHE ACTIVEMQ MIGRATION
CHAPTER 3. KARAF MIGRATION3.1. MIGRATING APPLICATION CODE3.2. KARAF CONSOLE COMMANDS3.3. JMX OBJECT NAMES IN KARAF 4.X3.4. KARAF MIGRATION CHANGES
3.4.1. Migrating from Karaf 2.x to Karaf 3.x3.4.2. Migrating from Karaf 3.x to Karaf 4.x
3.5. NEW COMMANDS IN KARAF 4.X
CHAPTER 4. EAP 7.X MIGRATION4.1. MESSAGING4.2. WILDFLY MANAGEMENT PORT4.3. COMPONENT CAMEL-RESTLET4.4. WORKAROUNDS FOR CXF CONSUMERS4.5. MAVEN POM VERSION UPDATES
CHAPTER 5. MIGRATE FABRIC PROFILES5.1. OVERVIEW5.2. HIGH LEVEL CONCERNS5.3. IMPLEMENTATION DETAILS
CHAPTER 6. MIGRATE MAVEN PROJECTS6.1. BOM FILE FOR APACHE KARAF6.2. BOM FILE FOR JBOSS EAP6.3. BOM FILE FOR SPRING BOOT
CHAPTER 7. CAMEL MIGRATION ISSUES7.1. CAMEL 2.21 MIGRATION ISSUES7.2. CAMEL 2.20 MIGRATION ISSUES7.3. CAMEL 2.19 MIGRATION ISSUES
CHAPTER 8. APACHE CXF ISSUES8.1. APACHE CXF 3.1 MIGRATION
8.1.1. Main Changes8.1.2. Security changes8.1.3. New Features8.1.4. Major Dependency Changes
3333
4
55588999
121212121212
13131313
15151617
20202021
242424242425
Table of Contents
1
Red Hat Fuse 7.0 Migration Guide
2
CHAPTER 1. MIGRATION PATHS FOR FUSE 7.0
1.1. MIGRATION PATH FOR FUSE 7.0 ON KARAF
There is no automated migration path for Fuse 7.0. A new installation must be performed, withconfiguration and other modified files copied across manually. Applications will need to be recompiledto align with the new versions provided. Use the Maven Bill of Materials (BOM) file to migrate Mavendependencies to the new versions and see also Component Details.
1.2. MIGRATION PATH FOR FUSE 7.0 ON EAP
There is no automated migration path to Fuse 7.0 on EAP from previous version of Fuse on EAP. Tomigrate to Fuse 7.0 you will need to make a new installation of Fuse 7.0 on JBoss EAP. After a successfulinstallation, any existing deployments will need to be re-deployed to the new system. For installationinformation please see Installation on JBoss EAP and for deployment information see Deployment inthe Management Console.
1.3. DEPRECATED AND REMOVED FEATURES
For the list of features that have been deprecated or removed in Fuse 7.0, see Release Notes.
CHAPTER 1. MIGRATION PATHS FOR FUSE 7.0
3
CHAPTER 2. APACHE ACTIVEMQ MIGRATIONIn Fuse 7.0, the Apache ActiveMQ is no longer provided as an embedded broker in Apache Karaf.Instead of embedding the broker, Fuse 7.0 provides a variety of messaging clients which you can use toconnect to an external broker (such as Red Hat AMQ 7 or JBoss A-MQ 6.3).
For more details, see Deploying into Apache Karaf .
Red Hat Fuse 7.0 Migration Guide
4
CHAPTER 3. KARAF MIGRATIONThis section covers the changes in the Karaf version from 2.x to 4.x.
3.1. MIGRATING APPLICATION CODE
Applications will need to be recompiled to align with the new versions provided. Use the Maven Bill ofMaterials (BOM) file to migrate Maven dependencies to the new versions and see also ComponentDetails.
3.2. KARAF CONSOLE COMMANDS
The console commands have been renamed in Apache Karaf 4.x and differ from what they are in 2.x. Thepurpose is to standardize the naming convention.
NOTE
All of the admin:* and instance:* commands (for managing child Karaf containers) aredeprecated in Fuse 7.0 and will be removed in a future release. If you need to deploymultiple instances of a Karaf container on a single host, the recommended approach is touse OpenShift.
The following table lists the old commands and the new commands:
Table 3.1. Karaf console commands
Apache karaf 2.x Apache karaf 4.x
dev:create-dump dev:dump-create
features:add-url feature:repo-add
features:chooseurl feature:repo-add
features:info feature:info
features:install feature:install
features:listVersions feature:version-list
features:list feature:list
features:listRepositories feature:repo-list
features:listUrl feature:repo-list
features:refreshUrl feature:repo-refresh
features:removeRepository feature:repo-remove
CHAPTER 3. KARAF MIGRATION
5
features:removeUrl feature:repo-remove
features:uninstall feature:uninstall
jaas:pending jaas:pending-list
jaas:realms jaas:realm-list
jaas:users jaas:user-list
jaas:manage jaas:realm-manage
jaas:roleadd jaas:role-add
jaas:roledel jaas:role-delete
jaas:useradd jaas:user-add
jaas:userdel jaas:user-delete
config:propappend config:property-append
config:propdel config:property-delete
config:proplist config:property-list
config:propset config:property-set
dev:dynamic-import bundle:dynamic-import
dev:framework system:framework
dev:print-stack-traces shell:stack-traces-print
dev:restart system:shutdown
dev:show-tree bundle:tree-show
dev:system-property system:property
dev:wait-for-service service:wait
dev:watch bundle:watch
Apache karaf 2.x Apache karaf 4.x
Red Hat Fuse 7.0 Migration Guide
6
log:display-exception log:exception-display
obr:addUrl obr:url-add
obr:listUrl obr:url-list
obr:refreshUrl obr:url-refresh
obr:removeUrl obr:url-remove
osgi:bundle-level bundle:start-level
osgi:classes bundle:classes
osgi:find-class bundle:find-class
osgi:headers bundle:headers
osgi:info bundle:info
osgi:install bundle:install
osgi:bundle-services bundle:services
osgi:list bundle:list
osgi:ls service:list
osgi:name system:name
osgi:refresh bundle:refresh
osgi:resolve bundle:resolve
osgi:restart bundle:restart
osgi:shutdown system:shutdown
osgi:start bundle:start
osgi:start-level bundle:start-level
osgi:stop bundle:stop
Apache karaf 2.x Apache karaf 4.x
CHAPTER 3. KARAF MIGRATION
7
osgi:uninstall bundle:uninstall
osgi:update bundle:update
osgi:version system:version
packages:exports package:exports
packages:imports package:imports
Apache karaf 2.x Apache karaf 4.x
NOTE
Fuse 7.0 defines aliases for the Karaf 2.x commands. So you can continue using the oldcommands.
3.3. JMX OBJECT NAMES IN KARAF 4.X
The JMX MBeans object names are renamed and the operations are dispatched in new MBeans.
The table below lists the old JMX MBeans object names and the respective new object names.
Table 3.2. JMX object names
Apache Karaf 2.x Apache Karaf 4.x
org.apache.karaf:type=bundles,name=* org.apache.karaf:type=bundle,name=*
org.apache.karaf:type=config,name=* org.apache.karaf:type=config,name=*
org.apache.karaf:type=dev,name=* org.apache.karaf:type=system,name=*
org;apache.karaf:type=log,name=* org.apache.karaf:type=log,name=*
org.apache.karaf:type=obr,name=* org.apache.karaf:type=obr,name=*
org.apache.karaf:type=packages,name=* org.apache.karaf:type=package,name=*
org.apache.karaf:type=services,name=* org.apache.karaf:type=service,name=*
org.apache.karaf:type=system,name=* org.apache.karaf:type=system,name=*
org.apache.karaf:type=web,name=* org.apache.karaf:type=web,name=*
3.4. KARAF MIGRATION CHANGES
Red Hat Fuse 7.0 Migration Guide
8
This section covers the changes in Karaf 2.x to Karaf 3.x.
3.4.1. Migrating from Karaf 2.x to Karaf 3.x
The changes to Apache Karaf that must be considered before upgrading from versions 2.x to 3.x are:
The files in the different Apache Karaf folders have changed, and the merge/diff is very large soit is advisable to start a new Apache Karaf 3.x container rather than overriding the folders froman Apache Karaf 2.x container.
The future Apache Karaf versions will introduce the concept of Karaf Profiles to simplify theupdate process.
WebApplications using the WebApp-Context headers in the MANIFEST are no longersupported.
Apache Karaf now supports the OSGi standard Web-ContextPath header in the MANIFEST.
Apache Karaf 3.0.x is fully supported by OPS4J Pax Exam.
3.4.2. Migrating from Karaf 3.x to Karaf 4.x
The changes to Karaf that must be considered before upgrading from Karaf 2.x to Karaf 3.x.
Karaf 4.x supports Java8.
If you upgrade an existing Karaf container, make a note to update the lib and system folders.For the etc folder, a diff is required.
Karaf 4.x has a new Feature Resolver. The purpose is to simplify the features installation andlifecycle. The new resolver now checks the feature requirements defined in the features XML,and check which bundles provides the capabilities to satisfy these requirements. It allows Karafto automatically install bundles required by features. This feature is not enabled in Karaf 3.x.
3.5. NEW COMMANDS IN KARAF 4.X
Table 3.3. Apache Karaf 4.x commands
Apache Karaf 4.x
feature:requirement-list
feature:requirement-add
feature:requirement-remove
feature:regions
feature:start
feature:stop
CHAPTER 3. KARAF MIGRATION
9
jaas:group-create
jaas:group-add
jaas:group-delete
jaas:group-list
jaas:group-role-add
jaas:group-role-delete
jaas:su
jaas:sudo
shell:edit
shell:env
shell:less
shell:stack-traces-print
shell:threads
shell:while
log:list
bundle:capabilities
bundle:diag
bundle:id
bundle:load-test
bundle:requirements
bundle:resolve
system:name
Apache Karaf 4.x
In development environment you can use the blueprint definition as used in Karaf 2.x and 3.x
Red Hat Fuse 7.0 Migration Guide
10
In development environment you can use the blueprint definition as used in Karaf 2.x and 3.xwith the corresponding annotations.
In Karaf 4.x, you can use DS and new annotations and avoid the usage of a blueprint XML. Thenew annotations are: @Service, @Completion, @Parsing, @Reference. You can define thecommand directly in the command class.
Karaf 4.x provides the karaf-services-maven-plugin in org.apache.karaf.tooling MavengroupId to simplify the generation of the code and OSGi headers.
CHAPTER 3. KARAF MIGRATION
11
CHAPTER 4. EAP 7.X MIGRATIONThis section covers the changes in the EAP 7.x related to Messaging, WildFly Management Port, CXFconsumers, and other components that are used in Fuse 7.0 .
4.1. MESSAGING
The messaging subsystem on EAP 7.x uses Artemis instead of HornetQ. You need to migrate customEAP CLI scripts that reference the old EAP 6.x messaging subsystem to Artemis. See, EAP migrationguide [https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.1/html-single/migration_guide/index] for details.
4.2. WILDFLY MANAGEMENT PORT
The WildFly management port is changed to 9990. The old port number 9999 is no longer in use. Forconfigurations that use the wildly-maven-plugin in the pom files, you must remove references to port9999 as the plugin defaults to 9990.
4.3. COMPONENT CAMEL-RESTLET
The camel-restlet component has been removed from Fuse on EAP. The camel-restlet producers aresupported, but the consumers working on the old EAP JBoss Web stack never worked. Considering thatwe support a number of alternative HTTP components, the camel-restlet component was removedfrom Fuse 7.
You should switch to an alternate HTTP consumer component such as undertow, http4, netty-http4,and so on.
4.4. WORKAROUNDS FOR CXF CONSUMERS
The camel-cxf consumers are supported in Fuse 7.x. You can migrate to 'skinny' WAR deploymentsinstead of deploying 'fat' camel WAR deployments or other workarounds for using CXF consumers inFuse EAP 6.x.
4.5. MAVEN POM VERSION UPDATES
You need to update the Maven POMs to reference to the latest BOM & Fuse and EAP artifact versions.
Red Hat Fuse 7.0 Migration Guide
12
CHAPTER 5. MIGRATE FABRIC PROFILESThis section covers the migration of Fabric8 1.x profiles manually in Fuse 7.0.
5.1. OVERVIEW
Fabric8 V1 monolithic application deployments may need to be migrated to micro-serviceapplications or migrated to a monolith container in OpenShift that exposes several services (notoptimal).
Re-factor network of Broker architectures to JBoss AMQ-7. The re-factoring affects how userapplications connect to Broker and are deployed in OpenShift.
Containers can be mapped one to one from Fabric8 V1 deployments if the Fabric8 V1architecture was a micro services style deployment. Container meta data such as host name,port, and so on need to be mapped to OpenShift resources and concepts such as Nodes, Podsand Services.
Features and bundles that were only available in Fabric8 V1 need to be mapped to eitherOpenShift resources/features or to an alternative solution.
5.2. HIGH LEVEL CONCERNS
Fabric8 V1 deployments may be monoliths that are connected using Fabric, or they may be alarge number of small Fabric containers running ActiveMQ Brokers and, or Camel routes.
Monolith deployments will have to be refactored into several services under OpenShift.
Applications developed to run in Karaf could potentially be affected in the migration fromversion 2 to version 4. You have a choice between redeploying existing applications to a Karafimage on OpenShift or (optionally) refactoring applications to run in a Spring Boot containerinstead.
Use OpenShift’s EFK (ElasticSearch+Fluentd+Kibana) stack instead of Fabric8 V1 Insight for logmonitoring.
Use OpenShift application services and routes instead of Fabric8 V1 Gateway.
Monitoring in OpenShift is supported using Fuse 7 HawtIO console and Prometheus monitoringservice. Users have to configure and deploy their own Prometheus servers as the serverrequirements are unique to the applications being monitored.
5.3. IMPLEMENTATION DETAILS
Fabric8 V1 containers refactored to run small services will map to Fuse on OpenShift basedprojects packaged as OpenShift pod based services.
Fuse on OpenShift projects could be deployed using S2I templates to build the source inOpenShift builder pods, or built externally using Fabric8 maven plugin and deployed using S2Ibinary deployment. External builds may be more efficient and can be performed using externalCI/CD infrastructure such as Jenkins.
Fabric8 V1 container versions can be migrated to ImageStream tags for versioning in OpenShift.
OpenShift Deployment Configuration supports liveness probes and scaling of services.
CHAPTER 5. MIGRATE FABRIC PROFILES
13
A new fabric8-karaf-cm feature bridges OpenShift ConfigMaps and Karaf ConfigAdminservice to provide dynamic configuration updates in OpenShift Karaf applications. See Fuse onOpenShift Guide for more details.
Red Hat Fuse 7.0 Migration Guide
14
CHAPTER 6. MIGRATE MAVEN PROJECTSTo simplify migration of Maven projects, Fuse provides several Maven Bill of Materials (BOM) files. Acommon parent BOM file defines mutual dependencies. There is also a dedicated BOM file for eachcontainer that Fuse runs in:
Apache Karaf
JBoss EAP
Spring Boot
Each BOM file is a set of Maven dependency versions that work well together. This removes the need todefine the version individually for each Maven artifact.
You can find these BOM files here: https://github.com/jboss-fuse/redhat-fuse. The following sectionsprovide details for using the BOM files to migrate your Maven projects.
6.1. BOM FILE FOR APACHE KARAF
The purpose of a Maven Bill of Materials (BOM) file is to provide a curated set of Maven dependencyversions that work well together, saving you from having to define versions individually for every Mavenartifact.
The Fuse BOM for Apache Karaf offers the following advantages:
Defines versions for Maven dependencies, so that you do not need to specify the version whenyou add a dependency to your POM.
Defines a set of curated dependencies that are fully tested and supported for a specific versionof Fuse.
Simplifies upgrades of Fuse.
IMPORTANT
Only the set of dependencies defined by a Fuse BOM are supported by Red Hat.
To incorporate a Maven BOM file into your Maven project, specify a dependencyManagement elementin your project’s pom.xml file (or, possibly, in a parent POM file), as shown in the following example:
<?xml version="1.0" encoding="UTF-8" standalone="no"?><project ...> ... <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<!-- configure the versions you want to use here --> <fuse.version>7.0.0.fuse-000191-redhat-1</fuse.version> <bom.version>7.0.0.fuse-000027-redhat-1</bom.version>
<maven-compiler-plugin.version>3.3</maven-compiler-plugin.version> <maven-surefire-plugin.version>2.18.1</maven-surefire-plugin.version> </properties>
CHAPTER 6. MIGRATE MAVEN PROJECTS
15
NOTE
The org.jboss.redhat-fuse BOM is new in Fuse 7.0 and has been designed to simplifyBOM versioning. The Fuse quickstarts and Maven archetypes still use the old style ofBOM, however, as they have not yet been refactored to use the new one. Both BOMs arecorrect and you can use either one in your Maven projects. In an upcoming Fuse release,the quickstarts and Maven archetypes will be refactored to use the new BOM.
After specifying the BOM using the dependency management mechanism, it becomes possible to addMaven dependencies to your POM without specifying the version of the artifact. For example, to add adependency for the camel-velocity component, you would add the following XML fragment to the dependencies element in your POM:
Note how the version element is omitted from this dependency definition.
6.2. BOM FILE FOR JBOSS EAP
The purpose of a Maven Bill of Materials (BOM) file is to provide a curated set of Maven dependencyversions that work well together, saving you from having to define versions individually for every Mavenartifact.
The Fuse BOM for JBoss EAP offers the following advantages:
Defines versions for Maven dependencies, so that you do not need to specify the version whenyou add a dependency to your POM.
Defines a set of curated dependencies that are fully tested and supported for a specific versionof Fuse.
Simplifies upgrades of Fuse.
IMPORTANT
Only the set of dependencies defined by a Fuse BOM are supported by Red Hat.
<dependencyManagement> <dependencies> <dependency> <groupId>org.jboss.redhat-fuse</groupId> <artifactId>fuse-karaf-bom</artifactId> <version>${bom.version}</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> ...</project>
<dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-velocity</artifactId></dependency>
Red Hat Fuse 7.0 Migration Guide
16
To incorporate a BOM file into your Maven project, specify a dependencyManagement element in yourproject’s pom.xml file (or, possibly, in a parent POM file), as shown in the following example:
NOTE
The org.jboss.redhat-fuse BOM is new in Fuse 7.0 and has been designed to simplifyBOM versioning. The Fuse quickstarts and Maven archetypes still use the old style ofBOM, however, as they have not yet been refactored to use the new one. Both BOMs arecorrect and you can use either one in your Maven projects. In an upcoming Fuse release,the quickstarts and Maven archetypes will be refactored to use the new BOM.
After specifying the BOM using the dependency management mechanism, it becomes possible to addMaven dependencies to your POM without specifying the version of the artifact. For example, to add adependency for the camel-velocity component, you would add the following XML fragment to the dependencies element in your POM:
Note how the version element is omitted from this dependency definition.
6.3. BOM FILE FOR SPRING BOOT
The purpose of a Maven Bill of Materials (BOM) file is to provide a curated set of Maven dependency
<?xml version="1.0" encoding="UTF-8" standalone="no"?><project ...> ... <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<!-- configure the versions you want to use here --> <bom.version>7.0.0.fuse-000027-redhat-1</bom.version>
<maven-compiler-plugin.version>3.3</maven-compiler-plugin.version> <maven-surefire-plugin.version>2.18.1</maven-surefire-plugin.version> </properties>
<dependencyManagement> <dependencies> <dependency> <groupId>org.jboss.redhat-fuse</groupId> <artifactId>fuse-eap-bom</artifactId> <version>${bom.version}</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> ...</project>
<dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-velocity</artifactId> <scope>provided</scope></dependency>
CHAPTER 6. MIGRATE MAVEN PROJECTS
17
The purpose of a Maven Bill of Materials (BOM) file is to provide a curated set of Maven dependencyversions that work well together, saving you from having to define versions individually for every Mavenartifact.
The Fuse BOM for Spring Boot offers the following advantages:
Defines versions for Maven dependencies, so that you do not need to specify the version whenyou add a dependency to your POM.
Defines a set of curated dependencies that are fully tested and supported for a specific versionof Fuse.
Simplifies upgrades of Fuse.
IMPORTANT
Only the set of dependencies defined by a Fuse BOM are supported by Red Hat.
To incorporate a BOM file into your Maven project, specify a dependencyManagement element in yourproject’s pom.xml file (or, possibly, in a parent POM file), as shown in the following example:
NOTE
<?xml version="1.0" encoding="UTF-8" standalone="no"?><project ...> ... <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<!-- configure the versions you want to use here --> <bom.version>7.0.0.fuse-000027-redhat-1</bom.version> <spring-boot.version>1.5.13.RELEASE</spring-boot.version>
<maven-compiler-plugin.version>3.3</maven-compiler-plugin.version> <maven-surefire-plugin.version>2.18.1</maven-surefire-plugin.version> </properties>
<dependencyManagement> <dependencies> <dependency> <groupId>org.jboss.redhat-fuse</groupId> <artifactId>fuse-springboot-bom</artifactId> <version>${bom.version}</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> ...</project>
Red Hat Fuse 7.0 Migration Guide
18
NOTE
The org.jboss.redhat-fuse BOM is new in Fuse 7.0 and has been designed to simplifyBOM versioning. The Fuse quickstarts and Maven archetypes still use the old style ofBOM, however, as they have not yet been refactored to use the new one. Both BOMs arecorrect and you can use either one in your Maven projects. In an upcoming Fuse release,the quickstarts and Maven archetypes will be refactored to use the new BOM.
After specifying the BOM using the dependency management mechanism, it becomes possible to addMaven dependencies to your POM without specifying the version of the artifact. For example, to add adependency for the camel-hystrix component, you would add the following XML fragment to the dependencies element in your POM:
Note how the Camel artifact ID is specified with the -starter suffix — that is, you specify the CamelHystrix component as camel-hystrix-starter, not as camel-hystrix. The Camel starter components arepackaged in a way that is optimized for the Spring Boot environment.
<dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-hystrix-starter</artifactId></dependency>
CHAPTER 6. MIGRATE MAVEN PROJECTS
19
CHAPTER 7. CAMEL MIGRATION ISSUES
7.1. CAMEL 2.21 MIGRATION ISSUES
Fuse 7.0 uses Camel 2.21. This section covers the changes in Camel 2.21 that are to be consideredbefore upgrading to Fuse 7.0.
The changes to Camel 2.21 that must be considered before upgrading:
Jetty has been upgraded to version 9.4 by default and camel-jetty needs version 9.3 or 9.4 torun in OSGi.
The component camel-saxon is used to create the SaxonXpathFactory class is from Saxon. Inabsence of camel-saxon the factory method is created as per the old way.
The camel-json-validator component uses the NetworkNT JSon Schema validator libraryinstead of Everit. Everit had ASF license implications and will be removed from future Camelreleases. The NetworkNT supports v4 draft of JSon Schema for validation so update yourschemas to use the draft version.
The FileIdempotentRepository is updated to use the internal in-memory cache for quicklookup of the most frequent file names, and for lookup from disk. See the class javadoc of thefile for more details.
The Karaf commands for routes are changed so the arguments for the camel context is placedfirst, and the route id is the second argument. This allows the route completer to use theselected camel context name to only show route ids from that camel context else it shows allthe routes for every Camel application running in Karaf.
The camel-spring-boot actuator endpoints for routes are now in read-only mode by default.The operations to start, stop, suspend, `resume routes is forbidden. You can turn off read-only mode by setting the spring boot configuration endpoints.camelroutes.read-only = false.
7.2. CAMEL 2.20 MIGRATION ISSUES
This section covers the changes in Camel 2.20 that are to be considered before upgrading to Fuse 7.0.
The changes to Camel 2.20 that must be considered before upgrading:
The Maven version 3.3.3 or higher is required to build the project.
The camel-dropbox is upgraded to v2 api. There can be backward compatibility issues becuaseof the V2 upgrade.
In the camel-infinispan the result is not set in the CamelInfinispanOperationResult headerbut in the in body. To change this behavior you can set the header CamelInfinispanOperationResultHeader with the name of the header that contains the resultor with the resultHeader URI option.
The camel-infinispan URI option command has been deprecated and replaced by operation forconsistency purposes.
In camel-infinispan commands are changed to use the short form such as PUT, GET. The oldoperation names CamelInfinispanOperationPut and CamelInfinispanOperationGet havebeen deprecated.
Red Hat Fuse 7.0 Migration Guide
20
In camel-undertow the matchOnUriPrefix option, the default value is set to FALSE to make itconsistent with other components such as, Camel HTTP components.
The Twitter components are split into four types, directmessage, search, streaming and timeline and has its own endpoint and scheme.
The RuntimeEndpointRegistry is no longer in extended mode by default. To use extendedmode, set the management statistics level to Extended explicitly.
There is no RuntimeEndpointRegistry in use by default. You need to explicitly configure aregistry to be used, or turn it on using the management agent, or set the statistics level toextended mode.
Camel with Spring XML routes do not register endpoints in the Spring registry from Camelroutes where <from> or <to> have endpoints assigned with an explicit id attribute. The option registerEndpointIdsFromRoute can be set to true on <camelContext> for backwardcompatibility. But this registration is deprecated and instead you should use <endpoint> toregister Camel endpoints with id’s in Spring registry.
The camel-spring-dm has been removed. For XML DSL with OSGi use camel-blueprint.
NOTE
If you must use camel-spring-dm for Fuse 7.0, please see the Knowledge Base Article:How to run Spring-DM based applications on Fuse 7?.
Copying streams in IOHelper from came-core now regard EOL of data if the first read byte iszero. This change is a work around for issues on application servers such as IBM WebSphere.The setting can be turned off by configuring JVM system property "camel.zeroByteEOLEnabled=false".
The camel-jms component is based on the JMS 2.0 API (geronimo-jms_2.0_spec) instead ofJMS 1.1 API (geronimo-jms_1.1_spec). But camel-jms works at runtime with both JMS 1.1 or 2.0.
The camel-kura is upgraded to newer OSGi API version.
The camel-stomp uses the destination without replacing all slash characters with colon.
The camel-ignite is updated to use Ignite version 2.2.x .
The camel-dozer has been upgraded from Dozer v5 to v6 which requires migration. See, Dozermigration guides https://dozermapper.github.io/gitbook/migration/v5-to-v6.html andhttps://dozermapper.github.io/gitbook/migration/v6-to-v61.html
7.3. CAMEL 2.19 MIGRATION ISSUES
There are a number of changes in Camel 2.19 that have to be considered before upgrading to Fuse 7.0.
There are known issues that can break the API.
The groovy DSL from camel-groovy has been moved to camel-groovy-dsl module. Thecamel-groovy contains only the Camel Groovy Language.
The Camel-spring-LDAP uses java.util.function.BiFunction<L, Q, S> instead of org.apache.camel.component.springldap.LdapOperationsFunction<Q, S>.
CHAPTER 7. CAMEL MIGRATION ISSUES
21
The deprecated APIs from camel-spring-boot has been removed to upgrade and supportSpring Boot 1.5.x .
The camel-mongodb-gridf schema is renamed to mongodb-gridfs.
The commands-core Catalog commands have been removed.
The org.apache.camel.spring.boot.FatJarRouter is removed so you use the regular RouteBuilder classes in Spring Boot applications.
The Kafka endpoint option seekToBeginning=true should be migrated to seekTo=beginning.
The Kafka endpoint option bridgeEndpoint has moved from endpoint to the KafkaConfiguration class.
The Kafka component is now easier to configure and use. There is a backwards incompatiblechange so users need to migrate. The kafka URI is changed from kafka:brokers to kafka:topic.So you need to specify the topic name in the context-path and the brokers as parameters, forexample, the old syntax was kafka:myserver?topic=sometopic which is changed to kafka:sometopic?brokers=myserver.
The Infinispan URI syntax has changed from infinispan:hostName?options to infinispan:cacheName?options.
There are changes to Camel 2.19 that must be considered before upgrading:
The camel-spring-dm has been disabled from the Karaf features file so users cannot install itout of the box, it is also deprecated and users are encouraged to use OSGi Blueprint instead.The JAR is still shipped and can be installed manually but it there is no support avaiable. TheJAR will be removed completed in a future release.
NOTE
If you must use camel-spring-dm for Fuse 7.0, please see the Knowledge Base Article:How to run Spring-DM based applications on Fuse 7?.
The Groovy DSL and Scala DSL is deprecated and will be moved to Camel Extra and notdistributed out of the box in the future.
Camel now uses Karaf 4.x API and therefore not possible to run on older Karaf versions.
The camel-blueprint changed startup behavior to start on Blueprint.CREATED event which ismore appropriate way of startup instead of Blueprint.REGISTERED as was used previously.
The camel-spring-boot does not include prototype scoped beans when auto scanning forRouteBuilder instances, which is how camel-spring works. You can revert back using the includeNonSingletons option.
The camel-spring-javaconfig removed from Karaf features as it was not supported inOSGi/Karaf.
The camel spring-boot shell commands have been removed as spring-boot shell has beendeprecated in spring-boot.
The camel-box has been migrated to use box v2 api so there may be some migration needed asthe old camel-box component was using box v1 api.
Red Hat Fuse 7.0 Migration Guide
22
The JSon schema from camel-catalog have changed to use boolean, integer and numericvalues when applicable instead of using string values.
The camel-catalog Karaf commands has been removed.
CHAPTER 7. CAMEL MIGRATION ISSUES
23
CHAPTER 8. APACHE CXF ISSUES
8.1. APACHE CXF 3.1 MIGRATION
Fuse 7.0 uses Apache CXF 3.1. This introduces some issues that you sould be aware of before migrating.
8.1.1. Main Changes
The JAX-WS/Simple frontend ServerFactoryBean will automatically call reset at the end of the create() call. This allows resources to be cleaned up and garbage collected sooner. However, italso prevents multiple calls to create() from sharing the same ServerInfo/EndpointInfo objects,as they would in older versions. That sharing has caused many problems in the past due tosharing of properties, such as token caches, that are stored on those objects. The new behavioris more correct, but it is different from previous versions so care must be taken when upgrading.
The Karaf features.xml file for CXF 3.1 will no longer install spring or spring-dm when installingthe cxf feature. If you require spring/spring-dm, you will need to install those features prior toinstalling the CXF feature.
8.1.2. Security changes
The STS (Security Token Service) now issues tokens using the RSA-SHA256 signaturealgorithm by default, and the SHA-256 digest algorithm . Previously it used RSA-SHA1 andSHA-1 respectively.
Some security configuration tags have been renamed from ws-security.* to security.\*, as theyare now shared with some of the JAX-RS stack. The old tags will continue to work as beforehowever without any change. See the Security Configuration page for more information.
The SAML/XACML functionality previously available in the cxf-rt-security module is now in thecxf-rt-security-saml module. If you are explicitly specifying the SAML version in a SAMLCallbackHandler, then this is changed in CXF 3.1 due to the migration to use OpenSAML 3.1. Theversion is now set on the SAMLCallback using a org.apache.wss4j.common.saml.bean.Versionclass. Previously there was a dependency on OpenSAML’s SAMLVersion class.
It is now possible to plug in custom WS-SecurityPolicy validators if you wish to change thedefault validation logic for a particular policy.
8.1.3. New Features
The CXF JAX-WS code generator has a new option, seiSuper, that can be used to specifyadditional super interfaces for the SEI. This makes the code nonportable to other JAX-WScontainers. The primary use would be to add AutoCloseable to the interface to allow use of theclients in Java7 try with resource blocks.
New Metrics feature for collecting metrics about a CXF services. Codahale/DropWizard basedcollector included.
New Throttling feature for easily throttling CXF services. Sample included that uses the Metricscomponent to help make the throttling decisions.
New Logging feature for more advanced logging than the logging available in cxf-core
New Metadata service for SAML SSO to allow you to publish SAML SSO metadata for your
Red Hat Fuse 7.0 Migration Guide
24
New Metadata service for SAML SSO to allow you to publish SAML SSO metadata for yourservice provider.
The cxf frontend to the JAX-WS code generator, -fe cxf now generates code that is moreJava7-friendly as the return type of the getPort(… ) calls is a sub-interface of the SEI that alsoimplements AutoCloseable, BindingProvider, and Client. Code that used to look like:
(AddNumbersPortType port = service.getAddNumbersPort(); ((BindingProvider)port).getRequestContext() .put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, address); port.addNumbers3(-1, 2); ((Closeable)port).close();
can be replaced with:
try (AddNumbersPortTypeProxy port = service.getAddNumbersPort()) { port.getRequestContext().put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, address); port.addNumbers3(-1, 2); }
8.1.4. Major Dependency Changes
The Jetty based HTTP transport has been updated to support Jetty 9 as well as Jetty 8.However, support for Jetty 7 has been dropped.
Due to the Jetty upgrade, support for running Jetty based endpoints in Karaf 2.3.x has beendropped.
Support for using JAX-WS 2.1 based API jars has been removed. Java 7 (now required) includesJAX-WS 2.2 so this should not be an issue.
WSS4J 2.1 is included, which in turn includes OpenSAML 3.0.
CHAPTER 8. APACHE CXF ISSUES
25