de.innovationgate.webgate.api.servers

Class WGDatabaseServer

java.lang.Object

de.innovationgate.webgate.api.servers.WGDatabaseServer

Direct Known Subclasses:

OtherSourcesDatabaseServer

public abstract class WGDatabaseServer
extends java.lang.Object

Object representing a WGAPI database server, offering all available functionalities. Most of the functionality available her is redirected to the ServerDatabaseRetriever for the given database/server type.

Constructor Summary

Constructors

Constructor and Description
WGDatabaseServer()

Method Summary

Methods

Modifier and Type	Method and Description
DatabaseInformation	createDatabase(java.lang.Class<? extends WGDatabaseCore> implClass, java.util.Map<java.lang.String,java.lang.String> options)
de.innovationgate.wga.modules.ModuleDefinition	fetchDatabaseModuleDefinition(java.lang.Class<? extends WGDatabaseCore> implClass)
static ServerDatabaseRetriever	fetchServerDatabaseRetriever(de.innovationgate.wga.modules.ModuleDefinition dbModuleDef, java.lang.Class serverClass)
java.util.List<DatabaseInformation>	getAvailableDatabases(java.lang.Class<? extends WGDatabaseCore> implClass)
java.util.List<de.innovationgate.wga.modules.ModuleDefinition>	getContentDatabaseTypes()
java.util.List<de.innovationgate.wga.modules.ModuleDefinition>	getContentStoreTypes()
java.util.List<java.lang.String>	getDatabasePathOptions(java.lang.Class<? extends WGDatabaseCore> implClass)
static de.innovationgate.wga.modules.ModuleDefinition	getModuleDefinition(java.lang.Class serverClass)
java.util.Map<java.lang.String,java.lang.String>	getOptions()
java.util.List<de.innovationgate.wga.modules.ModuleDefinition>	getPersonalisationDatabaseTypes()
java.lang.String	getTitle(java.util.Locale locale)
java.lang.String	getUid()
void	importState(WGDatabaseServer oldServer)
void	init(java.lang.String uid, java.lang.String title, java.util.Map<java.lang.String,java.lang.String> options)
boolean	isAvailableDatabasesRetrievable(java.lang.Class<? extends WGDatabaseCore> implClass)
boolean	isConnectionTestable()
boolean	isDatabaseTypeCreatable(java.lang.Class<? extends WGDatabaseCore> implClass)
boolean	isSingleton()
WGDatabase	openDatabase(java.lang.Class<? extends WGDatabaseCore> implClass, java.util.Map<java.lang.String,java.lang.String> options)
WGDatabase	prepareDatabase(java.lang.Class<? extends WGDatabaseCore> implClass, java.util.Map<java.lang.String,java.lang.String> options)
void	testConnection()

Methods inherited from class java.lang.Object

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

Constructor Detail

WGDatabaseServer

public WGDatabaseServer()

Method Detail

getTitle

public java.lang.String getTitle(java.util.Locale locale)

getModuleDefinition

public static de.innovationgate.wga.modules.ModuleDefinition getModuleDefinition(java.lang.Class serverClass)

isSingleton

public boolean isSingleton()

init

public void init(java.lang.String uid,
        java.lang.String title,
        java.util.Map<java.lang.String,java.lang.String> options)
          throws WGAPIException

Throws:

WGAPIException

getUid

public java.lang.String getUid()

getOptions

public java.util.Map<java.lang.String,java.lang.String> getOptions()

openDatabase

public WGDatabase openDatabase(java.lang.Class<? extends WGDatabaseCore> implClass,
                      java.util.Map<java.lang.String,java.lang.String> options)
                        throws WGAPIException,
                               de.innovationgate.wga.modules.ModuleDependencyException

Throws:

WGAPIException

de.innovationgate.wga.modules.ModuleDependencyException

prepareDatabase

public WGDatabase prepareDatabase(java.lang.Class<? extends WGDatabaseCore> implClass,
                         java.util.Map<java.lang.String,java.lang.String> options)
                           throws WGAPIException,
                                  de.innovationgate.wga.modules.ModuleDependencyException

Throws:

WGAPIException

de.innovationgate.wga.modules.ModuleDependencyException

createDatabase

public DatabaseInformation createDatabase(java.lang.Class<? extends WGDatabaseCore> implClass,
                                 java.util.Map<java.lang.String,java.lang.String> options)
                                   throws WGAPIException,
                                          de.innovationgate.wga.modules.ModuleDependencyException

Throws:

WGAPIException

de.innovationgate.wga.modules.ModuleDependencyException

getContentDatabaseTypes

public java.util.List<de.innovationgate.wga.modules.ModuleDefinition> getContentDatabaseTypes()

getContentStoreTypes

public java.util.List<de.innovationgate.wga.modules.ModuleDefinition> getContentStoreTypes()

getPersonalisationDatabaseTypes

public java.util.List<de.innovationgate.wga.modules.ModuleDefinition> getPersonalisationDatabaseTypes()

fetchServerDatabaseRetriever

public static ServerDatabaseRetriever fetchServerDatabaseRetriever(de.innovationgate.wga.modules.ModuleDefinition dbModuleDef,
                                                   java.lang.Class serverClass)
                                                            throws de.innovationgate.wga.modules.ModuleDependencyException

Throws:

de.innovationgate.wga.modules.ModuleDependencyException

fetchDatabaseModuleDefinition

public de.innovationgate.wga.modules.ModuleDefinition fetchDatabaseModuleDefinition(java.lang.Class<? extends WGDatabaseCore> implClass)

getAvailableDatabases

public java.util.List<DatabaseInformation> getAvailableDatabases(java.lang.Class<? extends WGDatabaseCore> implClass)
                                                          throws WGAPIException,
                                                                 de.innovationgate.wga.modules.ModuleDependencyException

Throws:

WGAPIException

de.innovationgate.wga.modules.ModuleDependencyException

isAvailableDatabasesRetrievable

public boolean isAvailableDatabasesRetrievable(java.lang.Class<? extends WGDatabaseCore> implClass)
                                        throws WGAPIException,
                                               de.innovationgate.wga.modules.ModuleDependencyException

Throws:

WGAPIException

de.innovationgate.wga.modules.ModuleDependencyException

isDatabaseTypeCreatable

public boolean isDatabaseTypeCreatable(java.lang.Class<? extends WGDatabaseCore> implClass)
                                throws WGAPIException,
                                       de.innovationgate.wga.modules.ModuleDependencyException

Throws:

WGAPIException

de.innovationgate.wga.modules.ModuleDependencyException

testConnection

public void testConnection()
                    throws ServerConnectionException

Throws:

ServerConnectionException

isConnectionTestable

public boolean isConnectionTestable()

getDatabasePathOptions

public java.util.List<java.lang.String> getDatabasePathOptions(java.lang.Class<? extends WGDatabaseCore> implClass)
                                                        throws WGAPIException,
                                                               de.innovationgate.wga.modules.ModuleDependencyException

Throws:

WGAPIException

de.innovationgate.wga.modules.ModuleDependencyException

importState

public void importState(WGDatabaseServer oldServer)