chore: migrate hbm.xml to orm.xml

[vietnguyen]

• As hibernate legacy hbm.xml mapping has been deprecated for 6.x. We have options to use annotation or jpa orm.xml mapping. After discussed, we decided to use the JPA orm.xml mapping as it helps to avoid modifying all the Java Object Model classes and the object hierarchy.

• This PR transforms all hibernate hbm.xml files to JPA orm.xml files which is based on JPA xsd schema http://xmlns.jcp.org/xml/ns/persistence/orm version = 2.2. It also adds JPA configuration for supporting this type of mapping.

• This is the final preparation step for upgrading to Hibernate 6.x

Changes note

• In MessageConversation.hbm.xml we use below filter supported by hibernate and its not supported in JPA. So I replaced it with a where clause in the affected query in HibernateMessageConversationStore.

 <filter-def name="userMessageUser">
    <filter-param name="userid" type="long" />
  </filter-def>

Mapping refactor samples

Many-to-many

hbm.xml

 <set name="userMessages" table="messageconversation_usermessages" cascade="all,delete-orphan">
      <key column="messageconversationid"
           foreign-key="fk_messageconversation_usermessages_messageconversationid" />
      <many-to-many class="org.hisp.dhis.message.UserMessage" column="usermessageid"
                    unique="true" foreign-key="fk_messageconversation_usermessages_usermessageid">
        <filter name="userMessageUser" condition="userid = :userid" />
      </many-to-many>
    </set>

orm.xml

<many-to-many name="userMessages" target-entity="org.hisp.dhis.message.UserMessage">
      <join-table name="messageconversation_usermessages">
          <join-column name="messageconversationid"/>
          <foreign-key name="fk_messageconversation_usermessages_messageconversationid"/> 
          <inverse-join-column name="usermessageid"/>
      </join-table>
      <cascade><cascade-all/></cascade>
  </many-to-many>

Todo

• [WIP] Replace Hibernate UserType by JPA AttributeConverter which is used for mapping JsonB column.
• Fix many-to-many mapping which is not supported by the hbm-to-orm transformation tool.
• Fix Hibernate <component> mapping which is not supported by JPA orm mapping.
• Test new mapping files with Hibernate 6.

Notes

	Hibernate	JPA
ID generator strategy, currently need to support PostgreSQL and H2	<generator class="native" />	<generated-value strategy="AUTO"/>
Fetch mode	fetch=[select, subselect, join, batch]	Doesn't have equivalent, default is LEFT JOIN unless overrided by JPQL or Native query.
Collection loading mode	lazy=false	fetch=EAGER The default fetch-type are: - ManyToOne: EAGER - OneToMany: LAZY - ManyToMany: LAZY - OneToOne: EAGER

[sonarcloud]

Quality Gate failed

Failed conditions
5 New issues
5 New Code Smells (required ≤ 0)
1 New Critical Issues (required ≤ 0)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint