-
Notifications
You must be signed in to change notification settings - Fork 215
/
BaseGenericMqttSubscribingClient.java
265 lines (222 loc) · 11.6 KB
/
BaseGenericMqttSubscribingClient.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
/*
* Copyright (c) 2022 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.ditto.connectivity.service.messaging.mqtt.hivemq.client;
import static org.eclipse.ditto.base.model.common.ConditionChecker.checkNotNull;
import java.util.List;
import java.util.concurrent.CompletionStage;
import java.util.stream.Collectors;
import org.eclipse.ditto.connectivity.service.messaging.mqtt.hivemq.message.connect.GenericMqttConnect;
import org.eclipse.ditto.connectivity.service.messaging.mqtt.hivemq.message.publish.GenericMqttPublish;
import org.eclipse.ditto.connectivity.service.messaging.mqtt.hivemq.message.subscribe.GenericMqttSubAck;
import org.eclipse.ditto.connectivity.service.messaging.mqtt.hivemq.message.subscribe.GenericMqttSubscribe;
import org.eclipse.ditto.connectivity.service.messaging.mqtt.hivemq.message.subscribe.GenericMqttSubscription;
import com.hivemq.client.mqtt.MqttClient;
import com.hivemq.client.mqtt.MqttGlobalPublishFilter;
import com.hivemq.client.mqtt.datatypes.MqttTopicFilter;
import com.hivemq.client.mqtt.mqtt3.Mqtt3RxClient;
import com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3SubAckException;
import com.hivemq.client.mqtt.mqtt5.Mqtt5RxClient;
import com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5SubAckException;
import io.reactivex.Flowable;
import io.reactivex.Single;
import io.reactivex.SingleTransformer;
import io.reactivex.subjects.SingleSubject;
/**
* Generic client for subscribing to topics at the MQTT broker.
*/
abstract class BaseGenericMqttSubscribingClient<C extends MqttClient>
implements GenericMqttConnectableClient, GenericMqttSubscribingClient {
private final C mqttClient;
private final GenericMqttConnectableClient connectingClient;
private final ClientRole clientRole;
private BaseGenericMqttSubscribingClient(final C mqttClient,
final GenericMqttConnectableClient connectingClient,
final ClientRole clientRole) {
this.mqttClient = mqttClient;
this.connectingClient = connectingClient;
this.clientRole = checkNotNull(clientRole, "clientRole");
}
/**
* Returns an instance of {@code BaseGenericMqttSubscribingClient} that operates on the specified
* {@code Mqtt3RxClient} argument.
*
* @param mqtt3RxClient the MQTT client for subscribing to topics.
* @return the instance.
* @throws NullPointerException if {@code mqtt3AsyncClient} is {@code null}.
*/
static BaseGenericMqttSubscribingClient<Mqtt3RxClient> ofMqtt3RxClient(final Mqtt3RxClient mqtt3RxClient,
final ClientRole clientRole) {
checkNotNull(mqtt3RxClient, "mqtt3RxClient");
return new Mqtt3RxSubscribingClient(mqtt3RxClient,
BaseGenericMqttConnectableClient.ofMqtt3AsyncClient(mqtt3RxClient.toAsync()),
clientRole);
}
/**
* Returns an instance of {@code BaseGenericMqttSubscribingClient} that operates on the specified
* {@code Mqtt5RxClient} argument.
*
* @param mqtt5RxClient the MQTT client for subscribing to topics.
* @return the instance.
* @throws NullPointerException if {@code mqtt5RxClient} is {@code null}.
*/
static BaseGenericMqttSubscribingClient<Mqtt5RxClient> ofMqtt5RxClient(final Mqtt5RxClient mqtt5RxClient,
final ClientRole clientRole) {
checkNotNull(mqtt5RxClient, "mqtt5RxClient");
return new Mqtt5RxSubscribingClient(mqtt5RxClient,
BaseGenericMqttConnectableClient.ofMqtt5AsyncClient(mqtt5RxClient.toAsync()),
clientRole);
}
@Override
public Single<GenericMqttSubAck> subscribe(final GenericMqttSubscribe genericMqttSubscribe) {
// Error handling is already done by implementations of BaseGenericMqttConnectingClient.
return sendSubscribe(mqttClient, checkNotNull(genericMqttSubscribe, "genericMqttSubscribe"))
.compose(handleFailedSubscriptions(genericMqttSubscribe));
}
protected abstract Single<GenericMqttSubAck> sendSubscribe(C mqttClient, GenericMqttSubscribe genericMqttSubscribe);
private static SingleTransformer<GenericMqttSubAck, GenericMqttSubAck> handleFailedSubscriptions(
final GenericMqttSubscribe genericMqttSubscribe
) {
return upstream -> {
final Single<GenericMqttSubAck> result;
final var singleSubject = SingleSubject.<GenericMqttSubAck>create();
upstream.subscribe(singleSubject);
if (singleSubject.hasValue()) {
final var genericMqttSubAck = singleSubject.getValue();
final var failedSubscriptions = getFailedSubscriptionStatuses(genericMqttSubAck,
getSubscriptionTopicFilters(genericMqttSubscribe));
if (failedSubscriptions.isEmpty()) {
result = Single.just(genericMqttSubAck);
} else {
/*
* The assumption that only some subscriptions failed is
* correct here.
* If all subscriptions failed then, according to
* HiveMQ API doc, the stream would have failed which would
* be handled in branch "onErrorResumeNext" in the specific
* protocol version client implementation.
*/
result = Single.error(new SomeSubscriptionsFailedException(failedSubscriptions));
}
} else if (singleSubject.hasThrowable()) {
result = Single.error(singleSubject.getThrowable());
} else {
// When can this case even happen?
result = upstream;
}
return result;
};
}
private static List<MqttTopicFilter> getSubscriptionTopicFilters(final GenericMqttSubscribe genericMqttSubscribe) {
return genericMqttSubscribe.genericMqttSubscriptions()
.map(GenericMqttSubscription::getMqttTopicFilter)
.collect(Collectors.toList());
}
private static List<SubscriptionStatus> getFailedSubscriptionStatuses(
final GenericMqttSubAck genericMqttSubAck,
final List<MqttTopicFilter> subscriptionTopicFilters
) {
return Zipper.zipIterables(subscriptionTopicFilters, genericMqttSubAck.getGenericMqttSubAckStatuses())
.filter(zip -> zip.b().isError())
.map(zip -> SubscriptionStatus.newInstance(zip.a(), zip.b()))
.collect(Collectors.toList());
}
@Override
public Flowable<GenericMqttPublish> consumeSubscribedPublishesWithManualAcknowledgement() {
return consumeIncomingPublishes(mqttClient, MqttGlobalPublishFilter.SUBSCRIBED, true);
}
protected abstract Flowable<GenericMqttPublish> consumeIncomingPublishes(C mqttClient,
MqttGlobalPublishFilter filter,
boolean manualAcknowledgement);
@Override
public CompletionStage<Void> connect(final GenericMqttConnect genericMqttConnect) {
return connectingClient.connect(genericMqttConnect);
}
@Override
public CompletionStage<Void> disconnect() {
return connectingClient.disconnect();
}
@Override
public String toString() {
final var mqttClientConfig = mqttClient.getConfig();
return clientRole +
mqttClientConfig.getClientIdentifier().map(clientIdentifier -> ":" + clientIdentifier).orElse("");
}
private static final class Mqtt3RxSubscribingClient extends BaseGenericMqttSubscribingClient<Mqtt3RxClient> {
private Mqtt3RxSubscribingClient(final Mqtt3RxClient mqtt3RxClient,
final GenericMqttConnectableClient genericMqttConnectingClient,
final ClientRole clientRole) {
super(mqtt3RxClient, genericMqttConnectingClient, clientRole);
}
@Override
protected Single<GenericMqttSubAck> sendSubscribe(final Mqtt3RxClient mqtt3RxClient,
final GenericMqttSubscribe genericMqttSubscribe) {
return mqtt3RxClient.subscribe(genericMqttSubscribe.getAsMqtt3Subscribe())
.map(GenericMqttSubAck::ofMqtt3SubAck)
.onErrorResumeNext(error -> {
final Single<GenericMqttSubAck> result;
if (error instanceof Mqtt3SubAckException mqtt3SubAckException) {
result = Single.error(new AllSubscriptionsFailedException(
getFailedSubscriptionStatuses(
GenericMqttSubAck.ofMqtt3SubAck(mqtt3SubAckException.getMqttMessage()),
getSubscriptionTopicFilters(genericMqttSubscribe)
),
mqtt3SubAckException
));
} else {
result = Single.error(new MqttSubscribeException(error));
}
return result;
});
}
@Override
protected Flowable<GenericMqttPublish> consumeIncomingPublishes(final Mqtt3RxClient mqtt3RxClient,
final MqttGlobalPublishFilter filter,
final boolean manualAcknowledgement) {
return mqtt3RxClient.publishes(filter, manualAcknowledgement).map(GenericMqttPublish::ofMqtt3Publish);
}
}
private static final class Mqtt5RxSubscribingClient extends BaseGenericMqttSubscribingClient<Mqtt5RxClient> {
private Mqtt5RxSubscribingClient(final Mqtt5RxClient mqtt5RxClient,
final GenericMqttConnectableClient genericMqttConnectingClient,
final ClientRole clientRole) {
super(mqtt5RxClient, genericMqttConnectingClient, clientRole);
}
@Override
protected Single<GenericMqttSubAck> sendSubscribe(final Mqtt5RxClient mqtt5RxClient,
final GenericMqttSubscribe genericMqttSubscribe) {
return mqtt5RxClient.subscribe(genericMqttSubscribe.getAsMqtt5Subscribe())
.map(GenericMqttSubAck::ofMqtt5SubAck)
.onErrorResumeNext(error -> {
final Single<GenericMqttSubAck> result;
if (error instanceof Mqtt5SubAckException mqtt5SubAckException) {
result = Single.error(new AllSubscriptionsFailedException(
getFailedSubscriptionStatuses(
GenericMqttSubAck.ofMqtt5SubAck(mqtt5SubAckException.getMqttMessage()),
getSubscriptionTopicFilters(genericMqttSubscribe)
),
mqtt5SubAckException
));
} else {
result = Single.error(new MqttSubscribeException(error));
}
return result;
});
}
@Override
protected Flowable<GenericMqttPublish> consumeIncomingPublishes(final Mqtt5RxClient mqtt5RxClient,
final MqttGlobalPublishFilter filter,
final boolean manualAcknowledgement) {
return mqtt5RxClient.publishes(filter, manualAcknowledgement).map(GenericMqttPublish::ofMqtt5Publish);
}
}
}