-
Notifications
You must be signed in to change notification settings - Fork 214
/
ConnectionsRoute.java
346 lines (307 loc) · 16.3 KB
/
ConnectionsRoute.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
/*
* 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.gateway.service.endpoints.routes.connections;
import static org.eclipse.ditto.base.model.exceptions.DittoJsonException.wrapJsonRuntimeException;
import static org.eclipse.ditto.gateway.service.endpoints.directives.ContentTypeValidationDirective.ensureValidContentType;
import java.time.Duration;
import java.util.Optional;
import java.util.Set;
import java.util.UUID;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.eclipse.ditto.base.model.headers.DittoHeaders;
import org.eclipse.ditto.base.model.signals.commands.Command;
import org.eclipse.ditto.connectivity.model.Connection;
import org.eclipse.ditto.connectivity.model.ConnectionId;
import org.eclipse.ditto.connectivity.model.ConnectivityModelFactory;
import org.eclipse.ditto.connectivity.model.ConnectivityStatus;
import org.eclipse.ditto.connectivity.model.signals.commands.ConnectivityCommand;
import org.eclipse.ditto.connectivity.model.signals.commands.exceptions.ConnectionIdNotExplicitlySettableException;
import org.eclipse.ditto.connectivity.model.signals.commands.exceptions.ConnectivityCommandInvalidException;
import org.eclipse.ditto.connectivity.model.signals.commands.modify.CloseConnection;
import org.eclipse.ditto.connectivity.model.signals.commands.modify.CreateConnection;
import org.eclipse.ditto.connectivity.model.signals.commands.modify.DeleteConnection;
import org.eclipse.ditto.connectivity.model.signals.commands.modify.EnableConnectionLogs;
import org.eclipse.ditto.connectivity.model.signals.commands.modify.ModifyConnection;
import org.eclipse.ditto.connectivity.model.signals.commands.modify.OpenConnection;
import org.eclipse.ditto.connectivity.model.signals.commands.modify.ResetConnectionLogs;
import org.eclipse.ditto.connectivity.model.signals.commands.modify.ResetConnectionMetrics;
import org.eclipse.ditto.connectivity.model.signals.commands.modify.TestConnection;
import org.eclipse.ditto.connectivity.model.signals.commands.query.RetrieveConnection;
import org.eclipse.ditto.connectivity.model.signals.commands.query.RetrieveConnectionLogs;
import org.eclipse.ditto.connectivity.model.signals.commands.query.RetrieveConnectionMetrics;
import org.eclipse.ditto.connectivity.model.signals.commands.query.RetrieveConnectionStatus;
import org.eclipse.ditto.connectivity.model.signals.commands.query.RetrieveConnections;
import org.eclipse.ditto.gateway.service.endpoints.routes.AbstractRoute;
import org.eclipse.ditto.gateway.service.endpoints.routes.RouteBaseProperties;
import org.eclipse.ditto.json.JsonFactory;
import org.eclipse.ditto.json.JsonObject;
import org.eclipse.ditto.json.JsonObjectBuilder;
import akka.http.javadsl.model.MediaTypes;
import akka.http.javadsl.server.PathMatchers;
import akka.http.javadsl.server.RequestContext;
import akka.http.javadsl.server.Route;
/**
* Builder for creating Akka HTTP routes for {@code /connections}.
*/
public final class ConnectionsRoute extends AbstractRoute {
/**
* Path segment of the "connections" URI.
*/
public static final String PATH_CONNECTIONS = "connections";
private static final String PATH_COMMAND = "command";
private static final String PATH_METRICS = "metrics";
private static final String PATH_STATUS = "status";
private static final String PATH_LOGS = "logs";
private final Set<String> mediaTypePlainTextWithFallbacks;
private final Duration defaultTimeout;
/**
* Constructs a {@code ConnectionsRoute} object.
*
* @param routeBaseProperties the base properties of the route.
* @throws NullPointerException if {@code routeBaseProperties} is {@code null}.
*/
public ConnectionsRoute(final RouteBaseProperties routeBaseProperties) {
super(routeBaseProperties);
defaultTimeout = routeBaseProperties.getCommandConfig().getDefaultTimeout();
final var httpConfig = routeBaseProperties.getHttpConfig();
final var fallbackMediaTypes = httpConfig.getAdditionalAcceptedMediaTypes().stream();
final var plainText = Stream.of(MediaTypes.TEXT_PLAIN.toString());
mediaTypePlainTextWithFallbacks = Stream.concat(plainText, fallbackMediaTypes).collect(Collectors.toSet());
}
/**
* Builds the {@code /connections} route.
*
* @param dittoHeaders the headers of the request.
* @return the {@code /connections} route.
*/
public Route buildConnectionsRoute(final RequestContext ctx, final DittoHeaders dittoHeaders) {
return rawPathPrefix(PathMatchers.slash().concat(PATH_CONNECTIONS), () -> {// /connections
return concat(
// /connections
connections(ctx, dittoHeaders),
rawPathPrefix(
PathMatchers.slash().concat(PathMatchers.segment()),
connectionId -> connectionRoute(ctx, dittoHeaders,
ConnectionId.of(connectionId))
)
);
});
}
private Route connectionRoute(final RequestContext ctx,
final DittoHeaders dittoHeaders,
final ConnectionId connectionId) {
return concat(
connectionsEntry(ctx, dittoHeaders, connectionId),
connectionsEntryCommand(ctx, dittoHeaders, connectionId),
connectionsEntryStatus(ctx, dittoHeaders, connectionId),
connectionsEntryMetrics(ctx, dittoHeaders, connectionId),
connectionsEntryLogs(ctx, dittoHeaders, connectionId)
);
}
/*
* Describes {@code /connections} route.
*
* @return {@code /connections} route.
*/
private Route connections(final RequestContext ctx, final DittoHeaders dittoHeaders) {
return pathEndOrSingleSlash(() ->
concat(
get(() -> // GET /connections?idsOnly=false
parameterOptional("idsOnly", idsOnly -> handlePerRequest(ctx,
RetrieveConnections.newInstance(idsOnly.map(Boolean::valueOf).orElse(false),
defaultTimeout, dittoHeaders)
))
),
post(() -> // POST /connections?dry-run=<dryRun>
parameterOptional(ConnectionsParameter.DRY_RUN.toString(), dryRun ->
ensureMediaTypeJsonWithFallbacksThenExtractDataBytes(ctx,
dittoHeaders,
payloadSource ->
handlePerRequest(ctx, dittoHeaders, payloadSource,
connectionJsonString ->
handlePostConnection(dryRun,
connectionJsonString, dittoHeaders)
)
)
)
)
)
);
}
@SuppressWarnings("OptionalUsedAsFieldOrParameterType")
private static Command<?> handlePostConnection(final Optional<String> dryRun,
final String connectionJsonString,
final DittoHeaders dittoHeaders) {
if (isDryRun(dryRun)) {
return TestConnection.of(buildConnectionForTest(connectionJsonString),
dittoHeaders.toBuilder().putHeader("timeout", "15000").build());
}
return CreateConnection.of(buildConnectionForPost(connectionJsonString), dittoHeaders);
}
@SuppressWarnings("OptionalUsedAsFieldOrParameterType")
private static boolean isDryRun(final Optional<String> dryRun) {
return dryRun.map(Boolean::valueOf).orElse(Boolean.FALSE);
}
/*
* Describes {@code /connections/<connectionId>} route.
*
* @return {@code /connections/<connectionId>} route.
*/
private Route connectionsEntry(final RequestContext ctx,
final DittoHeaders dittoHeaders,
final ConnectionId connectionId) {
return pathEndOrSingleSlash(() ->
concat(
put(() -> // PUT /connections/<connectionId>
ensureMediaTypeJsonWithFallbacksThenExtractDataBytes(ctx, dittoHeaders,
payloadSource ->
handlePerRequest(ctx, dittoHeaders, payloadSource, payloadJsonString ->
ModifyConnection.of(
buildConnectionForPut(connectionId,
payloadJsonString),
dittoHeaders))
)
),
get(() -> // GET /connections/<connectionId>
handlePerRequest(ctx, RetrieveConnection.of(connectionId, dittoHeaders))
),
delete(() -> // DELETE /connections/<connectionId>
handlePerRequest(ctx, DeleteConnection.of(connectionId, dittoHeaders))
)
)
);
}
/*
* Describes {@code /connections/<connectionId>/command} route.
*
* @return {@code /connections/<connectionId>/command} route.
*/
private Route connectionsEntryCommand(final RequestContext ctx,
final DittoHeaders dittoHeaders,
final ConnectionId connectionId) {
return path(PATH_COMMAND, () ->
concat(
post(() -> // POST /connections/<connectionId>/command
ensureValidContentType(mediaTypePlainTextWithFallbacks, ctx, dittoHeaders,
() -> extractDataBytes(payloadSource ->
handlePerRequest(ctx, dittoHeaders, payloadSource,
payloadJsonString -> buildConnectivityCommand(
payloadJsonString,
connectionId, dittoHeaders)))
)
)
)
);
}
/*
* Describes {@code /connections/<connectionId>/status} route.
*
* @return {@code /connections/<connectionId>/status} route.
*/
private Route connectionsEntryStatus(final RequestContext ctx,
final DittoHeaders dittoHeaders,
final ConnectionId connectionId) {
return path(PATH_STATUS, () ->
concat(
get(() -> // GET /connections/<connectionId>/status
handlePerRequest(ctx, RetrieveConnectionStatus.of(connectionId, dittoHeaders))
)
)
);
}
/*
* Describes {@code /connections/<connectionId>/metrics} route.
*
* @return {@code /connections/<connectionId>/metrics} route.
*/
private Route connectionsEntryMetrics(final RequestContext ctx,
final DittoHeaders dittoHeaders,
final ConnectionId connectionId) {
return path(PATH_METRICS, () ->
concat(
get(() -> // GET /connections/<connectionId>/metrics
handlePerRequest(ctx, RetrieveConnectionMetrics.of(connectionId, dittoHeaders))
)
)
);
}
/*
* Describes {@code /connections/<connectionId>/logs} route.
*
* @return {@code /connections/<connectionId>/logs} route.
*/
private Route connectionsEntryLogs(final RequestContext ctx,
final DittoHeaders dittoHeaders,
final ConnectionId connectionId) {
return path(PATH_LOGS, () ->
get(() -> // GET /connections/<connectionId>/logs
handlePerRequest(ctx, RetrieveConnectionLogs.of(connectionId, dittoHeaders))
)
);
}
private static ConnectivityCommand<?> buildConnectivityCommand(final String commandString,
final ConnectionId connectionId,
final DittoHeaders dittoHeaders) {
return switch (commandString) {
case OpenConnection.TYPE -> OpenConnection.of(connectionId, dittoHeaders);
case CloseConnection.TYPE -> CloseConnection.of(connectionId, dittoHeaders);
case ResetConnectionMetrics.TYPE -> ResetConnectionMetrics.of(connectionId, dittoHeaders);
case EnableConnectionLogs.TYPE -> EnableConnectionLogs.of(connectionId, dittoHeaders);
case ResetConnectionLogs.TYPE -> ResetConnectionLogs.of(connectionId, dittoHeaders);
default -> throw ConnectivityCommandInvalidException.newBuilder(commandString)
.dittoHeaders(dittoHeaders)
.build();
};
}
private static Connection buildConnectionForPost(final String connectionJson) {
final JsonObject connectionJsonObject = wrapJsonRuntimeException(() -> JsonFactory.newObject(connectionJson));
if (connectionJsonObject.contains(Connection.JsonFields.ID.getPointer())) {
throw ConnectionIdNotExplicitlySettableException.newBuilder().build();
}
final JsonObjectBuilder jsonObjectBuilder = connectionJsonObject.toBuilder();
jsonObjectBuilder.set(Connection.JsonFields.ID, UUID.randomUUID().toString());
final String connectionStatus = connectionJsonObject.getValue(Connection.JsonFields.CONNECTION_STATUS)
.orElse(ConnectivityStatus.UNKNOWN.getName());
jsonObjectBuilder.set(Connection.JsonFields.CONNECTION_STATUS, connectionStatus);
return ConnectivityModelFactory.connectionFromJson(jsonObjectBuilder.build());
}
private static Connection buildConnectionForTest(final String connectionJson) {
final JsonObject connectionJsonObject;
final JsonObject connectionJsonObjectBeforeReplacement =
wrapJsonRuntimeException(() -> JsonFactory.newObject(connectionJson));
final Optional<String> optionalConnectionId =
connectionJsonObjectBeforeReplacement.getValue(Connection.JsonFields.ID);
final String temporaryTestConnectionId = UUID.randomUUID() + "-dry-run";
if (optionalConnectionId.isPresent()) {
final String temporaryConnectionJson =
connectionJson.replace(optionalConnectionId.get(), temporaryTestConnectionId);
connectionJsonObject = wrapJsonRuntimeException(() -> JsonFactory.newObject(temporaryConnectionJson));
} else {
final JsonObjectBuilder jsonObjectBuilder = connectionJsonObjectBeforeReplacement.toBuilder();
connectionJsonObject = jsonObjectBuilder.set(Connection.JsonFields.ID, temporaryTestConnectionId).build();
}
return ConnectivityModelFactory.connectionFromJson(connectionJsonObject);
}
private static Connection buildConnectionForPut(final ConnectionId connectionId, final String connectionJson) {
final JsonObject connectionJsonObject = wrapJsonRuntimeException(() -> JsonFactory.newObject(connectionJson));
if (connectionJsonObject.contains(Connection.JsonFields.ID.getPointer())
&&
!connectionId.toString().equals(connectionJsonObject.getValue(Connection.JsonFields.ID).orElse(null))) {
throw ConnectionIdNotExplicitlySettableException.newBuilder().build();
}
final JsonObjectBuilder jsonObjectBuilder = connectionJsonObject.toBuilder();
jsonObjectBuilder.set(Connection.JsonFields.ID, connectionId.toString());
return ConnectivityModelFactory.connectionFromJson(jsonObjectBuilder.build());
}
}