Package 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 class of setups.
Author:
XIMA MEDIA GmbH

  • Constructor Details

    • SetupAPI

      public SetupAPI()

  • Method Details

    • testConnection

      public Boolean testConnection(UserContext uc, DBConnectionData databaseData) throws ClassNotFoundException, SQLException
      Method for testing a database connection.
      Parameters:
      uc - UserContext the user context in which the action is to be performed.
      databaseData - DBConnectionData the database on which the connection should be tested.
      Returns:
      true if the connection could be made.
      Throws:
      SQLException - if a error occurs while testing the connection.
      ClassNotFoundException - if the driver couldn't found.
      Since:
      2.4.3

    • invokeLiquibaseProzess

      @Deprecated public FCMessage invokeLiquibaseProzess(UserContext uc, ELiquibaseCmd command)
      Deprecated.
      Use FormcycleUpdate instead.
      Method for executing a liquibase process.
      Parameters:
      uc - UserContext the user context in which the action is to be performed.
      command - ELiquibaseCmd the liquibase command to be executed.
      Returns:
      String the console output of the liquibase process execution.
      Since:
      2.4.3

    • isDbConfigured

      public Boolean isDbConfigured(UserContext uc)
      Method to testi if the database has been configured.
      Parameters:
      uc - UserContext the user context in which the action is to be performed.
      Returns:
      Boolean true if the database is already configured, otherwise false
      Since:
      2.4.3

    • isDBUpToDate

      public Boolean isDBUpToDate()
      Checks whether the database is up to date.
      Returns:
      Boolean whether the database is up to date or not.

    • isDbRunning

      public Boolean isDbRunning()
      Checks whether the database is running.
      Returns:
      Boolean whether the database is running or not.

    • isUpdateNeeded

      public boolean isUpdateNeeded()
      Checks whether there are updated that have not been executed yet.
      Returns:
      Boolean whether there are unperformed updates.

    • createMandantWithDependencies

      public Boolean createMandantWithDependencies(UserContext uc, Mandant client, MandantMailData mailData, String adminEmail, IUser creator)
      Method for creating a Mandant with initial configuration analogous to the setup process.
      Parameters:
      uc - UserContext the user context in which the action is to be performed.
      client - Mandant which should be created.
      mailData - MandantMailData the mail data from the client.
      adminEmail - emal address of the new client admin
      creator - the user that is creating the client.
      Returns:
      true if the client together with the initial configuration could be created successfully.
      Since:
      8.0.0

    • getAvailableLogAppenders

      @Deprecated public List<XLogAppender> getAvailableLogAppenders()
      Deprecated.

    • isValidLicense

      @Deprecated public Boolean isValidLicense()
      Deprecated.
      Method for determining if there is a valid license provided on the master server.
      Returns:
      Boolean true if the license provided on the master server is valid.

    • getLicenseType

      @Deprecated public ELizenzTyp getLicenseType()
      Deprecated.
      Returns:
      The current license type of the master server.

    • createMandantWithDependencies

      @Deprecated public Boolean createMandantWithDependencies(UserContext uc, Mandant client, MandantMailData mailData, MandantLdapData ldapData, Benutzer user)
      Deprecated.
      Use createMandantWithDependencies(UserContext, Mandant, MandantMailData, String, IUser) instead.
      Method for creating a Mandant with initial configuration analogous to the setup process.
      Parameters:
      uc - UserContext the user context in which the action is to be performed.
      client - Mandant which should be created.
      mailData - MandantMailData the mail data from the client.
      ldapData - MandantLdapData the ldap data form the client.
      user - Benutzer initial client administrator.
      Returns:
      true if the client together with the initial configuration could be created successfully.
      Since:
      2.4.3