-
Notifications
You must be signed in to change notification settings - Fork 215
/
HiveMqttClientProperties.java
218 lines (187 loc) · 8.27 KB
/
HiveMqttClientProperties.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
/*
* 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.Optional;
import java.util.UUID;
import java.util.function.Supplier;
import org.eclipse.ditto.connectivity.model.Connection;
import org.eclipse.ditto.connectivity.model.ConnectionId;
import org.eclipse.ditto.connectivity.model.ConnectionType;
import org.eclipse.ditto.connectivity.service.config.ConnectivityConfig;
import org.eclipse.ditto.connectivity.service.config.MqttConfig;
import org.eclipse.ditto.connectivity.service.messaging.monitoring.logs.ConnectionLogger;
import org.eclipse.ditto.connectivity.service.messaging.mqtt.MqttSpecificConfig;
import org.eclipse.ditto.connectivity.service.messaging.tunnel.SshTunnelState;
/**
* Properties which are required for creating a HiveMQ MQTT client.
*/
public final class HiveMqttClientProperties {
private final Connection mqttConnection;
private final ConnectivityConfig connectivityConfig;
private final MqttConfig mqttConfig;
private final MqttSpecificConfig mqttSpecificConfig;
private final Supplier<SshTunnelState> sshTunnelStateSupplier;
private final ConnectionLogger connectionLogger;
private final GenericMqttClientConnectedListener mqttClientConnectedListener;
private final GenericMqttClientDisconnectedListener mqttClientDisconnectedListener;
private final UUID actorUuid;
private HiveMqttClientProperties(final Builder builder) {
mqttConnection = builder.mqttConnection;
connectivityConfig = builder.connectivityConfig;
mqttConfig = connectivityConfig.getConnectionConfig().getMqttConfig();
mqttSpecificConfig = builder.mqttSpecificConfig;
sshTunnelStateSupplier = builder.sshTunnelStateSupplier;
connectionLogger = builder.connectionLogger;
mqttClientConnectedListener = builder.mqttClientConnectedListener;
mqttClientDisconnectedListener = builder.mqttClientDisconnectedListener;
actorUuid = builder.actorUuid;
}
/**
* Returns a new builder with a fluent API for constructing a {@code HiveMqttClientProperties} object.
*
* @return the new builder instance.
* {@link ConnectionType#MQTT_5}.
*/
public static HiveMqttClientPropertiesStepBuilder.MqttConnectionStep builder() {
return new Builder();
}
public MqttSpecificConfig getMqttSpecificConfig() {
return mqttSpecificConfig;
}
public UUID getActorUuid() {
return actorUuid;
}
/**
* Returns the optional SSH tunnel state.
*
* @return the SSH tunnel state or an empty Optional if the SSH tunnel state supplier returns {@code null}.
*/
public Optional<SshTunnelState> getSshTunnelState() {
return Optional.ofNullable(sshTunnelStateSupplier.get());
}
public MqttConfig getMqttConfig() {
return mqttConfig;
}
/**
* Returns the MQTT connection.
* The type of the returned connection is guaranteed to be either {@link ConnectionType#MQTT} or
* {@link ConnectionType#MQTT_5}.
*
* @return the MQTT connection.
*/
public Connection getMqttConnection() {
return mqttConnection;
}
public ConnectionId getConnectionId() {
return mqttConnection.getId();
}
public ConnectionLogger getConnectionLogger() {
return connectionLogger;
}
public GenericMqttClientConnectedListener getMqttClientConnectedListener() {
return mqttClientConnectedListener;
}
public GenericMqttClientDisconnectedListener getMqttClientDisconnectedListener() {
return mqttClientDisconnectedListener;
}
public ConnectivityConfig getConnectivityConfig() {
return connectivityConfig;
}
private static final class Builder implements HiveMqttClientPropertiesStepBuilder.MqttConnectionStep,
HiveMqttClientPropertiesStepBuilder.ConnectivityConfigStep,
HiveMqttClientPropertiesStepBuilder.MqttSpecificConfigStep,
HiveMqttClientPropertiesStepBuilder.SshTunnelStateSupplierStep,
HiveMqttClientPropertiesStepBuilder.ConnectionLoggerStep,
HiveMqttClientPropertiesStepBuilder.ActorUuidStep,
HiveMqttClientPropertiesStepBuilder.BuildableStep {
private Connection mqttConnection;
private ConnectivityConfig connectivityConfig;
private MqttSpecificConfig mqttSpecificConfig;
private Supplier<SshTunnelState> sshTunnelStateSupplier;
private ConnectionLogger connectionLogger;
private GenericMqttClientConnectedListener mqttClientConnectedListener;
private GenericMqttClientDisconnectedListener mqttClientDisconnectedListener;
private UUID actorUuid;
private Builder() {
mqttConnection = null;
connectivityConfig = null;
mqttSpecificConfig = null;
sshTunnelStateSupplier = null;
connectionLogger = null;
mqttClientConnectedListener = (context, clientRole) -> {/* Do nothing.*/};
mqttClientDisconnectedListener = (context, clientRole) -> {/* Do nothing.*/};
actorUuid = null;
}
@Override
public HiveMqttClientPropertiesStepBuilder.ConnectivityConfigStep withMqttConnection(
final Connection mqttConnection
) throws NoMqttConnectionException {
MqttConnectionTypeValidator.assertThatMqttConnectionType(mqttConnection);
this.mqttConnection = mqttConnection;
return this;
}
@Override
public HiveMqttClientPropertiesStepBuilder.MqttSpecificConfigStep withConnectivityConfig(
final ConnectivityConfig connectivityConfig
) {
this.connectivityConfig = checkNotNull(connectivityConfig, "connectivityConfig");
return this;
}
@Override
public HiveMqttClientPropertiesStepBuilder.SshTunnelStateSupplierStep withMqttSpecificConfig(
final MqttSpecificConfig mqttSpecificConfig
) {
this.mqttSpecificConfig = checkNotNull(mqttSpecificConfig, "mqttSpecificConfig");
return this;
}
@Override
public HiveMqttClientPropertiesStepBuilder.ConnectionLoggerStep withSshTunnelStateSupplier(
final Supplier<SshTunnelState> sshTunnelStateSupplier
) {
this.sshTunnelStateSupplier = checkNotNull(sshTunnelStateSupplier, "sshTunnelStateSupplier");
return this;
}
@Override
public HiveMqttClientPropertiesStepBuilder.ActorUuidStep withConnectionLogger(
final ConnectionLogger connectionLogger
) {
this.connectionLogger = checkNotNull(connectionLogger, "connectionLogger");
return this;
}
@Override
public HiveMqttClientPropertiesStepBuilder.BuildableStep withActorUuid(final UUID actorUuid) {
this.actorUuid = checkNotNull(actorUuid, "actorUuid");
return this;
}
@Override
public HiveMqttClientPropertiesStepBuilder.BuildableStep withClientConnectedListener(
final GenericMqttClientConnectedListener mqttClientConnectedListener
) {
this.mqttClientConnectedListener = checkNotNull(mqttClientConnectedListener, "mqttClientConnectedListener");
return this;
}
@Override
public HiveMqttClientPropertiesStepBuilder.BuildableStep withClientDisconnectedListener(
final GenericMqttClientDisconnectedListener mqttClientDisconnectedListener
) {
this.mqttClientDisconnectedListener =
checkNotNull(mqttClientDisconnectedListener, "mqttClientDisconnectedListener");
return this;
}
@Override
public HiveMqttClientProperties build() {
return new HiveMqttClientProperties(this);
}
}
}