Package de.xima.fc.handler.system

Class SetupHandler

java.lang.Object

de.xima.fc.handler.AMSApiHandler

de.xima.fc.handler.system.SetupHandler

All Implemented Interfaces:

IAPIHandler, ISetupHandler, Serializable

public class SetupHandler
extends AMSApiHandler
implements ISetupHandler

The Class SetupHandler.

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SetupHandler()

Method Summary

Modifier and Type	Method	Description
boolean	createManantWithDependencies(UserContext uc, Mandant mandant, MandantMailData mailData, MandantLdapData ldapData, Benutzer ben)	Deprecated. Use createManantWithDependencies(UserContext, Mandant, MandantMailData, String, IUser) instead.
boolean	createManantWithDependencies(UserContext uc, Mandant mandant, MandantMailData mailData, String adminEmail, IUser creator)	Methode zum Anlegen eines Mandanten mit der initialen Konfiguration, analog zum Setup-Prozess
List<XLogAppender>	getAvailableLogAppenders()	Deprecated.
FCMessage	invokeLiquibaseProzess(UserContext uc, ELiquibaseCmd lbCmd)	Deprecated. Use FormcycleUpdate instead.
Boolean	isDbConfigured(UserContext uc)	Methode zum Testen ob die Datenbank konfigureiert wurde
Boolean	isDbRunning()	Checks whether the database is running or not
Boolean	isDbUpToDate()	Checks whether the database is up to date
Boolean	isUpdateNeeded()	Checks whether there are updated that have not been executed yet.
Boolean	testConnection(UserContext uc, DBConnectionData db)	Test connection.

Methods inherited from class de.xima.fc.handler.AMSApiHandler

getName

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.xima.fc.com.interfaces.IAPIHandler

getName

Constructor Detail

SetupHandler

public SetupHandler()

Method Detail

invokeLiquibaseProzess

@Deprecated
public FCMessage invokeLiquibaseProzess(UserContext uc,
                                        ELiquibaseCmd lbCmd)
                                 throws de.xima.cmn.dao.exceptions.UpdateException

Deprecated.

Use FormcycleUpdate instead.

Description copied from interface: ISetupHandler

Invoke liquibase prozess.

Specified by:

invokeLiquibaseProzess in interface ISetupHandler

Parameters:

uc - the UserContext to use

lbCmd - the lb cmd

Returns:

FCMessage with errors or info messages

Throws:

de.xima.cmn.dao.exceptions.UpdateException

testConnection

public Boolean testConnection(UserContext uc,
                              DBConnectionData db)
                       throws de.xima.cmn.dao.exceptions.ReadException

Description copied from interface: ISetupHandler

Test connection.

Specified by:

testConnection in interface ISetupHandler

db - the db

Returns:

true wenn die Verbindung hergestellt werden konnte @

Throws:

de.xima.cmn.dao.exceptions.ReadException

isDbConfigured

public Boolean isDbConfigured(UserContext uc)

Description copied from interface: ISetupHandler

Methode zum Testen ob die Datenbank konfigureiert wurde

Specified by:

isDbConfigured in interface ISetupHandler

Returns:

Boolean true wenn die Datenbank bereits konfiguriert ist, sonst false

isDbUpToDate

public Boolean isDbUpToDate()

Description copied from interface: ISetupHandler

Checks whether the database is up to date

Specified by:

isDbUpToDate in interface ISetupHandler

Returns:

Boolean whether the database is up to date or not

isDbRunning

public Boolean isDbRunning()

Description copied from interface: ISetupHandler

Checks whether the database is running or not

Specified by:

isDbRunning in interface ISetupHandler

Returns:

Boolean whether the database is running or not

isUpdateNeeded

public Boolean isUpdateNeeded()

Description copied from interface: ISetupHandler

Checks whether there are updated that have not been executed yet.

Specified by:

isUpdateNeeded in interface ISetupHandler

Returns:

Boolean whether there are unperformed updates.

createManantWithDependencies

public boolean createManantWithDependencies(UserContext uc,
                                            Mandant mandant,
                                            MandantMailData mailData,
                                            String adminEmail,
                                            IUser creator)

Description copied from interface: ISetupHandler

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

Specified by:

createManantWithDependencies in interface ISetupHandler

Parameters:

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

mandant - the client

mailData - the mail data of the client

adminEmail - email address of the new client admin

creator - the user that is creating the client

Returns:

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

getAvailableLogAppenders

@Deprecated
public List<XLogAppender> getAvailableLogAppenders()

Deprecated.

Specified by:

getAvailableLogAppenders in interface ISetupHandler

createManantWithDependencies

@Deprecated
public boolean createManantWithDependencies(UserContext uc,
                                            Mandant mandant,
                                            MandantMailData mailData,
                                            MandantLdapData ldapData,
                                            Benutzer ben)

Deprecated.

Use createManantWithDependencies(UserContext, Mandant, MandantMailData, String, IUser) instead.

Specified by:

createManantWithDependencies in interface ISetupHandler

Parameters:

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

mandant - the client

mailData - the mail data of the client

ldapData - the LDAP data of the client

ben - the initial user to create

Returns:

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