com.avaje.ebean.plugin.SpiServer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of avaje-ebeanorm Show documentation

There is a newer version: 8.1.1

package com.avaje.ebean.plugin;

import com.avaje.ebean.EbeanServer;
import com.avaje.ebean.config.ServerConfig;
import com.avaje.ebean.config.dbplatform.DatabasePlatform;

import java.util.List;

/**
 * Extensions to EbeanServer API made available to plugins.
 */
public interface SpiServer extends EbeanServer {

  /**
   * Return the serverConfig.
   */
  ServerConfig getServerConfig();

  /**
   * Return the DatabasePlatform for this server.
   */
  DatabasePlatform getDatabasePlatform();

  /**
   * Return all the bean types registered on this server instance.
   */
  List> getBeanTypes();

  /**
   * Return the bean type for a given entity bean class.
   */
   BeanType getBeanType(Class beanClass);

  /**
   * Return the bean types mapped to the given base table.
   */
  List> getBeanTypes(String baseTableName);

  /**
   * Return the bean type for a given doc store queueId.
   */
  BeanType getBeanTypeForQueueId(String queueId);
}