forked from eclipse-hono/hono-extras
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[eclipse-hono#5] Close AMQP connection when all devices are disconnec…
…ted. The MQTT endpoints are tracked for each tenant. When the last endpoint of a tenant is closed, the AMQP connection for this tenant is closed as well. Signed-off-by: Abel Buechner-Mihaljevic <[email protected]>
- Loading branch information
Showing
8 changed files
with
721 additions
and
117 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
118 changes: 118 additions & 0 deletions
118
...te/src/main/java/org/eclipse/hono/gateway/sdk/mqtt2amqp/MultiTenantConnectionManager.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,118 @@ | ||
/******************************************************************************* | ||
* Copyright (c) 2020 Contributors to the Eclipse Foundation | ||
* | ||
* See the NOTICE file(s) distributed with this work for additional | ||
* information regarding copyright ownership. | ||
* | ||
* This program and the accompanying materials are made available under the | ||
* terms of the Eclipse Public License 2.0 which is available at | ||
* http://www.eclipse.org/legal/epl-2.0 | ||
* | ||
* SPDX-License-Identifier: EPL-2.0 | ||
*******************************************************************************/ | ||
|
||
package org.eclipse.hono.gateway.sdk.mqtt2amqp; | ||
|
||
import java.util.function.Consumer; | ||
|
||
import org.apache.qpid.proton.message.Message; | ||
import org.eclipse.hono.client.MessageConsumer; | ||
import org.eclipse.hono.client.device.amqp.AmqpAdapterClientFactory; | ||
import org.eclipse.hono.client.device.amqp.CommandResponder; | ||
import org.eclipse.hono.client.device.amqp.EventSender; | ||
import org.eclipse.hono.client.device.amqp.TelemetrySender; | ||
import org.eclipse.hono.config.ClientConfigProperties; | ||
|
||
import io.vertx.core.Future; | ||
import io.vertx.core.Vertx; | ||
import io.vertx.mqtt.MqttEndpoint; | ||
|
||
/** | ||
* Manages connections for multiple tenants. | ||
*/ | ||
public interface MultiTenantConnectionManager { | ||
|
||
/** | ||
* Connect to Hono's AMQP adapter with the given configuration. | ||
* | ||
* @param tenantId The tenant to connect. | ||
* @param vertx The Vert.x instance to use for the connection. | ||
* @param clientConfig The configuration of the connection. | ||
* @return a succeeded future if the connection could be established within the time frame configured with | ||
* {@link ClientConfigProperties#getConnectTimeout()}, a failed future otherwise. | ||
*/ | ||
Future<Void> connect(String tenantId, Vertx vertx, ClientConfigProperties clientConfig); | ||
|
||
/** | ||
* Adds an MQTT endpoint for the given tenant. | ||
* | ||
* @param tenantId The tenant to which the endpoint belongs. | ||
* @param mqttEndpoint The endpoint to be added. | ||
*/ | ||
void addEndpoint(String tenantId, MqttEndpoint mqttEndpoint); | ||
|
||
/** | ||
* Closes the given MQTT endpoint and if there are no other open endpoints for this tenant, it closes the | ||
* corresponding AMQP connection. | ||
* | ||
* @param tenantId The tenant to which the endpoint belongs. | ||
* @param mqttEndpoint The endpoint to be closed. | ||
* @return {@code true} if the AMQP connection and all endpoints have been closed. | ||
*/ | ||
boolean closeEndpoint(String tenantId, MqttEndpoint mqttEndpoint); | ||
|
||
/** | ||
* Closes all connections, MQTT connections as well as AMQP for all tenants. | ||
*/ | ||
void closeAllTenants(); | ||
|
||
/** | ||
* Gets a client for sending telemetry data to Hono's AMQP protocol adapter. | ||
* | ||
* @param tenantId The tenant to which the sender belongs. | ||
* @return a future with the open sender or a failed future. | ||
* @see AmqpAdapterClientFactory#getOrCreateTelemetrySender() | ||
*/ | ||
Future<TelemetrySender> getOrCreateTelemetrySender(String tenantId); | ||
|
||
/** | ||
* Gets a client for sending events to Hono's AMQP protocol adapter. | ||
* | ||
* @param tenantId The tenant to which the sender belongs. | ||
* @return a future with the open sender or a failed future. | ||
* @see AmqpAdapterClientFactory#getOrCreateTelemetrySender() | ||
*/ | ||
Future<EventSender> getOrCreateEventSender(String tenantId); | ||
|
||
/** | ||
* Gets a client for sending command responses to Hono's AMQP protocol adapter. | ||
* | ||
* @param tenantId The tenant to which the sender belongs. | ||
* @return a future with the open sender or a failed future. | ||
* @see AmqpAdapterClientFactory#getOrCreateTelemetrySender() | ||
*/ | ||
Future<CommandResponder> getOrCreateCommandResponseSender(String tenantId); | ||
|
||
/** | ||
* Creates a client for consuming commands from Hono's AMQP protocol adapter for a specific device. | ||
* | ||
* @param tenantId The tenant to which the sender belongs. | ||
* @param deviceId The device to consume commands for. | ||
* @param messageHandler The handler to invoke with every command received. | ||
* @return a future with the open sender or a failed future. | ||
* @see AmqpAdapterClientFactory#getOrCreateTelemetrySender() | ||
*/ | ||
Future<MessageConsumer> createDeviceSpecificCommandConsumer(String tenantId, String deviceId, | ||
Consumer<Message> messageHandler); | ||
|
||
/** | ||
* Creates a client for consuming commands from Hono's AMQP protocol adapter for all devices of this tenant. | ||
* | ||
* @param tenantId The tenant to which the sender belongs. | ||
* @param messageHandler The handler to invoke with every command received. | ||
* @return a future with the open sender or a failed future. | ||
* @see AmqpAdapterClientFactory#getOrCreateTelemetrySender() | ||
*/ | ||
Future<MessageConsumer> createCommandConsumer(String tenantId, Consumer<Message> messageHandler); | ||
|
||
} |
Oops, something went wrong.