Package de.espirit.firstspirit.module

Interface ServerEnvironment

All Known Subinterfaces:
ProjectEnvironment, WebEnvironment
public interface ServerEnvironment
Environment definition for server operations.
Since:
4.2.2

  • Method Details

    • getConfDir

      @NotNull @NotNull FileSystem<? extends FileHandle> getConfDir()
      Returns the configuration directory of this environment.
      Returns:
      configuration directory of this environment.
      Since:
      4.1

    • getDataDir

      @Nullable @Nullable FileSystem<? extends FileHandle> getDataDir()
      Returns the data directory of this environment.
      Components which uses this environment should store their data files in this directory.
      Returns:
      data directory of this environment
      Since:
      4.1

    • getLogDir

      @Nullable @Nullable FileSystem<? extends FileHandle> getLogDir()
      Returns the FileSystem as access to the log directory of this environment.
      Components which uses this environment should store their log files in this directory.
      Returns:
      the FileSystem as access to the log directory of this environment
      Since:
      4.1

    • getConnection

      Connection getConnection()
      Returns the connection.
      Returns:
      connection
      Since:
      4.1

    • getBroker

      SpecialistsBroker getBroker()
      Provides access to a specialists broker.
      Returns:
      the specialist broker of this environment.
      Since:
      5.0.100

    • getScope

      ComponentDescriptor.Scope getScope()
      Returns the scope, one of ComponentDescriptor.Scope.SERVER, ComponentDescriptor.Scope.PROJECT, and ComponentDescriptor.Scope.WEB.
      Returns:
      scope
      Since:
      4.1

    • getInstalledVersion

      @Nullable @Nullable String getInstalledVersion()
      Returns the installed version of the component.
      Returns:
      installed version string of the component or null if the component is not installed.
      Since:
      4.1.44