com.hivemq.spi.services.BridgeManagerService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hivemq-spi Show documentation
The Service Provider Interfaces for developing HiveMQ plugins.
There is a newer version: 3.4.4
/*
 * Copyright 2014 dc-square 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.spi.services;

import com.google.common.base.Optional;
import com.google.common.util.concurrent.ListenableFuture;
import com.hivemq.spi.bridge.Bridge;
import com.hivemq.spi.bridge.State;

import java.util.Collection;
import java.util.List;

/**
 * The Bridge Manager Service which can be used to
 * add, start, stop, remove and list bridge information at runtime
 * 
 * While typically HiveMQ bridges are configured in a bridge.xml file,
 * it is entirely possible to write an own bridge configuration mechanism with that
 * manager in your plugin.
 * 

 *
 * @author Dominik Obermaier
 * @since 2.0
 * @deprecated IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x
 */
@Deprecated
public interface BridgeManagerService {

    /**
     * Adds a new {@link Bridge} to the bridge manager. The bridge won't be started
     * but can be listed.
     *
     * @param bridge the bridge to add to the bridge manager.
     * @deprecated IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x
     */
    @Deprecated
    void addBridge(final Bridge bridge);

    /**
     * Removes a bridge from the bridge manager. If the bridge to remove
     * is running, it will be stopped and terminated before it is removed.
     * Please note, that this method will block until the bridge is terminated.
     * If you want to stop the bridge asynchronously, consider using the stopBridge
     * method before removing the bridge.
     * 

     * If the passed bridge to remove doesn't exist, nothing will happen.
     *
     * @param bridge the bridge to stop (if running) and remove
     * @deprecated IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x
     */
    @Deprecated
    void removeBridge(final Bridge bridge);

    /**
     * Starts a bridge. If the bridge wasn't added to the manager before,
     * it will be added automatically.
     * 

     * This method starts the bridge asynchronously. You can use the returned
     * {@link ListenableFuture} to decide if you want to block until the bridge is started
     * or if you want to use a reactive programming pattern.
     * 

     * Note, that you can start a LAZY bridge manually with this method without waiting for
     * passing the configured threshold. Also, you can reconnect disconnected bridges with
     * bridge mode ONCE.
     *
     * @param bridge the bridge to start
     * @return a {@link ListenableFuture} which you can use to block or use to react
     * when the bridge started
     * @deprecated IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x
     */
    @Deprecated
    ListenableFuture startBridge(final Bridge bridge);

    /**
     * Stops a bridge. This method does not remove a bridge from the bridge manager.
     * If you would like to get the bridge also removed from the bridge manager, consider
     * using the removeBridge method.
     * 

     * This method stops the bridge asynchronously. You can use the returned
     * {@link ListenableFuture} to decide if you want to block until the bridge is stopped
     * or if you want to use a reactive programming pattern.
     *
     * @param bridge the bridge to stop
     * @return a {@link ListenableFuture} which you can use to block or use to react
     * when the bridge stopped
     * @deprecated IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x
     */
    @Deprecated
    ListenableFuture stopBridge(final Bridge bridge);

    /**
     * Returns a {@link Collection} of all bridges registered to this bridge manager.
     *
     * @return a {@link Collection} of all bridges registered to this bridge manager
     * @deprecated IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x
     */
    @Deprecated
    Collection listBridges();

    /**
     * Stops all bridges. This method does not remove bridges from the bridge manager.
     * 
     * This method stops the bridges asynchronously. You can use the returned
     * {@link ListenableFuture} to decide if you want to block until all bridges are stopped
     * or if you want to use a reactive programming pattern.
     *
     * @return a {@link ListenableFuture} which you can use to block or use to react
     * when all bridges are stopped
     * @deprecated IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x
     */
    @Deprecated
    ListenableFuture> stopAllBridges();

    /**
     * Returns the state of a given bridge. If the passed bridge does not exist,
     * an Optional with an absent value will be returned
     *
     * @param bridge the bridge to check the state for.
     * @return a {@link Optional} with the state for a bridge.
     * @deprecated IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x
     */
    @Deprecated
    Optional getBridgeState(final Bridge bridge);
}