Upgrading from 4.0.x to 4.0.5

Java pro-code uses several functionalities provided by the dependency "cp-framework-sdk", which has been updated to include new fixes, and versions of underlying used dependencies.

All existing Java pro-code projects have to download this new version and migrate to this new version.

Java low-code uses several functionalities provided by the dependency "cp-framework-sdk", which has been updated to include new fixes, and versions of underlying used dependencies.

All existing Java low-code are required to migrate to this new version.

1. Open your project in your IDE

2. Navigate to the pom.xml

3. Add the dependencies apicurio-registry-serdes-jsonschema-serde which handles the integration with the schema registry, and json-schema-validator which does the json schema validation

   <dependency>
     <groupId>io.apicurio</groupId>
     <artifactId>apicurio-registry-serdes-jsonschema-serde</artifactId>
     <version>2.4.1.Final</version>
     <exclusions>
       <exclusion>
         <artifactId>slf4j-jboss-logmanager</artifactId>
         <groupId>org.jboss.slf4j</groupId>
       </exclusion>
     </exclusions>
   </dependency>
   
   <dependency>
     <groupId>com.networknt</groupId>
     <artifactId>json-schema-validator</artifactId>
     <version>1.0.77</version>
   </dependency>

4. Add generated-resources to build in your pom.xml so resources inside build should look like:

    <resources>
     <resource>
       <directory>src/main/filtered</directory>
       <filtering>true</filtering>
     </resource>
     <resource>
       <directory>src/main/resources</directory>
       <filtering>false</filtering>
     </resource>
     <resource>
       <directory>src/main/generated-resources</directory>
       <filtering>false</filtering>
     </resource>
    </resources>

5. Add the jsonschema2pojo plugin to your pom.xml. Please replace yourPackageName and yourProjectAcronym according to your project meta data:

     <plugin>
       <groupId>org.jsonschema2pojo</groupId>
       <artifactId>jsonschema2pojo-maven-plugin</artifactId>
       <version>1.1.2</version>
       <configuration>
         <sourceDirectory>${basedir}/src/main/generated-resources/schemas</sourceDirectory>
         <targetPackage>yourPackageName.yourProjectAcronym.sdk.domain.schemas</targetPackage>
         <outputDirectory>${basedir}/src/main/generated</outputDirectory>
       </configuration>
       <executions>
         <execution>
           <goals>
             <goal>generate</goal>
           </goals>
         </execution>
       </executions>
     </plugin>

   Note:

After adding the plugin to your pom.xml you have to trigger the code generation using the new plugin. Please execute k5 pull for this or push your changes and clone the project again.

1. For local development using schema registry, please refer to Setup Java local profile
2. Push the changes and run the pipeline to ensure that the project deploys successfully

1. Open the Schema page in the Solution Designer
2. Create a new schema containing all the properties needed for the event

1. Create a new event for your the use case you want to migrate
2. Choose a new topic for it (one topic per event is suggested and recommended)
3. Add your schema as payload of the event
4. Keep the old event to still support the old behavior
5. Commit and push changes in Solution Designer
6. Clone/Pull your project
7. Implement new publishing logic
8. Deploy/Release your service by triggering a pipeline

After these steps, your service will now publish the old and the new event.

Adjust existing event:

1. Remove the entity payload from the event
2. Adjust topic binding of the event to use the same one as in the consuming service
3. Select the new schema as payload for the event
4. Commit and push changes in Solution Designer
5. Clone/Pull your project
6. Adjust agent implementation to deal with the new event payload
7. Deploy/Release your service by triggering a pipeline

Create a new event:

1. Create a new event using the same topic binding as in the consuming service
2. Select the new schema as payload for the event
3. Create a new agent using the event as trigger event
4. Delete old event
5. Commit and push changes in Solution Designer
6. Clone/Pull your project
7. Implement agent implementation of the new agent
8. Cleanup agent implementation of the old agent
9. Deploy/Release your service by triggering a pipeline

After these steps, your service will now use the new event and no longer the old event.

After you ensured, that all consuming services use the new event, you can delete the old event and deploy your service again.