Class SetupAPI


  • public class SetupAPI
    extends ASubAPI
    API class of setups.
    Author:
    XIMA MEDIA GmbH
    • Constructor Detail

      • SetupAPI

        public SetupAPI()
    • Method Detail

      • 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.
      • createMandantWithDependencies

        public Boolean createMandantWithDependencies​(UserContext uc,
                                                     Mandant client,
                                                     MandantMailData mailData,
                                                     MandantLdapData ldapData,
                                                     Benutzer user)
        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
      • getAvailableLogAppenders

        public List<XLogAppender> getAvailableLogAppenders()
      • 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.