net.as_development.asdk.api.db

Interface IDBServer

All Known Implementing Classes:

DBServer

public interface IDBServer

Can be used for setup/tear down of the DB server.

Method Summary

Modifier and Type	Method and Description
void	createSchema() create all schema within this server.
void	initRuntime() initialize the runtime.
void	registerPersistenceRegistryModule(IPersistenceUnitRegistryModule... lModules) register the given module within this server instance.
void	registerPersistenceRegistryModule(List<IPersistenceUnitRegistryModule> lModules)
void	registerPersistenceUnit(IPersistenceUnit... lPUs) register the given set of persistence units within this server instance.
void	registerPersistenceUnit(List<IPersistenceUnit> lPUs)
void	setServerConnection(IPersistenceUnit iData)

Method Detail

setServerConnection

void setServerConnection(IPersistenceUnit iData)
                  throws Exception

Throws:

Exception

registerPersistenceUnit

void registerPersistenceUnit(IPersistenceUnit... lPUs)
                      throws Exception

register the given set of persistence units within this server instance. Must be called BEFORE createSchema () will be called !

Parameters:

lPUs - [IN] the list of persistence units for registration.

Throws:

Exception

registerPersistenceUnit

void registerPersistenceUnit(List<IPersistenceUnit> lPUs)
                      throws Exception

Throws:

Exception

registerPersistenceRegistryModule

void registerPersistenceRegistryModule(IPersistenceUnitRegistryModule... lModules)
                                throws Exception

register the given module within this server instance. Must be called BEFORE createSchema () will be called !

Parameters:

lModules - [IN] the set of modules to be registered.

Throws:

Exception

registerPersistenceRegistryModule

void registerPersistenceRegistryModule(List<IPersistenceUnitRegistryModule> lModules)
                                throws Exception

Throws:

Exception

initRuntime

void initRuntime()
          throws Exception

initialize the runtime. E.g. the global DBPool will be filled with valid data so YOU can use it .-)

Throws:

Exception - if initialization failed by any reason.

createSchema

void createSchema()
           throws Exception

create all schema within this server. Schema will be defined by all persistence units registered before ... Note this will remove ALL schema/data already existing within this server instance !

Throws:

Exception - if (at least one) schema could not be created successfully.