com.hivemq.extension.sdk.api.parameter.ExtensionStartInput Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hivemq-extension-sdk Show documentation

SDK for the development of HiveMQ extensions

There is a newer version: 4.35.0

/*
 * Copyright 2018-present HiveMQ GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.hivemq.extension.sdk.api.parameter;

import com.hivemq.extension.sdk.api.annotations.DoNotImplement;
import com.hivemq.extension.sdk.api.annotations.Immutable;
import com.hivemq.extension.sdk.api.annotations.NotNull;
import com.hivemq.extension.sdk.api.client.parameter.ServerInformation;

import java.util.Map;
import java.util.Optional;

/**
 * Input object for the start of an extension.
 *
 * @author Christoph Schäbel
 * @since 4.0.0, CE 2019.1
 */
@Immutable
@DoNotImplement
public interface ExtensionStartInput {

    /**
     * @return An {@link ExtensionInformation} containing detailed information about this extension.
     * @since 4.0.0, CE 2019.1
     */
    @NotNull ExtensionInformation getExtensionInformation();

    /**
     * Get information about the HiveMQ instance the extension is running in.
     *
     * @return The {@link ServerInformation} of the input.
     * @since 4.2.0, CE 2020.1
     */
    @NotNull ServerInformation getServerInformation();

    /**
     * @return A {@link Map} of all currently enabled extensions. The key is the ID of the extension. The value is a
     *         {@link ExtensionInformation} containing detailed information about each extension.
     * @since 4.0.0, CE 2019.1
     */
    @NotNull Map getEnabledExtensions();

    /**
     * @return 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
     */
    @NotNull Optional getPreviousVersion();
}