com.hivemq.extensions.loader.HiveMQExtensionFactory 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

The 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.hivemq.extension.sdk.api.ExtensionMain;
import com.hivemq.extension.sdk.api.annotations.NotNull;
import com.hivemq.extensions.HiveMQExtension;
import com.hivemq.extensions.HiveMQExtensionEntity;

import java.nio.file.Path;

public interface HiveMQExtensionFactory {

    /**
     * Creates a {@link HiveMQExtension} with the following information.
     *
     * @param extensionMainInstance the instance of the extension's implementation of {@link ExtensionMain}
     * @param extensionFolder       the extension's folder
     * @param extensionConfig       the extension's configuration taken from the extension's hivemq-extension.xml
     * @param enabled               if the extension is enabled
     * @return a {@link HiveMQExtension}
     */
    @NotNull HiveMQExtension createHiveMQExtension(
            @NotNull ExtensionMain extensionMainInstance,
            @NotNull Path extensionFolder,
            @NotNull HiveMQExtensionEntity extensionConfig,
            boolean enabled);
}