TRUNK-6533: Replace deprecated Hibernate Criteria with JPA Criteria #5731

kmvipin · 2026-02-02T18:19:39Z

TRUNK-6533: Replace deprecated Hibernate Criteria with JPA Criteria

Description of what I changed

Removed all usage of deprecated session.createCriteria()
Converted to CriteriaBuilder / CriteriaQuery / Root / Predicate pattern
Maintained identical query semantics and results
Eliminated deprecation warnings during compilation (-Xlint:deprecation)
Prepared codebase for future Hibernate 6 / 7 upgrade
No functional changes; unit/integration tests pass unchanged

Issue I worked on

see https://issues.openmrs.org/browse/TRUNK-6533

Checklist: I completed these to help reviewers :)

My IDE is configured to follow the code style of this project.
I have added tests to cover my changes. (If you refactored
existing code that was well tested you do not have to add tests)
I ran mvn clean package right before creating this pull request and
added all formatting changes to my commit.
All new and existing tests passed.
My pull request is based on the latest changes of the master branch.

kmvipin · 2026-02-03T03:27:50Z

@dkayiwa , can you please review!

api/src/main/java/org/openmrs/api/db/ConceptDAO.java

kmvipin · 2026-02-03T16:20:43Z

@dkayiwa, can you please review if all good!

dkayiwa · 2026-02-03T21:05:44Z

I find it easier to review smaller pull requests. Can you limit the changes to strictly only switching from hibernate criteria to JPA? You can always open new pull requests for further improvements.

kmvipin · 2026-02-04T10:42:08Z

I find it easier to review smaller pull requests. Can you limit the changes to strictly only switching from hibernate criteria to JPA? You can always open new pull requests for further improvements.

@dkayiwa, can you please review now as I have mention only PR specific changes!

dkayiwa · 2026-02-04T10:46:54Z

