Package org.keycloak.connections.jpa.entityprovider

Interface JpaEntityProvider

All Superinterfaces:
Provider
public interface JpaEntityProvider extends Provider
Author:
Erik Mulder A JPA Entity Provider can supply extra JPA entities that the Keycloak system should include in it's entity manager. The entities should be provided as a list of Class objects.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getChangelogLocation()
    Return the location of the Liquibase changelog that facilitates the extra JPA entities.
    List<Class<?>>
    getEntities()
    Deprecated, for removal: This API element is subject to removal in a future version.
    this method is ignored in production and will be removed together with legacy testsuite
    String
    getFactoryId()
    Return the ID of provider factory, which created this provider.

    Methods inherited from interface org.keycloak.provider.Provider

    close

  • Method Details

    • getEntities

      @Deprecated(forRemoval=true) List<Class<?>> getEntities()
      Deprecated, for removal: This API element is subject to removal in a future version.
      this method is ignored in production and will be removed together with legacy testsuite
      Return the entities that should be added to the entity manager.
      Returns:
      list of class objects

    • getChangelogLocation

      String getChangelogLocation()
      Return the location of the Liquibase changelog that facilitates the extra JPA entities. This should be a location that can be found on the same classpath as the entity classes.
      Returns:
      a changelog location or null if not needed

    • getFactoryId

      String getFactoryId()
      Return the ID of provider factory, which created this provider. Might be used to "compute" the table name of liquibase changelog table.
      Returns:
      ID of provider factory