Package com.hivemq.extension.sdk.api.client.parameter

Interface ServerInformation

  • @DoNotImplement
public interface ServerInformation
    The server information contains specific data about HiveMQ instance the extensions runs in.
    Since:
    4.0.0, CE 2019.1

    • Method Detail

      • getVersion

        @NotNull String getVersion()
        The version syntax differs depending on the HiveMQ edition in use.

        For the community edition it's "year.release-number", so for example 2019.1 (first release in 2019).

        For the enterprise edition it's "major.minor.patch", so for example 4.5.10.

        Returns:
        The version string of the HiveMQ instance.
        Since:
        4.0.0, CE 2019.1

      • getHomeFolder

        @NotNull File getHomeFolder()
        The location of the 'home' folder where HiveMQ is installed.
        Returns:
        The home folder of HiveMQ.
        Since:
        4.0.0, CE 2019.1

      • getDataFolder

        @NotNull File getDataFolder()
        The location of the 'data' folder containing the data for the HiveMQ instance.
        Returns:
        The data folder of HiveMQ.
        Since:
        4.0.0, CE 2019.1

      • getLogFolder

        @NotNull File getLogFolder()
        The location of the 'log' folder containing everything related to logs.
        Returns:
        The log folder of HiveMQ.
        Since:
        4.0.0, CE 2019.1

      • getExtensionsFolder

        @NotNull File getExtensionsFolder()
        The location of the 'extensions' folder that contains all extension.
        Returns:
        The extension folder of HiveMQ.
        Since:
        4.0.0, CE 2019.1

      • getListener

        @NotNull Set<Listener> getListener()
        All configured listeners.
        Returns:
        A set which contains a Listener instance for each configured listener.
        Since:
        4.2.0, CE 2020.1