com.avaje.ebean

Class EbeanServerFactory

java.lang.Object

com.avaje.ebean.EbeanServerFactory

public class EbeanServerFactory
extends Object

Creates EbeanServer instances.

This uses either a ServerConfig or properties in the ebean.properties file to configure and create a EbeanServer instance.

The EbeanServer instance can either be registered with the Ebean singleton or not. The Ebean singleton effectively holds a map of EbeanServers by a name. If the EbeanServer is registered with the Ebean singleton you can retrieve it later via Ebean.getServer(String).

One EbeanServer can be nominated as the 'default/primary' EbeanServer. Many methods on the Ebean singleton such as Ebean.find(Class) are just a convenient way of using the 'default/primary' EbeanServer.

Constructor Summary

Constructors

Constructor and Description
EbeanServerFactory()

Method Summary

Modifier and Type	Method and Description
static EbeanServer	create(ServerConfig config) Create using the ServerConfig object to configure the server.
static EbeanServer	create(String name) Create using ebean.properties to configure the server.
protected static SpiContainer	createContainer(ContainerConfig containerConfig) Create the container instance using the configuration.
static EbeanServer	createWithContextClassLoader(ServerConfig config, ClassLoader classLoader) Create using the ServerConfig additionally specifying a classLoader to use as the context class loader.
static void	initialiseContainer(ContainerConfig containerConfig) Initialise the container with clustering configuration.
static void	shutdown() Shutdown gracefully all EbeanServers cleaning up any resources as required.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EbeanServerFactory

public EbeanServerFactory()

Method Detail

initialiseContainer

public static void initialiseContainer(ContainerConfig containerConfig)

Initialise the container with clustering configuration. Call this prior to creating any EbeanServer instances or alternatively set the ContainerConfig on the ServerConfig when creating the first EbeanServer instance.

create

public static EbeanServer create(String name)

Create using ebean.properties to configure the server.

create

public static EbeanServer create(ServerConfig config)

Create using the ServerConfig object to configure the server.

createWithContextClassLoader

public static EbeanServer createWithContextClassLoader(ServerConfig config,
                                                       ClassLoader classLoader)

Create using the ServerConfig additionally specifying a classLoader to use as the context class loader.

shutdown

public static void shutdown()

Shutdown gracefully all EbeanServers cleaning up any resources as required.

This is typically invoked via JVM shutdown hook and not explicitly called.

createContainer

protected static SpiContainer createContainer(ContainerConfig containerConfig)

Create the container instance using the configuration.