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

Interface ExtensionStartInput

@Immutable
@DoNotImplement
public interface ExtensionStartInput

Input object for the start of an extension.

Since:

4.0.0, CE 2019.1

Method Summary

Modifier and Type	Method	Description
@NotNull Map<String,@NotNull ExtensionInformation>	getEnabledExtensions()
@NotNull ExtensionInformation	getExtensionInformation()
@NotNull Optional<String>	getPreviousVersion()
@NotNull ServerInformation	getServerInformation()	Get information about the HiveMQ instance the extension is running in.

Method Details

getExtensionInformation

@NotNull @NotNull ExtensionInformation getExtensionInformation()

Returns:

An ExtensionInformation containing detailed information about this extension.

Since:

4.0.0, CE 2019.1

getServerInformation

@NotNull @NotNull ServerInformation getServerInformation()

Get information about the HiveMQ instance the extension is running in.

Returns:

The ServerInformation of the input.

Since:

4.2.0, CE 2020.1

getEnabledExtensions

@NotNull @NotNull Map<String,@NotNull ExtensionInformation> getEnabledExtensions()

Returns:

A Map of all currently enabled extensions. The key is the ID of the extension. The value is a ExtensionInformation containing detailed information about each extension.

Since:

4.0.0, CE 2019.1

getPreviousVersion

@NotNull @NotNull Optional<String> getPreviousVersion()

Returns:

The previously enabled version of this extension or Optional.empty if this extension was not enabled before. An extension is identified by its ID. A previous version is only returned if this extension has been disabled at runtime. Information about previous extension versions is not retained across a server restart.

Since:

4.0.0, CE 2019.1