Dependency Changes

• IM library dependency version 1.2.0
• Spring boot version 2.2.7
• Camel version 3.2.0

1. Camel Upgrade – Update Codebase

A new major version of Camel is used which resulted in major changes. 

Read Camel Migration Guides

Below are listed the official changes in Camel. Go through them and alter your code accordingly. 

• https://camel.apache.org/manual/latest/camel-3-migration-guide.html
• https://camel.apache.org/manual/latest/camel-3x-upgrade-guide.html

Codebase Changelist

 We strongly recommend to check your code against official guidelines and test changes properly before going live.

This changelist comes from our codebase changes:

Other changes:

• Source: The simple language uses ${body} placeholders for complex expressions or functions. (https://camel.apache.org/components/latest/languages/simple-language.html)
• References to custom components must be prefixed.
  
  • All Bean methods (pfx:dsLoad, pfx:dsIntegrate, …) must be referenced as bean:xxx
  • All routes must be referenced as direct:xxx
  • Mocks are prefixed with mock:xxx
  • JdbcComponent are referrenced as jdbc:xxx
  • SqlComponent are referrenced as sql:xxx

  • Example of a Bean reference:

    Before

    <pfx:dsLoad id="loadProduct" objectType="P" businessKeys="sku" mapper="dynamicPartitionMapper" />
    
    <camelContext xmlns="http://camel.apache.org/schema/spring" id="camelContext">
    
    <route>
    	<from uri="direct://load-A"/>
    	<setHeader headerName="loadDataMapperPfx">
    		<groovy>exchange.context.registry.lookupByName("dynamicProductMapper-variantA")</groovy>
    	</setHeader>
    	<to uri="loadProduct"/>
    	<to uri="mock:response-load"/>
    </route>
    
    </camelContext>

    After

    <pfx:dsLoad id="test://loadProduct" objectType="P" businessKeys="sku" mapper="dynamicPartitionMapper" />
    
    <camelContext xmlns="http://camel.apache.org/schema/spring" id="camelContext">
    
    <route>
    	<from uri="direct://load-A"/>
    	<setHeader name="loadDataMapperPfx">
    		<groovy>exchange.context.registry.lookupByName("dynamicProductMapper-variantA")</groovy>
    	</setHeader>
    	<to uri="bean:loadProduct"/>
    	<to uri="mock:response-load"/>
    </route>
    
    </camelContext>

2. Use Maven Archetype for New Projects

There is a Maven archetype created. It is recommended to use this archetype for further development, as the archetype follows best practices, already has the basic configuration and will be regularly updated by Pricefx team.

 You should also check your current code against the archetype.

Archetype documentation: Create Project from Maven Archetype

3. Connection Encryption

Connection passwords and clientSecrets will from now on be stored encrypted. Encryption password is managed by the integration.connections.encryption-password property. Encrypted fields are easily recognized by the {ENC} prefix. There is also an option to auto-encrypt current unencrypted properties by setting the integration.connections.auto-encrypt property to true.

All currently unencrypted connections will from now on appear in the logger with the WARN level.

 If an encrypted connection cannot be read (e.g. changed encryption password), the connection cannot be used.

4. Component Changes

5. IM Versioning

From now on, we switched to a more common versioning of IM. For more details see /wiki/spaces/INTG/pages/1492975782 (access for Pricefx only). 

6. Groovy Sandbox Changes

We were forced to narrow the scope of what Groovy sandbox can perform. If you used java.lang.System or java.lang.Class in your Groovy class, you are no longer able to do that. Please go through the updated documentation for more information how to handle it. You may also have to define whitelisted classes from PlatformManager.

7. Properties Changes

From now on, you should use only properties prefixed with integration.* when changing IM behavior. See the archetype documentation for required properties.

8. Secrets Stored Outside Application JAR

By default, the secrets (logstash and kafka connections, default passwords)  are now stored in Config Server. For more details read the /wiki/spaces/INTG/pages/2513666473 specification (Pricefx employees only) and Use ConfigServer for Passwords Management (Optional).

9. Properties checks

There is a property check running on the startup now. It will log all resolved properties so you might check possible duplicates, problems etc.

10. Route error handling  - enableSendingMail vs enable-sending-mail

There is now a property check that checks wrong setup of property enable-sending-mail, which syntax wasn't supported. Please, use enableSendingMail. Mailing configuration now support both formats but the enable-sending-mail is deprecated.

11. Logging File Change

There is a new default location for logs - logs/main.log (instead of main.log). Your options:

• If possible, ask someone to use salt deploy_im_standard_im_1_2_and_newer.
• If not possible and you want the same behavior (to store into the root folder):
  Put -Dlogging.file.name=main.log into JAVA_OPTS and integration.logging.file=main.log into application.properties.
• If the new location suits you, create a folder logs in the root folder.