Merge pull request #2745 from ebean-orm/feature/2733-rename-moduleInfoLoader

#2733 - Rename ModuleInfoLoader to EntityClassRegister and _Ebean$ModuleInfo to EbeanEntityRegister
This commit is contained in:
Rob Bygrave authored and GitHub committed 2022-08-03 20:35:21 +12:00
commit 732f0e13e2
14 files changed
+32 -37

No files matched your search

@@ -115,9 +115,9 @@ public class DatabaseConfig {
private TenantCatalogProvider tenantCatalogProvider; private TenantCatalogProvider tenantCatalogProvider;
/** /**
* When true will load entity classes via ModuleInfoLoader. * When true will load entity classes via EntityClassRegister.
* <p> * <p>
* NB: ModuleInfoLoader implementations are generated by querybean generator. * NB: EntityClassRegister implementations are generated by querybean generator.
* Having this on and registering entity classes means we don't need to manually * Having this on and registering entity classes means we don't need to manually
* write that code or use classpath scanning to find entity classes. * write that code or use classpath scanning to find entity classes.
*/ */
@@ -3376,7 +3376,7 @@ public class DatabaseConfig {
} }
/** /**
* Return true if entity classes should be loaded and registered via ModuleInfoLoader. * Return true if entity classes should be loaded and registered via EntityClassRegister.
* <p> * <p>
* When false we either register entity classes via application code or use classpath * When false we either register entity classes via application code or use classpath
* scanning to find and register entity classes. * scanning to find and register entity classes.
@@ -5,7 +5,7 @@ import java.util.List;
/** /**
* Loads and returns entity classes to register with Ebean databases. * Loads and returns entity classes to register with Ebean databases.
*/ */
public interface ModuleInfoLoader { public interface EntityClassRegister {
/** /**
* Return entity classes to register for a named DB (not default DB). * Return entity classes to register for a named DB (not default DB).
@@ -1,12 +1,7 @@
package io.ebeaninternal.server.core; package io.ebeaninternal.server.core;
import io.ebean.config.BackgroundExecutorWrapper; import io.ebean.config.*;
import io.ebean.config.ContainerConfig; import io.ebean.config.EntityClassRegister;
import io.ebean.config.DatabaseConfig;
import io.ebean.config.DatabaseConfigProvider;
import io.ebean.config.ModuleInfoLoader;
import io.ebean.config.TenantMode;
import io.ebean.config.UnderscoreNamingConvention;
import io.ebean.config.dbplatform.DatabasePlatform; import io.ebean.config.dbplatform.DatabasePlatform;
import io.ebean.event.ShutdownManager; import io.ebean.event.ShutdownManager;
import io.ebean.service.SpiContainer; import io.ebean.service.SpiContainer;
@@ -129,7 +124,7 @@ public final class DefaultContainer implements SpiContainer {
if (config.isAutoLoadModuleInfo()) { if (config.isAutoLoadModuleInfo()) {
// auto register entity classes // auto register entity classes
boolean found = false; boolean found = false;
for (ModuleInfoLoader loader : ServiceLoader.load(ModuleInfoLoader.class)) { for (EntityClassRegister loader : ServiceLoader.load(EntityClassRegister.class)) {
config.addAll(loader.classesFor(config.getName(), config.isDefaultServer())); config.addAll(loader.classesFor(config.getName(), config.isDefaultServer()));
found = true; found = true;
} }
@@ -140,9 +135,9 @@ public final class DefaultContainer implements SpiContainer {
} }
private void checkMissingModulePathProvides() { private void checkMissingModulePathProvides() {
URL servicesFile = ClassLoader.getSystemResource("META-INF/services/io.ebean.config.ModuleInfoLoader"); URL servicesFile = ClassLoader.getSystemResource("META-INF/services/io.ebean.config.EntityClassRegister");
if (servicesFile != null) { if (servicesFile != null) {
log.error("module-info.java is probably missing 'provides io.ebean.config.ModuleInfoLoader with _Ebean$ModuleInfo' clause. ModuleInfoLoader exists but was not service loaded."); log.error("module-info.java is probably missing 'provides io.ebean.config.EntityClassRegister with EbeanEntityRegister' clause. EntityClassRegister exists but was not service loaded.");
} }
} }
@@ -578,8 +578,8 @@ public final class BeanDescriptorManager implements BeanDescriptorMap, SpiBeanTy
} }
private <T> String errNothingRegistered() { private <T> String errNothingRegistered() {
return "There are no registered entities. If using query beans, that generates _Ebean$ModuleInfo.java into " + return "There are no registered entities. If using query beans, that generates EbeanEntityRegister.java into " +
"generated sources and is service loaded. If using module-info.java, then probably missing 'provides io.ebean.config.ModuleInfoLoader with _Ebean$ModuleInfo' clause."; "generated sources and is service loaded. If using module-info.java, then probably missing 'provides io.ebean.config.EntityClassRegister with EbeanEntityRegister' clause.";
} }
private String errNotRegistered(Class<?> beanClass) { private String errNotRegistered(Class<?> beanClass) {
+1 -1
View File
@@ -4,7 +4,7 @@ module io.ebean.core {
uses io.ebean.cache.ServerCachePlugin; uses io.ebean.cache.ServerCachePlugin;
uses io.ebean.cache.ServerCacheNotifyPlugin; uses io.ebean.cache.ServerCacheNotifyPlugin;
uses io.ebean.config.DatabaseConfigProvider; uses io.ebean.config.DatabaseConfigProvider;
uses io.ebean.config.ModuleInfoLoader; uses io.ebean.config.EntityClassRegister;
uses io.ebean.config.dbplatform.DatabasePlatformProvider; uses io.ebean.config.dbplatform.DatabasePlatformProvider;
uses io.ebean.datasource.DataSourceAlertFactory; uses io.ebean.datasource.DataSourceAlertFactory;
uses io.ebean.core.type.ExtraTypeFactory; uses io.ebean.core.type.ExtraTypeFactory;
+1 -1
View File
@@ -113,7 +113,7 @@
<annotationProcessorPath> <annotationProcessorPath>
<groupId>io.ebean</groupId> <groupId>io.ebean</groupId>
<artifactId>kotlin-querybean-generator</artifactId> <artifactId>kotlin-querybean-generator</artifactId>
<version>13.6.2</version> <version>13.6.6-SNAPSHOT</version>
</annotationProcessorPath> </annotationProcessorPath>
</annotationProcessorPaths> </annotationProcessorPaths>
</configuration> </configuration>
@@ -30,5 +30,5 @@ interface Constants {
String MODULEINFO = "io.ebean.config.ModuleInfo"; String MODULEINFO = "io.ebean.config.ModuleInfo";
String METAINF_MANIFEST = "META-INF/ebean-generated-info.mf"; String METAINF_MANIFEST = "META-INF/ebean-generated-info.mf";
String METAINF_SERVICES_MODULELOADER = "META-INF/services/io.ebean.config.ModuleInfoLoader"; String METAINF_SERVICES_MODULELOADER = "META-INF/services/io.ebean.config.EntityClassRegister";
} }
@@ -88,7 +88,7 @@ class ProcessingContext implements Constants {
private List<String> loadedPrefixEntities = new ArrayList<>(); ; private List<String> loadedPrefixEntities = new ArrayList<>(); ;
/** /**
* The package for the generated ModuleInfoLoader. * The package for the generated EntityClassRegister.
*/ */
private String factoryPackage; private String factoryPackage;
@@ -537,7 +537,7 @@ class ProcessingContext implements Constants {
} }
/** /**
* Return the class name of the generated ModuleInfoLoader * Return the class name of the generated EntityClassRegister
* (such that we can read the current meta data for partial compile). * (such that we can read the current meta data for partial compile).
*/ */
String loadMetaInfServices() { String loadMetaInfServices() {
@@ -105,20 +105,20 @@ public class Processor extends AbstractProcessor implements Constants {
} }
} catch (Throwable e) { } catch (Throwable e) {
e.printStackTrace(); e.printStackTrace();
processingContext.logError(null, "Failed to initialise ModuleInfoLoader error:" + e + " stack:" + Arrays.toString(e.getStackTrace())); processingContext.logError(null, "Failed to initialise EntityClassRegister error:" + e + " stack:" + Arrays.toString(e.getStackTrace()));
} }
} }
private void writeModuleInfoBean() { private void writeModuleInfoBean() {
try { try {
if (moduleWriter == null) { if (moduleWriter == null) {
processingContext.logError(null, "ModuleInfoLoader was not initialised and not written"); processingContext.logError(null, "EntityClassRegister was not initialised and not written");
} else { } else {
moduleWriter.write(); moduleWriter.write();
} }
} catch (Throwable e) { } catch (Throwable e) {
e.printStackTrace(); e.printStackTrace();
processingContext.logError(null, "Failed to write ModuleInfoLoader error:" + e + " stack:" + Arrays.toString(e.getStackTrace())); processingContext.logError(null, "Failed to write EntityClassRegister error:" + e + " stack:" + Arrays.toString(e.getStackTrace()));
} }
} }
@@ -25,7 +25,7 @@ class SimpleModuleInfoWriter {
SimpleModuleInfoWriter(ProcessingContext processingContext) throws IOException { SimpleModuleInfoWriter(ProcessingContext processingContext) throws IOException {
this.processingContext = processingContext; this.processingContext = processingContext;
this.factoryPackage = processingContext.getFactoryPackage(); this.factoryPackage = processingContext.getFactoryPackage();
this.factoryShortName = "_Ebean$ModuleInfo"; this.factoryShortName = "EbeanEntityRegister";
this.factoryFullName = factoryPackage + "." + factoryShortName; this.factoryFullName = factoryPackage + "." + factoryShortName;
this.javaFileObject = processingContext.createWriter(factoryFullName); this.javaFileObject = processingContext.createWriter(factoryFullName);
} }
@@ -94,7 +94,7 @@ class SimpleModuleInfoWriter {
writer.append("import %s;", Constants.GENERATED).eol(); writer.append("import %s;", Constants.GENERATED).eol();
writer.eol(); writer.eol();
writer.append("import io.ebean.config.ModuleInfo;").eol(); writer.append("import io.ebean.config.ModuleInfo;").eol();
writer.append("import io.ebean.config.ModuleInfoLoader;").eol(); writer.append("import io.ebean.config.EntityClassRegister;").eol();
writer.eol(); writer.eol();
} }
@@ -128,7 +128,7 @@ class SimpleModuleInfoWriter {
buildAtContextModule(writer); buildAtContextModule(writer);
writer.append("public class %s implements ModuleInfoLoader {", factoryShortName).eol().eol(); writer.append("public class %s implements EntityClassRegister {", factoryShortName).eol().eol();
writeMethodOtherClasses(); writeMethodOtherClasses();
writeMethodEntityClasses(processingContext.getDbEntities(), null); writeMethodEntityClasses(processingContext.getDbEntities(), null);
@@ -31,6 +31,6 @@ interface Constants {
String MODULEINFO = "io.ebean.config.ModuleInfo"; String MODULEINFO = "io.ebean.config.ModuleInfo";
String METAINF_MANIFEST = "META-INF/ebean-generated-info.mf"; String METAINF_MANIFEST = "META-INF/ebean-generated-info.mf";
String METAINF_SERVICES_MODULELOADER = "META-INF/services/io.ebean.config.ModuleInfoLoader"; String METAINF_SERVICES_MODULELOADER = "META-INF/services/io.ebean.config.EntityClassRegister";
} }
@@ -84,7 +84,7 @@ class ProcessingContext implements Constants {
private List<String> loadedPrefixEntities = new ArrayList<>(); private List<String> loadedPrefixEntities = new ArrayList<>();
/** /**
* The package for the generated ModuleInfoLoader. * The package for the generated EntityClassRegister.
*/ */
private String factoryPackage; private String factoryPackage;
@@ -516,8 +516,8 @@ class ProcessingContext implements Constants {
} }
/** /**
* Return the class name of the generated ModuleInfoLoader * Return the class name of the generated EntityClassRegister
* (such that we can read the current meta data for partial compile). * (such that we can read the current metadata for partial compile).
*/ */
String loadMetaInfServices() { String loadMetaInfServices() {
try { try {
@@ -93,20 +93,20 @@ public class Processor extends AbstractProcessor implements Constants {
} }
} catch (Throwable e) { } catch (Throwable e) {
e.printStackTrace(); e.printStackTrace();
processingContext.logError(null, "Failed to initialise ModuleInfoLoader error:" + e + " stack:" + Arrays.toString(e.getStackTrace())); processingContext.logError(null, "Failed to initialise EntityClassRegister error:" + e + " stack:" + Arrays.toString(e.getStackTrace()));
} }
} }
private void writeModuleInfoBean() { private void writeModuleInfoBean() {
try { try {
if (moduleWriter == null) { if (moduleWriter == null) {
processingContext.logError(null, "ModuleInfoLoader was not initialised and not written"); processingContext.logError(null, "EntityClassRegister was not initialised and not written");
} else { } else {
moduleWriter.write(); moduleWriter.write();
} }
} catch (Throwable e) { } catch (Throwable e) {
e.printStackTrace(); e.printStackTrace();
processingContext.logError(null, "Failed to write ModuleInfoLoader error:" + e + " stack:" + Arrays.toString(e.getStackTrace())); processingContext.logError(null, "Failed to write EntityClassRegister error:" + e + " stack:" + Arrays.toString(e.getStackTrace()));
} }
} }
@@ -25,7 +25,7 @@ class SimpleModuleInfoWriter {
SimpleModuleInfoWriter(ProcessingContext processingContext) throws IOException { SimpleModuleInfoWriter(ProcessingContext processingContext) throws IOException {
this.processingContext = processingContext; this.processingContext = processingContext;
this.factoryPackage = processingContext.getFactoryPackage(); this.factoryPackage = processingContext.getFactoryPackage();
this.factoryShortName = "_Ebean$ModuleInfo"; this.factoryShortName = "EbeanEntityRegister";
this.factoryFullName = factoryPackage + "." + factoryShortName; this.factoryFullName = factoryPackage + "." + factoryShortName;
this.javaFileObject = processingContext.createWriter(factoryFullName); this.javaFileObject = processingContext.createWriter(factoryFullName);
} }
@@ -94,7 +94,7 @@ class SimpleModuleInfoWriter {
writer.append("import %s;", Constants.GENERATED).eol(); writer.append("import %s;", Constants.GENERATED).eol();
writer.eol(); writer.eol();
writer.append("import io.ebean.config.ModuleInfo;").eol(); writer.append("import io.ebean.config.ModuleInfo;").eol();
writer.append("import io.ebean.config.ModuleInfoLoader;").eol(); writer.append("import io.ebean.config.EntityClassRegister;").eol();
writer.eol(); writer.eol();
} }
@@ -128,7 +128,7 @@ class SimpleModuleInfoWriter {
buildAtContextModule(writer); buildAtContextModule(writer);
writer.append("public class %s implements ModuleInfoLoader {", factoryShortName).eol().eol(); writer.append("public class %s implements EntityClassRegister {", factoryShortName).eol().eol();
writeMethodOtherClasses(); writeMethodOtherClasses();
writeMethodEntityClasses(processingContext.getDbEntities(), null); writeMethodEntityClasses(processingContext.getDbEntities(), null);