com.hivemq.extension.sdk.api.services.cluster.ClusterService 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.services.cluster;

import com.hivemq.extension.sdk.api.annotations.DoNotImplement;
import com.hivemq.extension.sdk.api.annotations.NotNull;

/**
 * Service for cluster related configuration.
 * 
 * It has the following functions:
 * 

 *   Adding and removing callbacks for discovery of HiveMQ cluster nodes
 * 
 *
 * @author Christoph Schäbel
 * @author Silvio Giebl
 * @since 4.0.0, CE 2019.1
 */
@DoNotImplement
public interface ClusterService {

    /**
     * Adds a {@link ClusterDiscoveryCallback} that will be used by HiveMQ to discover cluster nodes.
     * 
     * Note: Extension discovery is only used by HiveMQ if {@code } is set to {@code } in the
     * {@code } section of the HiveMQ config file.
     * 

     * If the given callback is already added, the callback is not added once more.
     *
     * @param clusterDiscoveryCallback The callback to add to the cluster discovery callbacks.
     * @since 4.0.0, CE 2019.1
     */
    void addDiscoveryCallback(@NotNull ClusterDiscoveryCallback clusterDiscoveryCallback);

    /**
     * Removes a {@link ClusterDiscoveryCallback} from the callbacks added by
     * {@link #addDiscoveryCallback(ClusterDiscoveryCallback)}.
     * 

     * The removed callback will not be used anymore by HiveMQ to discover cluster nodes.
     * 
     * If the given callback is not added or removed already, this method does not change anything.
     *
     * @param clusterDiscoveryCallback The callback to remove from the cluster discovery callbacks.
     * @since 4.0.0, CE 2019.1
     */
    void removeDiscoveryCallback(@NotNull ClusterDiscoveryCallback clusterDiscoveryCallback);
}