SRU2024 v10

.gitignore

@@ -16,4 +16,6 @@ out
 pom.xml
 release.sh
 .idea/*
-*.pb
+*.pb
+.java-version
+.idea/sonarlint/

CHANGELOG.md

@@ -1,83 +1,86 @@
 # Prowide Core - CHANGELOG
 
-#### 9.5.3 - November 2024
+#### 10.2.3 - November 2024
   * (PW-2040) Updated the BBAN validation data file to the IBAN REGISTRY Jul 2024 release 
   * (PW-2006) Fixed `getMUR` and `setMUR` in `SwiftMessage` to prioritize field 108 in block 4 over block 3 for system messages (category 0)
   * Added new `MtSequenceEnum` with all the available inner sequences of specific MT schemas
   * Added `isSystemMessage()` to SwiftMessage to check if the message is a category 0 message (010. 011, etc...)
   * Added new `MtSequenceEnum` with all the available inner sequences of specific MT schemas
 
-#### 9.5.2 - October 2024
+#### 10.2.2 - October 2024
   * Added new `FieldEnum` with all the available field names
   * Code security improvements as per CodeQL recommendations
 
-#### 9.5.1 - June 2024
+#### 10.2.1 - June 2024
   * (PW-1913) Added IBAN validation for Egypt local account structure
   * Restore deprecated method in MT210 class
 
-#### 9.5.0 - May 2024
+#### 10.2.0 - May 2024
   * SWIFT Standard release update 2024 (live 16 November 2025)
   * Yearly revision of deprecation phase (see https://dev.prowidesoftware.com/SRU2024/getting-started/deprecation/)
-  * Dependency update: commons-lang3 -> 3.14.0'
-  * Dependency update: gson -> 2.11.0'
+  * Dependency update: commons-lang3 -> 3.14.0
+  * Dependency update: gson -> 2.11.0
 
-#### 9.4.16 - May 2024
+#### 10.1.15 - May 2024
   * (PW-1862) Added NarrativeFragment class for detailed line information in StructuredNarrative fragments
   * Fixed SwiftMessage getPDE(): return empty value instead of null when codeword exists and has no value
   * Added isPercentage() helper method to field 37K
 
-#### 9.4.15 - March 2024
+#### 10.1.14 - March 2024
   * (PW-1812) Updated the narrative resolver, format 2 (used in field 72 for example), to allow empty values as part of the narrative fragment
   * Updated validators for BIC, country, and currency constraints to utilize keywords for i18n-compatible messages
   * Deprecated unnecessary methods in the SafeXmlUtils class
 
-#### 9.4.14 - December 2023
+#### 10.1.13 - December 2023
   * (PW-1718) Changed the getComponentLabel(component) in Field59F to be dynamic based on the line identifiers (similar to existing API in Field50F)
 
-#### 9.4.13 - November 2023
+#### 10.1.12 - November 2023
   * (PW-1697) Fixed validation/parse pattern in field 29O
   * (PW-1697) MT306 changes in field 30I
   * Added DistinguishedName with Builder in order to encapsulate the BIC branch name logic 
 
-#### 9.4.12 - November 2023
+#### 10.1.11 - November 2023
   * (PW-1697) Fixed validation pattern in fields 14[H,K,L,M,N,O] and 29J
 
-#### 9.4.11 - November 2023
+#### 10.1.10 - November 2023
   * (PW-1695) Fixed a stack overflow in the fields fromJson implementation when a malformed JSON input contains empty field names
   * (PW-1688) Added missing field labels for SRU2023 changes in the pw_swift_*.properties file
 
-#### 9.4.10 - October 2023
+#### 10.1.9 - October 2023
   * (PW-1675) update to Field 31R to support also two date components as requested by SCORE messages
   * Added 36B and 36D getters to MT543
 
-#### 9.4.9 - October 2023
+#### 10.1.8 - October 2023
   * (PW-1659) Field 24G deprecated Name and Address for Narrative
 
-#### 9.4.8 - October 2023
+#### 10.1.7 - October 2023
   * Added default methods for sender, receiver, and identifier extraction to the MessageExtractionStrategy
   * Added JSON to the `FileFormat` enumeration
 
-#### 9.4.7 - September 2023
+#### 10.1.6 - September 2023
   * (PW-1478) Fixed Field 44J parse and getValue to enable proper data preservation when the field contains multiline content
 
-#### 9.4.6 - September 2023
+#### 10.1.5 - September 2023
   * Added support for an optional `pw-swift-core.properties` to customize the behavior of the SafeXmlUtils class
 
-#### 9.4.5 - August 2023
+#### 10.1.4 - September 2023
   * (PW-1478) Field 44J parse and getValue fix
 
-#### 9.4.4 - August 2023
+#### 10.1.3 - August 2023
   * (PW-1478) Field 44J format fixed to allow multiline
 
-#### 9.4.3 - July 2023
+#### 10.1.2 - August 2023
   * (PW-1461) Remove deprecation of field 31R model since is it used back in SRU2023
   * (PW-1405) Trim original String payload when creating an AbstractSwiftMessage
 
-#### 9.4.2 - June 2023
+#### 10.1.1 - July 2023
   * (GH-163) Remove unnecessary padding in sender and receiver in AbstractMT#creeate(number, sender, receiver) method
   * (PW-1323) Fixing getValue method for pattern issue in Field44J
 
-#### 9.4.1 - June 2023
+#### 10.1.0 - June 2023
+  * Migration to Java 11
+  * Migration to Jakarta EE 10
+  * (PW-1323) Fixing getValue method for pattern issue in Field44J
   * (PW-1323) Fixing missing pattern issue in Field44J
 
 #### 9.4.0 - May 2023

build.gradle

@@ -4,10 +4,10 @@ buildscript {
         gradlePluginPortal()
     }
     dependencies {
-        classpath 'ru.vyarus:gradle-quality-plugin:4.7.0'
-        classpath 'pl.allegro.tech.build:axion-release-plugin:1.14.2'
-        classpath 'io.github.gradle-nexus:publish-plugin:2.0.0'
-        classpath 'com.diffplug.spotless:spotless-plugin-gradle:6.13.0' // above this version requires Java 11
+        classpath 'ru.vyarus:gradle-quality-plugin:4.9.0'
+        classpath 'pl.allegro.tech.build:axion-release-plugin:1.15.1'
+        classpath 'io.github.gradle-nexus:publish-plugin:1.3.0'
+        classpath 'com.diffplug.spotless:spotless-plugin-gradle:6.23.3'
     }
 }
 apply plugin: 'pl.allegro.tech.build.axion-release'
@@ -40,7 +40,7 @@ tasks.withType(JavaCompile) {
     options.encoding = 'UTF-8'
     java {
         toolchain {
-            languageVersion.set(JavaLanguageVersion.of(8))
+            languageVersion.set(JavaLanguageVersion.of(11))
         }
     }
     doFirst {
@@ -56,20 +56,26 @@ dependencies {
     implementation 'org.apache.commons:commons-lang3:3.14.0'
     implementation 'com.google.code.gson:gson:2.11.0'
 
-    compileOnly 'javax.persistence:javax.persistence-api:2.2'
-    compileOnly 'javax.xml.bind:jaxb-api:2.3.1'
-    compileOnly 'javax.validation:validation-api:2.0.1.Final'
+    // jakarta is only used for annotations, we do not add it as implementation dependency on purpose to avoid forcing
+    // users to use jakarta jars in their project when they might not event be using JPA or JAXB at all
+    compileOnly 'jakarta.persistence:jakarta.persistence-api:3.1.0'
+    compileOnly 'jakarta.xml.bind:jakarta.xml.bind-api:4.0.0'
+    compileOnly 'jakarta.validation:jakarta.validation-api:3.0.2'
 
-    testImplementation 'javax.validation:validation-api:2.0.1.Final'
-    testImplementation 'javax.persistence:javax.persistence-api:2.2'
+    testImplementation 'jakarta.persistence:jakarta.persistence-api:3.1.0'
+    testImplementation 'jakarta.validation:jakarta.validation-api:3.1.0'
     testImplementation 'org.junit.jupiter:junit-jupiter:5.10.2'
     testImplementation 'org.assertj:assertj-core:3.25.3'
     testImplementation 'org.xmlunit:xmlunit-core:2.10.0'
     testImplementation 'org.xmlunit:xmlunit-matchers:2.9.0'
     testImplementation 'org.xmlunit:xmlunit-assertj:2.9.0'
 }
 
-sourceSets.main.java.srcDirs = ['src/main/java', 'src/generated/java']
+sourceSets.named('main') {
+    java {
+        setSrcDirs(['src/main/java', 'src/generated/java'])
+    }
+}
 
 test {
     useJUnitPlatform()
@@ -84,8 +90,8 @@ tasks.withType(Jar) {
         'Implementation-Version': project.version,
         'Implementation-Vendor': 'www.prowidesoftware.com',
         'Built-OS': System.getProperty('os.name'),
-        'Source-Compatibility': project.sourceCompatibility,
-        'Target-Compatibility': project.targetCompatibility,
+        'Source-Compatibility': JavaVersion.VERSION_11,
+        'Target-Compatibility': JavaVersion.VERSION_11,
         'Built-Date': new Date().format("yyyy-MM-dd"),
         'Automatic-Module-Name': 'com.prowidesoftware.core'
     )
@@ -260,7 +266,7 @@ tasks.register('bundle', Jar) {
     from ("$buildDir/libs") {
         include '*.asc'
     }
-    archiveName 'bundle.jar'
+    archiveFileName.set('bundle.jar')
 }
 
 tasks.withType(Test) {
@@ -283,9 +289,15 @@ task('testOn17', type: Test) {
 
 jacocoTestReport {
     reports {
-        xml.enabled true
-        csv.enabled false
-        html.enabled false
+        xml {
+            required.set(true)
+        }
+        csv {
+            required.set(false)
+        }
+        html {
+            required.set(false)
+        }
     }
 
     // exclude generated code

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.4-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
 networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

src/main/java/com/prowidesoftware/swift/constraints/BicConstraint.java

@@ -17,12 +17,12 @@
 
 import static java.lang.annotation.ElementType.*;
 
+import jakarta.validation.Constraint;
+import jakarta.validation.Payload;
 import java.lang.annotation.Documented;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
-import javax.validation.Constraint;
-import javax.validation.Payload;
 
 /**
  * Bean validation for BIC numbers.

src/main/java/com/prowidesoftware/swift/constraints/BicValidator.java

@@ -17,8 +17,8 @@
 
 import com.prowidesoftware.swift.model.BIC;
 import com.prowidesoftware.swift.model.BicValidationResult;
-import javax.validation.ConstraintValidator;
-import javax.validation.ConstraintValidatorContext;
+import jakarta.validation.ConstraintValidator;
+import jakarta.validation.ConstraintValidatorContext;
 import org.apache.commons.lang3.StringUtils;
 
 /**

src/main/java/com/prowidesoftware/swift/constraints/CountryConstraint.java

@@ -17,12 +17,12 @@
 
 import static java.lang.annotation.ElementType.*;
 
+import jakarta.validation.Constraint;
+import jakarta.validation.Payload;
 import java.lang.annotation.Documented;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
-import javax.validation.Constraint;
-import javax.validation.Payload;
 
 /**
  * Bean validation for ISO Alpha-2 country codes.

src/main/java/com/prowidesoftware/swift/constraints/CountryValidator.java

@@ -16,8 +16,8 @@
 package com.prowidesoftware.swift.constraints;
 
 import com.prowidesoftware.swift.utils.IsoUtils;
-import javax.validation.ConstraintValidator;
-import javax.validation.ConstraintValidatorContext;
+import jakarta.validation.ConstraintValidator;
+import jakarta.validation.ConstraintValidatorContext;
 import org.apache.commons.lang3.StringUtils;
 
 /**

src/main/java/com/prowidesoftware/swift/constraints/CurrencyConstraint.java

@@ -17,12 +17,12 @@
 
 import static java.lang.annotation.ElementType.*;
 
+import jakarta.validation.Constraint;
+import jakarta.validation.Payload;
 import java.lang.annotation.Documented;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
-import javax.validation.Constraint;
-import javax.validation.Payload;
 
 /**
  * Bean validation for ISO currency codes.

src/main/java/com/prowidesoftware/swift/constraints/CurrencyValidator.java

@@ -16,8 +16,8 @@
 package com.prowidesoftware.swift.constraints;
 
 import com.prowidesoftware.swift.utils.IsoUtils;
-import javax.validation.ConstraintValidator;
-import javax.validation.ConstraintValidatorContext;
+import jakarta.validation.ConstraintValidator;
+import jakarta.validation.ConstraintValidatorContext;
 import org.apache.commons.lang3.StringUtils;
 
 /**

src/main/java/com/prowidesoftware/swift/constraints/IbanConstraint.java

@@ -17,12 +17,12 @@
 
 import static java.lang.annotation.ElementType.*;
 
+import jakarta.validation.Constraint;
+import jakarta.validation.Payload;
 import java.lang.annotation.Documented;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
-import javax.validation.Constraint;
-import javax.validation.Payload;
 
 /**
  * Bean validation for IBAN numbers.

src/main/java/com/prowidesoftware/swift/constraints/IbanValidator.java

@@ -17,8 +17,8 @@
 
 import com.prowidesoftware.swift.model.IBAN;
 import com.prowidesoftware.swift.model.IbanValidationResult;
-import javax.validation.ConstraintValidator;
-import javax.validation.ConstraintValidatorContext;
+import jakarta.validation.ConstraintValidator;
+import jakarta.validation.ConstraintValidatorContext;
 import org.apache.commons.lang3.StringUtils;
 
 /**

src/main/java/com/prowidesoftware/swift/model/AbstractSwiftMessage.java

@@ -19,15 +19,15 @@
 import com.google.gson.GsonBuilder;
 import com.prowidesoftware.JsonSerializable;
 import com.prowidesoftware.swift.utils.Lib;
+import jakarta.persistence.*;
+import jakarta.xml.bind.annotation.XmlTransient;
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.Serializable;
 import java.math.BigDecimal;
 import java.text.NumberFormat;
 import java.util.*;
-import javax.persistence.*;
-import javax.xml.bind.annotation.XmlTransient;
 import org.apache.commons.lang3.ArrayUtils;
 import org.apache.commons.lang3.StringUtils;
 

src/main/java/com/prowidesoftware/swift/model/MtSwiftMessage.java

@@ -21,16 +21,16 @@
 import com.prowidesoftware.swift.model.mt.AbstractMT;
 import com.prowidesoftware.swift.model.mt.DefaultMtMetadataStrategy;
 import com.prowidesoftware.swift.model.mt.MTVariant;
+import jakarta.persistence.Column;
+import jakarta.persistence.DiscriminatorValue;
+import jakarta.persistence.Entity;
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.Calendar;
 import java.util.Objects;
 import java.util.Optional;
 import java.util.logging.Level;
-import javax.persistence.Column;
-import javax.persistence.DiscriminatorValue;
-import javax.persistence.Entity;
 import org.apache.commons.lang3.EnumUtils;
 import org.apache.commons.lang3.StringUtils;
 

src/main/java/com/prowidesoftware/swift/model/SwiftMessageNote.java

@@ -15,8 +15,8 @@
  */
 package com.prowidesoftware.swift.model;
 
+import jakarta.persistence.*;
 import java.util.Calendar;
-import javax.persistence.*;
 
 /**
  * Comments associated to a message for application only usage (not part of the standard).

src/main/java/com/prowidesoftware/swift/model/SwiftMessageRevision.java

@@ -15,11 +15,11 @@
  */
 package com.prowidesoftware.swift.model;
 
-import static javax.persistence.FetchType.LAZY;
+import static jakarta.persistence.FetchType.LAZY;
 
+import jakarta.persistence.*;
 import java.util.Calendar;
 import java.util.Objects;
-import javax.persistence.*;
 
 /**
  * A revision is a snapshot of message content and is used to track the history of changes in a message.