api/src/test/java/org/openmrs/api/impl/ConceptServiceImplTest.java

 	 */
 	@Test
 	public void saveConceptClass_shouldSaveTheGivenConceptClass() {
-		int unusedConceptClassId = 123;


Do you mind explaining how this is related to the ticket?

@dkayiwa, It is using the id which is not even present in the database, which causes row deleted or updated exception!

Why was the exception not happening before your changes?

previously saveOrUpdate method is used for both save and update, here if id is not present in db then it will recreate the row with new Id.

Now we are using persist() for save and merge for update. If the Id is given for an object it will go for merge and try to fetch corresponding row with the given Id which cause this error!

dkayiwa · 2026-02-04T14:02:29Z

api/src/main/java/org/openmrs/api/db/hibernate/HibernateConceptDAO.java

-
-		String hql = "";
+
+		StringBuilder hql = new StringBuilder();


Is this also related to the ticket?

with String, it does not pass security checks of sonar.

That is exactly what i mean by using separate pull requests to improve the existing code. I am just trying to reduce the cognitive load when doing these reviews. Can you take a second look at this? https://opensource.com/article/18/6/anatomy-perfect-pull-request

That is exactly what i mean by using separate pull requests to improve the existing code. I am just trying to reduce the cognitive load when doing these reviews. Can you take a second look at this? https://opensource.com/article/18/6/anatomy-perfect-pull-request

I will replace this section with the required once!

kmvipin · 2026-02-04T15:05:31Z

api/src/main/java/org/openmrs/api/db/hibernate/HibernateConceptDAO.java

 	@Override
 	public ConceptReferenceRange saveConceptReferenceRange(ConceptReferenceRange conceptReferenceRange) {
-		sessionFactory.getCurrentSession().saveOrUpdate(conceptReferenceRange);
+		if(conceptReferenceRange == null)


This change is intentional to fail fast by explicitly checking the ID and throwing a clear exception, instead of relying on saveOrUpdate() to throw an internal IllegalArgumentException for null values.

kmvipin · 2026-02-04T15:10:47Z

@dkayiwa, can you review if all okay?

dkayiwa · 2026-02-04T17:17:29Z

api/src/main/java/org/openmrs/api/db/hibernate/JpaUtils.java

 	 * @return the single result or null if no result is found
 	 * @throws NonUniqueResultException if more than one result is found
 	 */
+	@Deprecated


https://openmrs.atlassian.net/wiki/spaces/docs/pages/25477044/Java+Conventions#Deprecation

@dkayiwa, as per the deprecation documentation, internal DAO methods are not subject to deprecation. Since this is an internal utility, I’ve removed the annotation.

dkayiwa · 2026-02-04T19:08:12Z

api/src/main/java/org/openmrs/api/db/hibernate/HibernateConceptDAO.java

 	public ConceptClass saveConceptClass(ConceptClass cc) throws DAOException {
-		sessionFactory.getCurrentSession().saveOrUpdate(cc);
+		Session session = sessionFactory.getCurrentSession();
+		if(cc.getId() != null)


https://openmrs.atlassian.net/wiki/spaces/docs/pages/25477044/Java+Conventions#Code-Style

@dkayiwa, reimplemented as per the project’s code style.

dkayiwa · 2026-02-05T10:16:34Z

api/src/main/java/org/openmrs/api/db/hibernate/HibernateConceptDAO.java

 	public ConceptClass saveConceptClass(ConceptClass cc) throws DAOException {
-		sessionFactory.getCurrentSession().saveOrUpdate(cc);
+		Session session = sessionFactory.getCurrentSession();
+		if(cc.getId() != null) {


We put space after if as you can see here: https://openmrs.atlassian.net/wiki/spaces/docs/pages/25477044/Java+Conventions#Code-Style

@dkayiwa, I have fixed the changes!

dkayiwa · 2026-02-05T11:43:36Z

api/src/main/java/org/openmrs/api/db/hibernate/HibernateConceptDAO.java

 	public ConceptClass saveConceptClass(ConceptClass cc) throws DAOException {
-		sessionFactory.getCurrentSession().saveOrUpdate(cc);
+		Session session = sessionFactory.getCurrentSession();
+		if (cc.getId() != null) {


This logic is sprinkled in lots of other places. Doesn't it call for creating a utility method?

@dkayiwa, can you please review this change!

dkayiwa · 2026-02-05T12:31:41Z

api/src/main/java/org/openmrs/api/db/hibernate/HibernateConceptDAO.java

-		sessionFactory.getCurrentSession().saveOrUpdate(cc);
-		return cc;
+		Session session = sessionFactory.getCurrentSession();
+		return JpaUtils.saveOrUpdate(session,cc);


We recommend putting a space after the comms.

dkayiwa · 2026-02-05T13:12:43Z

api/src/main/java/org/openmrs/api/db/hibernate/HibernateConceptDAO.java

 	public ConceptDatatype saveConceptDatatype(ConceptDatatype cd) throws DAOException {
-		sessionFactory.getCurrentSession().saveOrUpdate(cd);
-		return cd;
+		Session session = sessionFactory.getCurrentSession();


Can we get rid of the session variable?

dkayiwa · 2026-02-05T13:57:11Z

api/src/main/java/org/openmrs/api/db/hibernate/HibernateConceptDAO.java

 	public ConceptReferenceRange saveConceptReferenceRange(ConceptReferenceRange conceptReferenceRange) {
-		sessionFactory.getCurrentSession().saveOrUpdate(conceptReferenceRange);
-		return conceptReferenceRange;
+		if (conceptReferenceRange == null) {


Is this part of the ticket?

@dkayiwa, There is a test case that verifies this method throws an IllegalArgumentException when null is passed. Previously, saveOrUpdate would throw this exception through its internal logic, but now we need to add an explicit null check first so the expected exception is thrown before proceeding.

dkayiwa · 2026-02-05T14:22:49Z

api/src/main/java/org/openmrs/api/db/hibernate/JpaUtils.java

+	 * @return the saved or updated entity
+	 */
+	public static <T extends BaseOpenmrsObject> T saveOrUpdate(Session session, T entity) {
+		if (entity.getId() != null) {


Shouldn't this also use the utility method?

Sure, I will add null check in this utility method!

kmvipin · 2026-02-05T15:25:18Z

@dkayiwa, can you review if all good!

dkayiwa · 2026-02-05T21:46:44Z

api/src/main/java/org/openmrs/api/db/hibernate/HibernateConceptDAO.java

-			Query query = sessionFactory.getCurrentSession().createQuery("from ConceptNumeric where conceptId = :conceptId")
-			        .setParameter("conceptId", i);
-			obj = JpaUtils.getSingleResultOrNull(query);
+			TypedQuery<ConceptNumeric> sql = sessionFactory.getCurrentSession()


Is this sql or query? In other words, is there a reason why you changed the variable name?

The variable name change was unintentional and happened while making multiple changes. I’ll revert it to keep the naming consistent.

…n HibernateConceptDAO

kmvipin · 2026-02-06T13:26:36Z

@dkayiwa, can you please review!

sonarqubecloud · 2026-02-06T17:23:09Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
1.0% Duplication on New Code

See analysis details on SonarQube Cloud

kmvipin · 2026-02-07T11:50:19Z

@dkayiwa @ibacher requested for review, please let me know if there is any further change!

kmvipin marked this pull request as draft February 2, 2026 18:26

kmvipin marked this pull request as ready for review February 2, 2026 18:58

dkayiwa reviewed Feb 3, 2026

View reviewed changes

api/src/main/java/org/openmrs/api/db/ConceptDAO.java Show resolved Hide resolved

kmvipin requested a review from dkayiwa February 3, 2026 15:13

dkayiwa reviewed Feb 4, 2026

View reviewed changes

kmvipin requested a review from dkayiwa February 4, 2026 10:54

dkayiwa reviewed Feb 4, 2026

View reviewed changes

kmvipin commented Feb 4, 2026

View reviewed changes

kmvipin requested a review from dkayiwa February 4, 2026 15:10

dkayiwa reviewed Feb 4, 2026

View reviewed changes

kmvipin requested a review from dkayiwa February 4, 2026 18:07

dkayiwa reviewed Feb 4, 2026

View reviewed changes

kmvipin requested a review from dkayiwa February 5, 2026 08:50

dkayiwa reviewed Feb 5, 2026

View reviewed changes

kmvipin force-pushed the TRUNK-6533 branch 2 times, most recently from 8e431ff to f8405fb Compare February 5, 2026 11:01

kmvipin requested a review from dkayiwa February 5, 2026 11:18

dkayiwa reviewed Feb 5, 2026

View reviewed changes

kmvipin force-pushed the TRUNK-6533 branch from 60eda70 to 9e7a28f Compare February 5, 2026 12:47

kmvipin requested a review from dkayiwa February 5, 2026 12:48

dkayiwa reviewed Feb 5, 2026

View reviewed changes

kmvipin force-pushed the TRUNK-6533 branch from 9e7a28f to 4cfabbc Compare February 5, 2026 13:36

kmvipin requested a review from dkayiwa February 5, 2026 13:39

dkayiwa reviewed Feb 5, 2026

View reviewed changes

kmvipin force-pushed the TRUNK-6533 branch from 001f9ac to 85cc590 Compare February 5, 2026 14:31

kmvipin requested a review from dkayiwa February 5, 2026 14:36

dkayiwa reviewed Feb 5, 2026

View reviewed changes

kmvipin added 3 commits February 6, 2026 12:17

TRUNK-6533: Replace deprecated Hibernate Criteria with JPA Criteria i…

1524b56

…n HibernateConceptDAO

resolve review comment

a0618e5

resolve review comment

317e88a

kmvipin force-pushed the TRUNK-6533 branch from 2f43a2f to 317e88a Compare February 6, 2026 06:48

kmvipin requested a review from dkayiwa February 6, 2026 07:27

Merge branch 'master' into TRUNK-6533

4bff22c

Merge branch 'master' into TRUNK-6533

06de99d

kmvipin closed this Feb 10, 2026

TRUNK-6533: Replace deprecated Hibernate Criteria with JPA Criteria #5731

TRUNK-6533: Replace deprecated Hibernate Criteria with JPA Criteria #5731

Conversation

kmvipin commented Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of what I changed

Issue I worked on

Checklist: I completed these to help reviewers :)

Uh oh!

kmvipin commented Feb 3, 2026

Uh oh!

Uh oh!

kmvipin commented Feb 3, 2026

Uh oh!

dkayiwa commented Feb 3, 2026

Uh oh!

kmvipin commented Feb 4, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kmvipin Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kmvipin commented Feb 4, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kmvipin Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kmvipin commented Feb 5, 2026

Uh oh!

dkayiwa Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kmvipin commented Feb 2, 2026 •

edited

Loading

kmvipin Feb 4, 2026 •

edited

Loading

kmvipin Feb 4, 2026 •

edited

Loading

dkayiwa Feb 5, 2026 •

edited

Loading

kmvipin commented Feb 7, 2026 •

edited

Loading