#574 - Refactor - rename .plugin objects; SpiBeanType -> BeanType and SpiServerPlugin -> Plugin

This commit is contained in:
Robin Bygrave
2016-02-29 09:19:44 +13:00
parent 6c49ac0857
commit 2353049c6f
12 changed files with 36 additions and 37 deletions
@@ -9,7 +9,7 @@ import com.avaje.ebean.event.BeanQueryAdapter;
/**
* Information and methods on BeanDescriptors made available to plugins.
*/
public interface SpiBeanType<T> {
public interface BeanType<T> {
/**
* Return the class type this BeanDescriptor describes.
@@ -3,7 +3,7 @@ package com.avaje.ebean.plugin;
/**
* A 'plugin' that wants to be configured on startup so it can use features of the EbeanServer itself.
*/
public interface SpiServerPlugin {
public interface Plugin {
/**
* Configure the plugin.
@@ -24,16 +24,16 @@ public interface SpiServer extends EbeanServer {
/**
* Return all the bean types registered on this server instance.
*/
List<? extends SpiBeanType<?>> getBeanTypes();
List<? extends BeanType<?>> getBeanTypes();
/**
* Return the bean type for a given entity bean class.
*/
<T> SpiBeanType<T> getBeanType(Class<T> beanClass);
<T> BeanType<T> getBeanType(Class<T> beanClass);
/**
* Return the bean types mapped to the given base table.
*/
List<? extends SpiBeanType<?>> getBeanTypes(String baseTableName);
List<? extends BeanType<?>> getBeanTypes(String baseTableName);
}
@@ -1,6 +1,6 @@
package com.avaje.ebeaninternal.api;
import com.avaje.ebean.plugin.SpiBeanType;
import com.avaje.ebean.plugin.BeanType;
import java.util.LinkedHashSet;
import java.util.Set;
@@ -10,11 +10,11 @@ import java.util.Set;
*/
public class SpiExpressionValidation {
private final SpiBeanType<?> desc;
private final BeanType<?> desc;
private final LinkedHashSet<String> unknown = new LinkedHashSet<String>();
public SpiExpressionValidation(SpiBeanType<?> desc) {
public SpiExpressionValidation(BeanType<?> desc) {
this.desc = desc;
}
@@ -11,7 +11,7 @@ import com.avaje.ebean.bean.ObjectGraphNode;
import com.avaje.ebean.bean.PersistenceContext;
import com.avaje.ebean.event.BeanQueryRequest;
import com.avaje.ebean.event.readaudit.ReadEvent;
import com.avaje.ebean.plugin.SpiBeanType;
import com.avaje.ebean.plugin.BeanType;
import com.avaje.ebeaninternal.server.autotune.ProfilingListener;
import com.avaje.ebeaninternal.server.deploy.BeanDescriptor;
import com.avaje.ebeaninternal.server.deploy.BeanPropertyAssocMany;
@@ -19,7 +19,6 @@ import com.avaje.ebeaninternal.server.deploy.TableJoin;
import com.avaje.ebeaninternal.server.query.CancelableQuery;
import com.avaje.ebeaninternal.server.querydefn.NaturalKeyBindParam;
import com.avaje.ebeaninternal.server.querydefn.OrmQueryDetail;
import com.avaje.ebeaninternal.server.querydefn.OrmQueryProperties;
import java.sql.Timestamp;
import java.util.List;
@@ -679,6 +678,6 @@ public interface SpiQuery<T> extends Query<T> {
/**
* Validate the query returning the set of properties with unknown paths.
*/
Set<String> validate(SpiBeanType<T> desc);
Set<String> validate(BeanType<T> desc);
}
@@ -5,7 +5,7 @@ import com.avaje.ebean.event.changelog.ChangeLogListener;
import com.avaje.ebean.event.changelog.ChangeSet;
import com.avaje.ebean.event.changelog.ChangeType;
import com.avaje.ebean.plugin.SpiServer;
import com.avaje.ebean.plugin.SpiServerPlugin;
import com.avaje.ebean.plugin.Plugin;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -20,7 +20,7 @@ import java.util.Properties;
* is fully contained with the transaction information.
* </p>
*/
public class DefaultChangeLogListener implements ChangeLogListener, SpiServerPlugin {
public class DefaultChangeLogListener implements ChangeLogListener, Plugin {
/**
* The usual application specific logger.
@@ -18,9 +18,9 @@ import com.avaje.ebean.event.BeanPersistController;
import com.avaje.ebean.event.readaudit.ReadAuditLogger;
import com.avaje.ebean.event.readaudit.ReadAuditPrepare;
import com.avaje.ebean.meta.MetaInfoManager;
import com.avaje.ebean.plugin.SpiBeanType;
import com.avaje.ebean.plugin.BeanType;
import com.avaje.ebean.plugin.SpiServer;
import com.avaje.ebean.plugin.SpiServerPlugin;
import com.avaje.ebean.plugin.Plugin;
import com.avaje.ebean.text.csv.CsvReader;
import com.avaje.ebean.text.json.JsonContext;
import com.avaje.ebeaninternal.api.LoadBeanRequest;
@@ -138,7 +138,7 @@ public final class DefaultServer implements SpiServer, SpiEbeanServer {
private final CQueryEngine cqueryEngine;
private final List<SpiServerPlugin> serverPlugins;
private final List<Plugin> serverPlugins;
private final DdlGenerator ddlGenerator;
@@ -248,7 +248,7 @@ public final class DefaultServer implements SpiServer, SpiEbeanServer {
autoTuneService.startup();
for (SpiServerPlugin plugin : serverPlugins) {
for (Plugin plugin : serverPlugins) {
plugin.configure(this);
}
}
@@ -282,7 +282,7 @@ public final class DefaultServer implements SpiServer, SpiEbeanServer {
for (SpiEbeanPlugin plugin : ebeanPlugins) {
plugin.execute(online);
}
for (SpiServerPlugin plugin : serverPlugins) {
for (Plugin plugin : serverPlugins) {
plugin.online(online);
}
}
@@ -408,7 +408,7 @@ public final class DefaultServer implements SpiServer, SpiEbeanServer {
private void shutdownPlugins() {
for (SpiServerPlugin plugin : serverPlugins) {
for (Plugin plugin : serverPlugins) {
try {
plugin.shutdown();
} catch (Throwable e) {
@@ -2000,14 +2000,14 @@ public final class DefaultServer implements SpiServer, SpiEbeanServer {
/**
* Return all the SPI BeanTypes.
*/
public List<? extends SpiBeanType<?>> getBeanTypes() {
public List<? extends BeanType<?>> getBeanTypes() {
return getBeanDescriptors();
}
/**
* Return the SPI bean types mapped to the given table.
*/
public List<? extends SpiBeanType<?>> getBeanTypes(String tableName) {
public List<? extends BeanType<?>> getBeanTypes(String tableName) {
return beanDescriptorManager.getBeanTypes(tableName);
}
@@ -2015,7 +2015,7 @@ public final class DefaultServer implements SpiServer, SpiEbeanServer {
* Return the SPI bean types for the given bean class.
*/
@Override
public <T> SpiBeanType<T> getBeanType(Class<T> beanType) {
public <T> BeanType<T> getBeanType(Class<T> beanType) {
return getBeanDescriptor(beanType);
}
@@ -11,7 +11,7 @@ import com.avaje.ebean.event.changelog.ChangeLogPrepare;
import com.avaje.ebean.event.changelog.ChangeLogRegister;
import com.avaje.ebean.event.readaudit.ReadAuditLogger;
import com.avaje.ebean.event.readaudit.ReadAuditPrepare;
import com.avaje.ebean.plugin.SpiServerPlugin;
import com.avaje.ebean.plugin.Plugin;
import com.avaje.ebean.text.json.JsonContext;
import com.avaje.ebeaninternal.api.SpiBackgroundExecutor;
import com.avaje.ebeaninternal.api.SpiEbeanServer;
@@ -103,7 +103,7 @@ public class InternalConfiguration {
/**
* List of plugins (that ultimately the DefaultServer configures late in construction).
*/
private final List<SpiServerPlugin> plugins = new ArrayList<SpiServerPlugin>();
private final List<Plugin> plugins = new ArrayList<Plugin>();
public InternalConfiguration(XmlConfig xmlConfig, ClusterManager clusterManager,
ServerCacheManager cacheManager, SpiBackgroundExecutor backgroundExecutor,
@@ -156,8 +156,8 @@ public class InternalConfiguration {
* later on the DefaultServer for late call to configure().
*/
public <T> T plugin(T maybePlugin) {
if (maybePlugin instanceof SpiServerPlugin) {
plugins.add((SpiServerPlugin) maybePlugin);
if (maybePlugin instanceof Plugin) {
plugins.add((Plugin) maybePlugin);
}
return maybePlugin;
}
@@ -165,10 +165,10 @@ public class InternalConfiguration {
/**
* Return the list of plugins we collected during construction.
*/
public List<SpiServerPlugin> getPlugins() {
public List<Plugin> getPlugins() {
// find additional plugins via ServiceLoader ...
for (SpiServerPlugin plugin : ServiceLoader.load(SpiServerPlugin.class)) {
for (Plugin plugin : ServiceLoader.load(Plugin.class)) {
if (!plugins.contains(plugin)) {
plugins.add(plugin);
}
@@ -28,7 +28,7 @@ import com.avaje.ebean.event.readaudit.ReadAuditPrepare;
import com.avaje.ebean.event.readaudit.ReadEvent;
import com.avaje.ebean.meta.MetaBeanInfo;
import com.avaje.ebean.meta.MetaQueryPlanStatistic;
import com.avaje.ebean.plugin.SpiBeanType;
import com.avaje.ebean.plugin.BeanType;
import com.avaje.ebeaninternal.api.CQueryPlanKey;
import com.avaje.ebeaninternal.api.SpiEbeanServer;
import com.avaje.ebeaninternal.api.SpiQuery;
@@ -81,7 +81,7 @@ import java.util.concurrent.ConcurrentHashMap;
/**
* Describes Beans including their deployment information.
*/
public class BeanDescriptor<T> implements MetaBeanInfo, SpiBeanType<T> {
public class BeanDescriptor<T> implements MetaBeanInfo, BeanType<T> {
private static final Logger logger = LoggerFactory.getLogger(BeanDescriptor.class);
@@ -21,7 +21,7 @@ import com.avaje.ebean.event.changelog.ChangeLogFilter;
import com.avaje.ebean.event.changelog.ChangeLogListener;
import com.avaje.ebean.event.changelog.ChangeLogPrepare;
import com.avaje.ebean.event.changelog.ChangeLogRegister;
import com.avaje.ebean.plugin.SpiBeanType;
import com.avaje.ebean.plugin.BeanType;
import com.avaje.ebeaninternal.api.SpiEbeanServer;
import com.avaje.ebeaninternal.api.TransactionEventTable;
import com.avaje.ebeaninternal.server.core.BootupClasses;
@@ -359,7 +359,7 @@ public class BeanDescriptorManager implements BeanDescriptorMap {
/**
* Return the BeanDescriptors mapped to the table.
*/
public List<? extends SpiBeanType<?>> getBeanTypes(String tableName) {
public List<? extends BeanType<?>> getBeanTypes(String tableName) {
return tableToDescMap.get(tableName.toLowerCase());
}
@@ -9,7 +9,7 @@ import com.avaje.ebean.bean.ObjectGraphOrigin;
import com.avaje.ebean.bean.PersistenceContext;
import com.avaje.ebean.event.BeanQueryRequest;
import com.avaje.ebean.event.readaudit.ReadEvent;
import com.avaje.ebean.plugin.SpiBeanType;
import com.avaje.ebean.plugin.BeanType;
import com.avaje.ebean.text.PathProperties;
import com.avaje.ebeaninternal.api.BindParams;
import com.avaje.ebeaninternal.api.HashQuery;
@@ -1438,7 +1438,7 @@ public class DefaultOrmQuery<T> implements SpiQuery<T> {
/**
* Validate all the expression properties/paths given the bean descriptor.
*/
public Set<String> validate(SpiBeanType<T> desc) {
public Set<String> validate(BeanType<T> desc) {
SpiExpressionValidation validation = new SpiExpressionValidation(desc);
if (whereExpressions != null) {