de.xima.fc.api.system

Class SetupAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.system.SetupAPI

public class SetupAPI
extends ASubAPI

API-Klassse des Setups

Author:

Michael Kohlsche

Constructor Summary

Constructors

Constructor and Description
SetupAPI()

Method Summary

Modifier and Type	Method and Description
Boolean	createMandantWithDependencies(UserContext uc, Mandant man, Benutzer ben) Methode zum Anlegen eines Mandanten mit der initialen Konfiguration, analog zum Setup-Prozess
FCMessage	invokeLiquibaseProzess(UserContext uc, ELiquibaseCmd command) Methode zum Ausführen eines Liquibase-Prozesse
Boolean	isDbConfigured(UserContext uc) Methode zum Testen ob die Datenbank konfigureiert wurde
Boolean	testConnection(UserContext uc, DBConnectionData databaseData) Methode zum Testen der Datenbank-Verbindung

Methods inherited from class de.xima.fc.api.ASubAPI

getHandlerProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

SetupAPI

public SetupAPI()

Method Detail

testConnection

public Boolean testConnection(UserContext uc,
                              DBConnectionData databaseData)
                       throws ClassNotFoundException,
                              SQLException

Methode zum Testen der Datenbank-Verbindung

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

databaseData - DBConnectionData der Datenbank auf welcher die Verbindung getestet werden soll

Returns:

true wenn die Verbindung hergestellt werden konnte @since 2.4.3

Throws:

SQLException

ClassNotFoundException

invokeLiquibaseProzess

public FCMessage invokeLiquibaseProzess(UserContext uc,
                                        ELiquibaseCmd command)

Methode zum Ausführen eines Liquibase-Prozesse

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

command - ELiquibaseCmd der auszuführende Liquibase-Command

locale -

Returns:

String die Konsolenausgabe der Ausführung des Liquibase-Prozesses @since 2.4.3

isDbConfigured

public Boolean isDbConfigured(UserContext uc)

Methode zum Testen ob die Datenbank konfigureiert wurde

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

Returns:

Boolean true wenn die Datenbank bereits konfiguriert ist, sonst false

Since:

2.4.3

createMandantWithDependencies

public Boolean createMandantWithDependencies(UserContext uc,
                                             Mandant man,
                                             Benutzer ben)

Methode zum Anlegen eines Mandanten mit der initialen Konfiguration, analog zum Setup-Prozess

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

man - Mandant welcher angelegt werden soll

ben - Initialer Mandant-Administrator

Returns:

true wenn der Mandant samt der initialen Konfiguration erfolgreich angelegt werden konnte. @ Fehler beim Anlegen

Since:

2.4.3