com.hivemq.extensions.loader.ExtensionLifecycleHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hivemq-community-edition-embedded Show documentation

HiveMQ CE is a Java-based open source MQTT broker that fully supports MQTT 3.x and MQTT 5

There is a newer version: 2025.1

Show newest version

/*
 * Copyright 2019-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.extensions.loader;

import com.google.common.collect.ImmutableCollection;
import com.hivemq.extension.sdk.api.annotations.NotNull;
import com.hivemq.extensions.HiveMQExtensionEvent;

import java.util.concurrent.CompletableFuture;

public interface ExtensionLifecycleHandler {

    /**
     * Handles extension En-/Disable events and calls the extension's start or stop methods if needed.
     *
     * @param hiveMQExtensionEvents {@link ImmutableCollection} of {@link HiveMQExtensionEvent}s which should be
     *                              processed.
     */
    @NotNull CompletableFuture handleExtensionEvents(@NotNull ImmutableCollection hiveMQExtensionEvents);
}