com.hivemq.spi.services

Interface BridgeManagerService

Deprecated.

IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x

@Deprecated
public interface BridgeManagerService

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.

Since:

2.0

Author:

Dominik Obermaier

Method Summary

Methods

Modifier and Type	Method and Description
void	addBridge(Bridge bridge) Deprecated. IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x
com.google.common.base.Optional<State>	getBridgeState(Bridge bridge) Deprecated. IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x
Collection<Bridge>	listBridges() Deprecated. IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x
void	removeBridge(Bridge bridge) Deprecated. IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x
com.google.common.util.concurrent.ListenableFuture<Void>	startBridge(Bridge bridge) Deprecated. IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x
com.google.common.util.concurrent.ListenableFuture<List<Void>>	stopAllBridges() Deprecated. IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x
com.google.common.util.concurrent.ListenableFuture<Void>	stopBridge(Bridge bridge) Deprecated. IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x

Method Detail

addBridge

@Deprecated
void addBridge(Bridge bridge)

Deprecated. IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x

Adds a new Bridge to the bridge manager. The bridge won't be started but can be listed.

Parameters:

bridge - the bridge to add to the bridge manager.

removeBridge

@Deprecated
void removeBridge(Bridge bridge)

Deprecated. IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x

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.

Parameters:

bridge - the bridge to stop (if running) and remove

startBridge

@Deprecated
com.google.common.util.concurrent.ListenableFuture<Void> startBridge(Bridge bridge)

Deprecated. IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x

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 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.

Parameters:

bridge - the bridge to start

Returns:

a ListenableFuture which you can use to block or use to react when the bridge started

stopBridge

@Deprecated
com.google.common.util.concurrent.ListenableFuture<Void> stopBridge(Bridge bridge)

Deprecated. IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x

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 ListenableFuture to decide if you want to block until the bridge is stopped or if you want to use a reactive programming pattern.

Parameters:

bridge - the bridge to stop

Returns:

a ListenableFuture which you can use to block or use to react when the bridge stopped

listBridges

@Deprecated
Collection<Bridge> listBridges()

Deprecated. IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x

Returns a Collection of all bridges registered to this bridge manager.

Returns:

a Collection of all bridges registered to this bridge manager

stopAllBridges

@Deprecated
com.google.common.util.concurrent.ListenableFuture<List<Void>> stopAllBridges()

Deprecated. IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x

Stops all bridges. This method does not remove bridges from the bridge manager.

This method stops the bridges asynchronously. You can use the returned ListenableFuture to decide if you want to block until all bridges are stopped or if you want to use a reactive programming pattern.

Returns:

a ListenableFuture which you can use to block or use to react when all bridges are stopped

getBridgeState

@Deprecated
com.google.common.base.Optional<State> getBridgeState(Bridge bridge)

Deprecated. IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x

Returns the state of a given bridge. If the passed bridge does not exist, an Optional with an absent value will be returned

Parameters:

bridge - the bridge to check the state for.

Returns:

a Optional with the state for a bridge.