lingwei.kong/hawkbit
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Unify Hibernate and EclipseLink exception translations (#2388)

Browse Source 
* Unify Hibernate and EclipseLink exception translations

Signed-off-by: strailov <Stanislav.Trailov@bosch.io>

* properly set custom hibernate jpa dialect

Signed-off-by: strailov <Stanislav.Trailov@bosch.io>

---------

Signed-off-by: strailov <Stanislav.Trailov@bosch.io>
This commit is contained in:
Stanislav Trailov
2025-05-07 15:18:06 +03:00
committed by GitHub
parent af19861de7
commit 7456e52095
3 changed files with 113 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
hawkbit-repository/hawkbit-repository-jpa-api/src/main/java/org/eclipse/hawkbit/repository/jpa/utils/JpaExceptionTranslator.java Normal file
View File

@@ -0,0 +1,50 @@
/**
* Copyright (c) 2025 Contributors to the Eclipse Foundation
*
* This program and the accompanying materials are made
* available under the terms of the Eclipse Public License 2.0
* which is available at https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.hawkbit.repository.jpa.utils;
import org.springframework.jdbc.support.SQLErrorCodeSQLExceptionTranslator;
import org.springframework.jdbc.support.SQLErrorCodes;
import org.springframework.jdbc.support.SQLExceptionTranslator;
import org.springframework.jdbc.support.SQLStateSQLExceptionTranslator;
/**
* A single point of exception translators in hawkBit
* in order to be used in Hibernate and EclipseLink implementation
* and unify jpa exception translations behaviour in the project
*/
public class JpaExceptionTranslator {
private static final SQLErrorCodeSQLExceptionTranslator SQL_EXCEPTION_TRANSLATOR;
// providing list/set of codes which are not handled from the sql translator properly
private static final String[] DATA_INTEGRITY_VIOLATION_CODES = new String[] {
"1366"
};
private static final String[] DUPLICATE_KEY_VIOLATION_CODES = new String[] {
"1062"
};
static {
SQL_EXCEPTION_TRANSLATOR = new SQLErrorCodeSQLExceptionTranslator();
SQLErrorCodes codes = new SQLErrorCodes();
codes.setDataIntegrityViolationCodes(DATA_INTEGRITY_VIOLATION_CODES);
codes.setDuplicateKeyCodes(DUPLICATE_KEY_VIOLATION_CODES);
SQL_EXCEPTION_TRANSLATOR.setSqlErrorCodes(codes);
// explicitly set old translator as a fallback (uses Subclass translator by default)
SQL_EXCEPTION_TRANSLATOR.setFallbackTranslator(new SQLStateSQLExceptionTranslator());
}
private JpaExceptionTranslator() {}
public static SQLExceptionTranslator getTranslator() {
return SQL_EXCEPTION_TRANSLATOR;
}
}

22
hawkbit-repository/hawkbit-repository-jpa-eclipselink/src/main/java/org/eclipse/hawkbit/repository/jpa/HawkbitEclipseLinkJpaDialect.java
View File

@@ -14,9 +14,8 @@ import java.sql.SQLException;
import jakarta.persistence.PersistenceException;
import org.eclipse.hawkbit.repository.jpa.utils.JpaExceptionTranslator;
import org.springframework.dao.DataAccessException;
import org.springframework.jdbc.support.SQLErrorCodeSQLExceptionTranslator;
import org.springframework.jdbc.support.SQLErrorCodes;
import org.springframework.jdbc.support.SQLStateSQLExceptionTranslator;
import org.springframework.lang.NonNull;
import org.springframework.orm.jpa.JpaSystemException;
@@ -56,23 +55,6 @@ class HawkbitEclipseLinkJpaDialect extends EclipseLinkJpaDialect {
@Serial
private static final long serialVersionUID = 1L;
private static final SQLErrorCodeSQLExceptionTranslator SQL_EXCEPTION_TRANSLATOR;
// providing list/set of codes which are not handled from the sql translator properly
private static final String[] DATA_INTEGRITY_VIOLATION_CODES = new String[] {
"1366"
};
static {
SQL_EXCEPTION_TRANSLATOR = new SQLErrorCodeSQLExceptionTranslator();
SQLErrorCodes codes = new SQLErrorCodes();
codes.setDataIntegrityViolationCodes(DATA_INTEGRITY_VIOLATION_CODES);
SQL_EXCEPTION_TRANSLATOR.setSqlErrorCodes(codes);
// explicitly set old translator as a fallback (uses Subclass translator by default)
SQL_EXCEPTION_TRANSLATOR.setFallbackTranslator(new SQLStateSQLExceptionTranslator());
}
@Override
public DataAccessException translateExceptionIfPossible(@NonNull final RuntimeException ex) {
final DataAccessException dataAccessException = super.translateExceptionIfPossible(ex);
@@ -102,7 +84,7 @@ class HawkbitEclipseLinkJpaDialect extends EclipseLinkJpaDialect {
return null;
}
return SQL_EXCEPTION_TRANSLATOR.translate("", null, sqlException);
return JpaExceptionTranslator.getTranslator().translate("", null, sqlException);
}
private static SQLException findSqlException(final RuntimeException jpaSystemException) {

49
hawkbit-repository/hawkbit-repository-jpa-hibernate/src/main/java/org/eclipse/hawkbit/repository/jpa/JpaConfiguration.java
View File

@@ -10,9 +10,12 @@
package org.eclipse.hawkbit.repository.jpa;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import org.eclipse.hawkbit.repository.jpa.model.EntityPropertyChangeListener;
import org.eclipse.hawkbit.repository.jpa.utils.JpaExceptionTranslator;
import org.eclipse.hawkbit.tenancy.TenantAware;
import org.hibernate.boot.Metadata;
import org.hibernate.boot.spi.BootstrapContext;
@@ -24,23 +27,33 @@ import org.hibernate.event.spi.EventType;
import org.hibernate.integrator.spi.Integrator;
import org.hibernate.jpa.boot.spi.IntegratorProvider;
import org.hibernate.service.spi.SessionFactoryServiceRegistry;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.orm.jpa.HibernatePropertiesCustomizer;
import org.springframework.boot.autoconfigure.orm.jpa.JpaBaseConfiguration;
import org.springframework.boot.autoconfigure.orm.jpa.JpaProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.orm.jpa.vendor.AbstractJpaVendorAdapter;
import org.springframework.orm.jpa.vendor.HibernateJpaDialect;
import org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter;
import org.springframework.transaction.jta.JtaTransactionManager;
import javax.sql.DataSource;
/**
* General Hibernate configuration for hawkBit's Repository.
*/
@Configuration
public class JpaConfiguration {
public class JpaConfiguration extends JpaBaseConfiguration {
private final TenantIdentifier tenantIdentifier;
private final boolean enableLazyLoadNoTrans;
protected JpaConfiguration(
final DataSource dataSource, final JpaProperties properties,
final ObjectProvider<JtaTransactionManager> jtaTransactionManagerProvider,
final TenantAware.TenantResolver tenantResolver,
@Value("${hibernate.enable-lazy-load-no-trans:true}") final boolean enableLazyLoadNoTrans) {
super(dataSource, properties, jtaTransactionManagerProvider);
tenantIdentifier = new TenantIdentifier(tenantResolver);
this.enableLazyLoadNoTrans = enableLazyLoadNoTrans;
}
@@ -50,10 +63,22 @@ public class JpaConfiguration {
return tenantIdentifier;
}
@Bean
HibernatePropertiesCustomizer hibernatePropertiesCustomizers() {
return hibernateProperties -> {
// override the default naming strategy
@Override
protected AbstractJpaVendorAdapter createJpaVendorAdapter() {
return new HibernateJpaVendorAdapter() {
private final HibernateJpaDialect hibernateJpaDialect = new CustomHibernateJpaDialect();
@Override
public HibernateJpaDialect getJpaDialect() {
return hibernateJpaDialect;
}
};
}
@Override
protected Map<String, Object> getVendorProperties(DataSource dataSource) {
Map<String, Object> hibernateProperties = new HashMap<>();
hibernateProperties.put("hibernate.physical_naming_strategy", org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl.class.getName());
hibernateProperties.put(MultiTenancySettings.MULTI_TENANT_IDENTIFIER_RESOLVER, tenantIdentifier);
hibernateProperties.put("hibernate.multiTenancy", "DISCRIMINATOR");
@@ -77,6 +102,14 @@ public class JpaConfiguration {
// do nothing
}
}));
};
return hibernateProperties;
}
static class CustomHibernateJpaDialect extends HibernateJpaDialect {
protected CustomHibernateJpaDialect() {
super();
this.setJdbcExceptionTranslator(JpaExceptionTranslator.getTranslator());
}
}
}