Package org.keycloak.connections.jpa.util

Class JpaUtils

java.lang.Object
org.keycloak.connections.jpa.util.JpaUtils
public class JpaUtils extends Object
Author:
Marek Posolda

  • Field Details

  • Constructor Details

    • JpaUtils

      public JpaUtils()

  • Method Details

    • getTableNameForNativeQuery

      public static String getTableNameForNativeQuery(String tableName, jakarta.persistence.EntityManager em)

    • createEntityManagerFactory

      public static jakarta.persistence.EntityManagerFactory createEntityManagerFactory(KeycloakSession session, String unitName, Map<String,Object> properties, boolean jta)

    • getProvidedEntities

      public static List<Class<?>> getProvidedEntities(KeycloakSession session)
      Get a list of all provided entities by looping over all configured entity providers.
      Parameters:
      session - the keycloak session
      Returns:
      a list of all provided entities (can be an empty list)

    • getCustomChangelogTableName

      public static String getCustomChangelogTableName(String jpaEntityProviderFactoryId)
      Get the name of custom table for liquibase updates for give ID of JpaEntityProvider
      Parameters:
      jpaEntityProviderFactoryId -
      Returns:
      table name

    • loadSqlProperties

      public static Properties loadSqlProperties(URL url)
      Loads the URL as a properties file.
      Parameters:
      url - The url to load, it can be null
      Returns:
      A properties file with the url loaded or null

    • loadSpecificNamedQueries

      public static Properties loadSpecificNamedQueries(String databaseType)
      Method that adds the different query variants for the database. The method loads the queries specified in the files META-INF/queries-{dbType}.properties and the default META-INF/queries-default.properties. At least the default file should exist inside the jar file. The default file contains all the needed queries and the specific one can overload all or some of them for that database type.
      Parameters:
      databaseType - The database type as managed in
      Returns:

    • configureNamedQuery

      public static void configureNamedQuery(String queryName, String querySql, jakarta.persistence.EntityManager entityManager)
      Configures a named query to Hibernate.
      Parameters:
      queryName - the query name
      querySql - the query SQL
      entityManager - the entity manager

    • getDatabaseType

      public static String getDatabaseType(String productName)

    • closeEntityManager

      public static void closeEntityManager(jakarta.persistence.EntityManager em)
      Helper to close the entity manager.
      Parameters:
      em - The entity manager to close