-
Notifications
You must be signed in to change notification settings - Fork 215
/
BaseClientData.java
402 lines (352 loc) · 15.6 KB
/
BaseClientData.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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
/*
* Copyright (c) 2017 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;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import org.eclipse.ditto.base.model.headers.DittoHeaders;
import org.eclipse.ditto.connectivity.model.Connection;
import org.eclipse.ditto.connectivity.model.ConnectionId;
import org.eclipse.ditto.connectivity.model.ConnectivityStatus;
import org.eclipse.ditto.connectivity.model.RecoveryStatus;
import org.eclipse.ditto.connectivity.service.messaging.tunnel.SshTunnelState;
import akka.actor.ActorRef;
import akka.japi.Pair;
/**
* The data the {@link BaseClientActor} has in its different {@link org.eclipse.ditto.connectivity.api.BaseClientState States}.
*/
@Immutable
public final class BaseClientData {
private final ConnectionId connectionId;
private final Connection connection;
private final ConnectivityStatus connectionStatus;
private final RecoveryStatus recoveryStatus;
private final ConnectivityStatus desiredConnectionStatus;
@Nullable private final String connectionStatusDetails;
private final Instant inConnectionStatusSince;
private final int failureCount;
private final List<Pair<ActorRef, DittoHeaders>> sessionSenders;
private final SshTunnelState sshTunnelState;
/**
* Constructs new instance of BaseClientData, the data of the {@link BaseClientActor}.
* @param connectionId the ID of the {@link org.eclipse.ditto.connectivity.model.Connection}.
* @param connection the optional {@link org.eclipse.ditto.connectivity.model.Connection}.
* @param connectionStatus the current {@link org.eclipse.ditto.connectivity.model.ConnectivityStatus} of the Connection.
* @param recoveryStatus the current {@link org.eclipse.ditto.connectivity.model.RecoveryStatus} of the Connection.
* @param desiredConnectionStatus the desired {@link org.eclipse.ditto.connectivity.model.ConnectivityStatus} of the Connection.
* @param connectionStatusDetails the optional details about the ConnectionStatus.
* @param inConnectionStatusSince the instant since when the Client is in its current ConnectionStatus.
* @param failureCount counts failures recived while backing off in connecting state
*/
private BaseClientData(final ConnectionId connectionId, final Connection connection,
final ConnectivityStatus connectionStatus,
final RecoveryStatus recoveryStatus,
final ConnectivityStatus desiredConnectionStatus,
@Nullable final String connectionStatusDetails,
final Instant inConnectionStatusSince,
final List<Pair<ActorRef, DittoHeaders>> sessionSenders,
final SshTunnelState sshTunnelState,
final int failureCount) {
this.connectionId = connectionId;
this.connection = connection;
this.connectionStatus = connectionStatus;
this.recoveryStatus = recoveryStatus;
this.desiredConnectionStatus = desiredConnectionStatus;
this.connectionStatusDetails = connectionStatusDetails;
this.inConnectionStatusSince = inConnectionStatusSince;
this.sessionSenders = List.copyOf(sessionSenders);
this.sshTunnelState = sshTunnelState;
this.failureCount = failureCount;
}
/**
* @return the ID of the connection
*/
public ConnectionId getConnectionId() {
return connectionId;
}
/**
* @return the managed connection
*/
public Connection getConnection() {
return connection;
}
/**
* @return the current connection status
*/
public ConnectivityStatus getConnectionStatus() {
return connectionStatus;
}
/**
* @return the current recovery status
*/
public RecoveryStatus getRecoveryStatus() {
return recoveryStatus;
}
/**
* @return the desired connection status
*/
ConnectivityStatus getDesiredConnectionStatus() {
return desiredConnectionStatus;
}
/**
* @return the details description about the current connection status
*/
Optional<String> getConnectionStatusDetails() {
return Optional.ofNullable(connectionStatusDetails);
}
/**
* @return the time since when the connection is in the current status
*/
Instant getInConnectionStatusSince() {
return inConnectionStatusSince;
}
/**
* @return the Pairs of session senders (including DittoHeaders per sender ActorRef)
*/
List<Pair<ActorRef, DittoHeaders>> getSessionSenders() {
return sessionSenders;
}
/**
* @return the holder for the state of the ssh tunnel (enabled, established, failed, ...)
*/
SshTunnelState getSshTunnelState() {
return sshTunnelState;
}
BaseClientData setSshTunnelState(final SshTunnelState sshTunnelState) {
return BaseClientDataBuilder.from(this).setSshTunnelState(sshTunnelState).build();
}
/**
* Updates the managed connection returning a new instance of BaseClientData.
*
* @param connection the new connection to use
* @return the new instance of BaseClientData
*/
public BaseClientData setConnection(final Connection connection) {
return BaseClientDataBuilder.from(this).setConnection(connection).build();
}
/**
* Updates the current connection status returning a new instance of BaseClientData.
*
* @param connectionStatus the new connection status to use
* @return the new instance of BaseClientData
*/
public BaseClientData setConnectionStatus(final ConnectivityStatus connectionStatus) {
return BaseClientDataBuilder.from(this).setConnectionStatus(connectionStatus).build();
}
/**
* Updates the current recovery status returning a new instance of BaseClientData.
*
* @param recoveryStatus the new recovery status to use
* @return the new instance of BaseClientData
*/
public BaseClientData setRecoveryStatus(final RecoveryStatus recoveryStatus) {
return BaseClientDataBuilder.from(this).setRecoveryStatus(recoveryStatus).build();
}
/**
* Updates the desired connection status returning a new instance of BaseClientData.
*
* @param desiredConnectionStatus the new desired connection status to use
* @return the new instance of BaseClientData
*/
BaseClientData setDesiredConnectionStatus(final ConnectivityStatus desiredConnectionStatus) {
return BaseClientDataBuilder.from(this).setDesiredConnectionStatus(desiredConnectionStatus).build();
}
public BaseClientData setConnectionStatusDetails(@Nullable final String connectionStatusDetails) {
return BaseClientDataBuilder.from(this).setConnectionStatusDetails(connectionStatusDetails).build();
}
/**
* Adds the passed {@code origin} sender with the passed {@code dittoHeaders} to the managed {@code sessionSenders}
* returning a new instance of BaseClientData.
*
* @param origin the sender to add
* @param dittoHeaders the DittoHeaders to add for the passed sender
* @return the new instance of BaseClientData
*/
BaseClientData addSessionSender(@Nullable final ActorRef origin, final DittoHeaders dittoHeaders) {
if (origin != null) {
final List<Pair<ActorRef, DittoHeaders>> newSessionSenders = new ArrayList<>(sessionSenders);
newSessionSenders.add(Pair.create(origin, dittoHeaders));
return BaseClientDataBuilder.from(this).setSessionSenders(newSessionSenders).build();
} else {
return this;
}
}
/**
* Remove info related to the last command. Should be called when entering a stable state (UNKNOWN, CONNECTED,
* DISCONNECTED).
*
* @return data without info related to the last command.
*/
BaseClientData resetSession() {
return BaseClientDataBuilder.from(this).setSessionSenders(Collections.emptyList()).build();
}
/**
* Increases the failure count by one.
*
* @return the new instance of BaseClientData
*/
BaseClientData increaseFailureCount() {
return BaseClientDataBuilder.from(this).setFailureCount(failureCount + 1).build();
}
/**
* @return the current failure count
*/
int getFailureCount() {
return failureCount;
}
/**
* Resets the failure count to zero.
*
* @return the new instance of BaseClientData
*/
BaseClientData resetFailureCount() {
return BaseClientDataBuilder.from(this).setFailureCount(0).build();
}
@Override
public boolean equals(final Object o) {
if (this == o) {return true;}
if (!(o instanceof BaseClientData)) {return false;}
final BaseClientData that = (BaseClientData) o;
return Objects.equals(connectionId, that.connectionId) &&
Objects.equals(connection, that.connection) &&
connectionStatus == that.connectionStatus &&
recoveryStatus == that.recoveryStatus &&
desiredConnectionStatus == that.desiredConnectionStatus &&
Objects.equals(connectionStatusDetails, that.connectionStatusDetails) &&
Objects.equals(inConnectionStatusSince, that.inConnectionStatusSince) &&
Objects.equals(sessionSenders, that.sessionSenders) &&
Objects.equals(sshTunnelState, that.sshTunnelState) &&
Objects.equals(failureCount, that.failureCount);
}
@Override
public int hashCode() {
return Objects.hash(connectionId, connection, connectionStatus, recoveryStatus, desiredConnectionStatus,
connectionStatusDetails, inConnectionStatusSince, sessionSenders, sshTunnelState, failureCount);
}
@Override
public String toString() {
return getClass().getSimpleName() + " [" +
"connectionId=" + connectionId +
", connection=" + connection +
", connectionStatus=" + connectionStatus +
", recoveryStatus=" + recoveryStatus +
", desiredConnectionStatus=" + desiredConnectionStatus +
", connectionStatusDetails=" + connectionStatusDetails +
", inConnectionStatusSince=" + inConnectionStatusSince +
", sessionSenders=" + sessionSenders +
", sshTunnelState=" + sshTunnelState +
", failureCount=" + failureCount +
"]";
}
static final class BaseClientDataBuilder {
private ConnectionId connectionId;
private Connection connection;
private ConnectivityStatus connectionStatus;
private RecoveryStatus recoveryStatus;
private ConnectivityStatus desiredConnectionStatus;
private String connectionStatusDetails;
private Instant inConnectionStatusSince;
private List<Pair<ActorRef, DittoHeaders>> sessionSenders = Collections.emptyList();
private SshTunnelState sshTunnelState;
private int failureCount = 0;
static BaseClientDataBuilder from(final BaseClientData data) {
return new BaseClientDataBuilder(data);
}
static BaseClientDataBuilder initialized(final Connection connection) {
return new BaseClientDataBuilder(connection.getId(), connection,
ConnectivityStatus.UNKNOWN,
RecoveryStatus.UNKNOWN,
ConnectivityStatus.OPEN,
"initialized",
Instant.now());
}
private BaseClientDataBuilder(final BaseClientData data) {
connectionId = data.getConnectionId();
connection = data.getConnection();
connectionStatus = data.getConnectionStatus();
recoveryStatus = data.getRecoveryStatus();
connectionStatusDetails = data.getConnectionStatusDetails().orElse(null);
desiredConnectionStatus = data.getDesiredConnectionStatus();
inConnectionStatusSince = data.getInConnectionStatusSince();
sessionSenders = data.getSessionSenders();
sshTunnelState = data.getSshTunnelState();
failureCount = data.getFailureCount();
}
private BaseClientDataBuilder(final ConnectionId connectionId,
final Connection connection,
final ConnectivityStatus connectionStatus,
final RecoveryStatus recoveryStatus,
final ConnectivityStatus desiredConnectionStatus,
@Nullable final String connectionStatusDetails,
final Instant inConnectionStatusSince) {
this.connectionId = connectionId;
this.connection = connection;
this.connectionStatus = connectionStatus;
this.recoveryStatus = recoveryStatus;
this.connectionStatusDetails = connectionStatusDetails;
this.desiredConnectionStatus = desiredConnectionStatus;
this.inConnectionStatusSince = inConnectionStatusSince;
this.sshTunnelState = SshTunnelState.from(connection);
}
public BaseClientDataBuilder setConnectionId(final ConnectionId connectionId) {
this.connectionId = connectionId;
return this;
}
public BaseClientDataBuilder setConnection(final Connection connection) {
this.connection = connection;
return this;
}
public BaseClientDataBuilder setConnectionStatus(final ConnectivityStatus connectionStatus) {
this.connectionStatus = connectionStatus;
return this;
}
public BaseClientDataBuilder setRecoveryStatus(final RecoveryStatus recoveryStatus) {
this.recoveryStatus = recoveryStatus;
return this;
}
public BaseClientDataBuilder setDesiredConnectionStatus(final ConnectivityStatus desiredConnectionStatus) {
this.desiredConnectionStatus = desiredConnectionStatus;
return this;
}
public BaseClientDataBuilder setConnectionStatusDetails(final String connectionStatusDetails) {
this.connectionStatusDetails = connectionStatusDetails;
return this;
}
public BaseClientDataBuilder setInConnectionStatusSince(final Instant inConnectionStatusSince) {
this.inConnectionStatusSince = inConnectionStatusSince;
return this;
}
public BaseClientDataBuilder setSessionSenders(final List<Pair<ActorRef, DittoHeaders>> sessionSenders) {
this.sessionSenders = sessionSenders;
return this;
}
public BaseClientDataBuilder setSshTunnelState(final SshTunnelState sshTunnelState) {
this.sshTunnelState = sshTunnelState;
return this;
}
public BaseClientDataBuilder setFailureCount(final int failureCount) {
this.failureCount = failureCount;
return this;
}
public BaseClientData build() {
return new BaseClientData(connectionId, connection, connectionStatus, recoveryStatus,
desiredConnectionStatus, connectionStatusDetails, inConnectionStatusSince, sessionSenders,
sshTunnelState, failureCount);
}
}
}