Package pl.edu.icm.unity.engine.api

Interface ServerManagement

  • public interface ServerManagement
    Provides access to general maintenance operations.
    Author:
    K. Benedyczak

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.io.File exportDb​(pl.edu.icm.unity.types.basic.DBDumpContentElements content)
      Exports database contents to a JSON file.
      void importDb​(java.io.File from)
      Imports the whole database from a given JSON file
      java.lang.String loadConfigurationFile​(java.lang.String path)
      Load configuration file
      void reloadConfig()
      Reload main configuration file if changed
      void resetDatabase()
      Removes the whole contents of the database and initializes it from scratch.

    • Method Detail

      • resetDatabase

        void resetDatabase()
            throws pl.edu.icm.unity.exceptions.EngineException
        Removes the whole contents of the database and initializes it from scratch.
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • exportDb

        java.io.File exportDb​(pl.edu.icm.unity.types.basic.DBDumpContentElements content)
               throws pl.edu.icm.unity.exceptions.EngineException
        Exports database contents to a JSON file.
        Parameters:
        content - dump content type
        Returns:
        the file reference
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • importDb

        void importDb​(java.io.File from)
       throws pl.edu.icm.unity.exceptions.EngineException
        Imports the whole database from a given JSON file
        Parameters:
        from - file to load data from
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • reloadConfig

        void reloadConfig()
           throws pl.edu.icm.unity.exceptions.EngineException
        Reload main configuration file if changed
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • loadConfigurationFile

        java.lang.String loadConfigurationFile​(java.lang.String path)
                                throws pl.edu.icm.unity.exceptions.EngineException
        Load configuration file
        Throws:
        pl.edu.icm.unity.exceptions.EngineException