/
DittoProtocolAdapter.java
executable file
·401 lines (344 loc) · 17.7 KB
/
DittoProtocolAdapter.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.protocoladapter;
import static org.eclipse.ditto.model.base.common.ConditionChecker.checkNotNull;
import java.util.Optional;
import javax.annotation.Nullable;
import org.eclipse.ditto.json.JsonFactory;
import org.eclipse.ditto.json.JsonMissingFieldException;
import org.eclipse.ditto.json.JsonValue;
import org.eclipse.ditto.model.base.common.HttpStatusCode;
import org.eclipse.ditto.model.base.exceptions.DittoRuntimeException;
import org.eclipse.ditto.model.base.headers.DittoHeaderDefinition;
import org.eclipse.ditto.model.base.headers.DittoHeaders;
import org.eclipse.ditto.model.base.headers.DittoHeadersBuilder;
import org.eclipse.ditto.model.messages.MessageHeaderDefinition;
import org.eclipse.ditto.signals.base.ErrorRegistry;
import org.eclipse.ditto.signals.base.GlobalErrorRegistry;
import org.eclipse.ditto.signals.base.JsonTypeNotParsableException;
import org.eclipse.ditto.signals.base.Signal;
import org.eclipse.ditto.signals.commands.base.Command;
import org.eclipse.ditto.signals.commands.base.CommandResponse;
import org.eclipse.ditto.signals.commands.messages.MessageCommand;
import org.eclipse.ditto.signals.commands.messages.MessageCommandResponse;
import org.eclipse.ditto.signals.commands.things.ThingCommandResponse;
import org.eclipse.ditto.signals.commands.things.ThingErrorResponse;
import org.eclipse.ditto.signals.commands.things.modify.ThingModifyCommand;
import org.eclipse.ditto.signals.commands.things.modify.ThingModifyCommandResponse;
import org.eclipse.ditto.signals.commands.things.query.ThingQueryCommand;
import org.eclipse.ditto.signals.commands.things.query.ThingQueryCommandResponse;
import org.eclipse.ditto.signals.events.base.Event;
import org.eclipse.ditto.signals.events.things.ThingEvent;
/**
* Adapter for the Ditto protocol.
*/
public final class DittoProtocolAdapter implements ProtocolAdapter {
private final ErrorRegistry<DittoRuntimeException> errorRegistry;
private final HeaderTranslator headerTranslator;
private final MessageCommandAdapter messageCommandAdapter;
private final MessageCommandResponseAdapter messageCommandResponseAdapter;
private final ThingModifyCommandAdapter thingModifyCommandAdapter;
private final ThingModifyCommandResponseAdapter thingModifyCommandResponseAdapter;
private final ThingQueryCommandAdapter thingQueryCommandAdapter;
private final ThingQueryCommandResponseAdapter thingQueryCommandResponseAdapter;
private final ThingEventAdapter thingEventAdapter;
protected DittoProtocolAdapter(final ErrorRegistry<DittoRuntimeException> errorRegistry,
final HeaderTranslator headerTranslator) {
this.errorRegistry = errorRegistry;
this.headerTranslator = headerTranslator;
messageCommandAdapter = MessageCommandAdapter.of(headerTranslator);
messageCommandResponseAdapter = MessageCommandResponseAdapter.of(headerTranslator);
thingModifyCommandAdapter = ThingModifyCommandAdapter.of(headerTranslator);
thingModifyCommandResponseAdapter = ThingModifyCommandResponseAdapter.of(headerTranslator);
thingQueryCommandAdapter = ThingQueryCommandAdapter.of(headerTranslator);
thingQueryCommandResponseAdapter = ThingQueryCommandResponseAdapter.of(headerTranslator);
thingEventAdapter = ThingEventAdapter.of(headerTranslator);
}
/**
* Creates a new {@code DittoProtocolAdapter} instance with the given header translator.
*
* @param headerTranslator translator between external and Ditto headers.
*/
public static DittoProtocolAdapter of(final HeaderTranslator headerTranslator) {
checkNotNull(headerTranslator, "headerTranslator");
return new DittoProtocolAdapter(GlobalErrorRegistry.getInstance(), headerTranslator);
}
/**
* Creates a new {@code DittoProtocolAdapter} instance.
*
* @return the instance.
*/
public static DittoProtocolAdapter newInstance() {
return new DittoProtocolAdapter(GlobalErrorRegistry.getInstance(), getHeaderTranslator());
}
/**
* Creates a default header translator for this protocol adapter.
*
* @return the default header translator.
*/
public static HeaderTranslator getHeaderTranslator() {
return HeaderTranslator.of(DittoHeaderDefinition.values(), MessageHeaderDefinition.values());
}
@Override
public Signal<?> fromAdaptable(final Adaptable adaptable) {
final TopicPath topicPath = adaptable.getTopicPath();
if (TopicPath.Group.THINGS.equals(topicPath.getGroup())) { // /things
final TopicPath.Channel channel = topicPath.getChannel();
if (channel.equals(TopicPath.Channel.LIVE)) { // /things/live
return fromLiveAdaptable(adaptable);
} else if (channel.equals(TopicPath.Channel.TWIN)) { // /things/twin
return fromTwinAdaptable(adaptable);
}
}
throw UnknownTopicPathException.newBuilder(topicPath).build();
}
@Override
public Adaptable toAdaptable(final Signal<?> signal) {
final boolean isLive = isLiveSignal(signal);
final TopicPath.Channel channel = isLive ? TopicPath.Channel.LIVE : TopicPath.Channel.TWIN;
if (signal instanceof MessageCommand) {
return toAdaptable((MessageCommand<?, ?>) signal);
} else if (signal instanceof MessageCommandResponse) {
return toAdaptable((MessageCommandResponse<?, ?>) signal);
} else if (signal instanceof Command) {
return toAdaptable((Command<?>) signal, channel);
} else if (signal instanceof CommandResponse) {
return toAdaptable((CommandResponse<?>) signal, channel);
} else if (signal instanceof Event) {
return toAdaptable((Event<?>) signal, channel);
}
throw UnknownSignalException.newBuilder(signal.getName()).dittoHeaders(signal.getDittoHeaders()).build();
}
private static boolean isLiveSignal(final Signal<?> signal) {
return signal.getDittoHeaders().getChannel().filter(TopicPath.Channel.LIVE.getName()::equals).isPresent();
}
@Override
public Adaptable toAdaptable(final CommandResponse<?> commandResponse) {
return toAdaptable(commandResponse, TopicPath.Channel.TWIN);
}
@Override
public Adaptable toAdaptable(final CommandResponse<?> commandResponse, final TopicPath.Channel channel) {
if (commandResponse instanceof MessageCommandResponse && channel == TopicPath.Channel.LIVE) {
return toAdaptable((MessageCommandResponse) commandResponse);
} else if (commandResponse instanceof ThingCommandResponse) {
return toAdaptable((ThingCommandResponse) commandResponse, channel);
} else {
throw UnknownCommandResponseException.newBuilder(commandResponse.getName()).build();
}
}
@Override
public Adaptable toAdaptable(final ThingCommandResponse<?> thingCommandResponse) {
return toAdaptable(thingCommandResponse, TopicPath.Channel.TWIN);
}
@Override
public Adaptable toAdaptable(final ThingCommandResponse<?> thingCommandResponse, final TopicPath.Channel channel) {
if (thingCommandResponse instanceof ThingQueryCommandResponse) {
return toAdaptable((ThingQueryCommandResponse) thingCommandResponse, channel);
} else if (thingCommandResponse instanceof ThingModifyCommandResponse) {
return toAdaptable((ThingModifyCommandResponse) thingCommandResponse, channel);
} else if (thingCommandResponse instanceof ThingErrorResponse) {
return toAdaptable((ThingErrorResponse) thingCommandResponse, channel);
} else {
throw UnknownCommandResponseException.newBuilder(thingCommandResponse.getName()).build();
}
}
@Override
public Adaptable toAdaptable(final MessageCommand<?, ?> messageCommand) {
return messageCommandAdapter.toAdaptable(messageCommand, TopicPath.Channel.LIVE);
}
@Override
public Adaptable toAdaptable(final MessageCommandResponse<?, ?> messageCommandResponse) {
return messageCommandResponseAdapter.toAdaptable(messageCommandResponse, TopicPath.Channel.LIVE);
}
@Override
public Adaptable toAdaptable(final Command<?> command) {
return toAdaptable(command, TopicPath.Channel.TWIN);
}
@Override
public Adaptable toAdaptable(final Command<?> command, final TopicPath.Channel channel) {
if (command instanceof MessageCommand && channel == TopicPath.Channel.LIVE) {
return toAdaptable((MessageCommand) command);
} else if (command instanceof ThingModifyCommand) {
return toAdaptable((ThingModifyCommand) command, channel);
} else if (command instanceof ThingQueryCommand) {
return toAdaptable((ThingQueryCommand) command, channel);
} else {
throw UnknownCommandException.newBuilder(command.getName()).build();
}
}
@Override
public Adaptable toAdaptable(final ThingModifyCommand<?> thingModifyCommand) {
return toAdaptable(thingModifyCommand, TopicPath.Channel.TWIN);
}
@Override
public Adaptable toAdaptable(final ThingModifyCommand<?> thingModifyCommand, final TopicPath.Channel channel) {
return thingModifyCommandAdapter.toAdaptable(thingModifyCommand, channel);
}
@Override
public Adaptable toAdaptable(final ThingModifyCommandResponse<?> thingModifyCommandResponse) {
return toAdaptable(thingModifyCommandResponse, TopicPath.Channel.TWIN);
}
@Override
public Adaptable toAdaptable(final ThingModifyCommandResponse<?> thingModifyCommandResponse,
final TopicPath.Channel channel) {
return thingModifyCommandResponseAdapter.toAdaptable(thingModifyCommandResponse, channel);
}
@Override
public Adaptable toAdaptable(final ThingQueryCommand<?> thingQueryCommand) {
return toAdaptable(thingQueryCommand, TopicPath.Channel.TWIN);
}
@Override
public Adaptable toAdaptable(final ThingQueryCommand<?> thingQueryCommand, final TopicPath.Channel channel) {
return thingQueryCommandAdapter.toAdaptable(thingQueryCommand, channel);
}
@Override
public Adaptable toAdaptable(final ThingQueryCommandResponse<?> thingQueryCommandResponse) {
return toAdaptable(thingQueryCommandResponse, TopicPath.Channel.TWIN);
}
@Override
public Adaptable toAdaptable(final ThingQueryCommandResponse<?> thingQueryCommandResponse,
final TopicPath.Channel channel) {
return thingQueryCommandResponseAdapter.toAdaptable(thingQueryCommandResponse, channel);
}
@Override
public Adaptable toAdaptable(final ThingErrorResponse thingErrorResponse, final TopicPath.Channel channel) {
final Payload payload = Payload.newBuilder(thingErrorResponse.getResourcePath()) //
.withStatus(thingErrorResponse.getStatusCode()) //
.withValue(thingErrorResponse.toJson(thingErrorResponse.getImplementedSchemaVersion()) //
.getValue(CommandResponse.JsonFields.PAYLOAD)
.orElse(JsonFactory.nullObject())) // only use the error payload
.build();
final TopicPathBuilder topicPathBuilder = ProtocolFactory.newTopicPathBuilder(thingErrorResponse.getId());
final TopicPathBuildable topicPathBuildable;
if (channel == TopicPath.Channel.TWIN) {
topicPathBuildable = topicPathBuilder.twin().errors();
} else if (channel == TopicPath.Channel.LIVE) {
topicPathBuildable = topicPathBuilder.live().errors();
} else {
throw new IllegalArgumentException("Unknown Channel '" + channel + "'");
}
final DittoHeaders responseHeaders =
ProtocolFactory.newHeadersWithDittoContentType(thingErrorResponse.getDittoHeaders());
return Adaptable.newBuilder(topicPathBuildable.build())
.withPayload(payload)
.withHeaders(DittoHeaders.of(headerTranslator.toExternalHeaders(responseHeaders)))
.build();
}
@Override
public Adaptable toAdaptable(final Event<?> event) {
return toAdaptable(event, TopicPath.Channel.TWIN);
}
@Override
public Adaptable toAdaptable(final Event<?> event, final TopicPath.Channel channel) {
if (event instanceof ThingEvent) {
return toAdaptable((ThingEvent) event, channel);
} else {
throw UnknownEventException.newBuilder(event.getName()).build();
}
}
@Override
public Adaptable toAdaptable(final ThingEvent<?> thingEvent) {
return toAdaptable(thingEvent, TopicPath.Channel.TWIN);
}
@Override
public Adaptable toAdaptable(final ThingEvent<?> thingEvent, final TopicPath.Channel channel) {
return thingEventAdapter.toAdaptable(thingEvent, channel);
}
private Signal<?> fromLiveAdaptable(final Adaptable adaptable) {
final TopicPath topicPath = adaptable.getTopicPath();
final Signal<?> liveSignal;
if (TopicPath.Criterion.MESSAGES.equals(topicPath.getCriterion())) { // /things/live/messages
final boolean isResponse = adaptable.getPayload().getStatus().isPresent();
if (isResponse) {
liveSignal = messageCommandResponseAdapter.fromAdaptable(adaptable);
} else {
liveSignal = messageCommandAdapter.fromAdaptable(adaptable);
}
} else {
liveSignal = signalFromAdaptable(adaptable, topicPath); // /things/live/(commands|events)
}
if (liveSignal != null) {
final DittoHeadersBuilder enhancedHeadersBuilder = liveSignal.getDittoHeaders()
.toBuilder()
.channel(TopicPath.Channel.LIVE.getName());
return liveSignal.setDittoHeaders(enhancedHeadersBuilder.build());
} else {
throw UnknownTopicPathException.newBuilder(topicPath).build();
}
}
private Signal<?> fromTwinAdaptable(final Adaptable adaptable) {
final TopicPath topicPath = adaptable.getTopicPath();
final Signal<?> signal =
signalFromAdaptable(adaptable, topicPath); // /things/twin/(commands|events)
if (signal != null) {
return signal;
} else {
throw UnknownTopicPathException.newBuilder(topicPath).build();
}
}
@Nullable
private Signal<?> signalFromAdaptable(final Adaptable adaptable, final TopicPath topicPath) {
if (TopicPath.Criterion.COMMANDS.equals(topicPath.getCriterion())) {
if (adaptable.getPayload().getStatus().isPresent()) {
// this was a command response:
return processCommandResponseSignalFromAdaptable(adaptable, topicPath);
} else if (TopicPath.Action.RETRIEVE.equals(topicPath.getAction().orElse(null))) {
return thingQueryCommandAdapter.fromAdaptable(adaptable);
} else {
return thingModifyCommandAdapter.fromAdaptable(adaptable);
}
} else if (TopicPath.Criterion.EVENTS.equals(topicPath.getCriterion())) {
return thingEventAdapter.fromAdaptable(adaptable);
} else if (TopicPath.Criterion.ERRORS.equals(topicPath.getCriterion())) {
return thingErrorResponseFromAdaptable(adaptable);
}
return null;
}
private Signal<?> processCommandResponseSignalFromAdaptable(final Adaptable adaptable, final TopicPath topicPath) {
final Optional<HttpStatusCode> status = adaptable.getPayload().getStatus();
final boolean isErrorResponse =
status.isPresent() && status.get().toInt() >= HttpStatusCode.BAD_REQUEST.toInt();
if (TopicPath.Action.RETRIEVE.equals(topicPath.getAction().orElse(null))) {
return isErrorResponse ? thingErrorResponseFromAdaptable(adaptable) :
thingQueryCommandResponseAdapter.fromAdaptable(adaptable);
} else {
return isErrorResponse ? thingErrorResponseFromAdaptable(adaptable) :
thingModifyCommandResponseAdapter.fromAdaptable(adaptable);
}
}
/**
* Creates a {@code ThingErrorResponse} from the given {@code adaptable}.
*
* @param adaptable the adaptable to convert.
* @return the ThingErrorResponse.
*/
private ThingErrorResponse thingErrorResponseFromAdaptable(final Adaptable adaptable) {
final DittoHeaders dittoHeaders =
headerTranslator.fromExternalHeaders(adaptable.getHeaders().orElse(DittoHeaders.empty()));
final TopicPath topicPath = adaptable.getTopicPath();
final DittoRuntimeException dittoRuntimeException = adaptable.getPayload()
.getValue()
.map(JsonValue::asObject)
.map(jsonObject -> {
try {
return errorRegistry.parse(jsonObject, dittoHeaders);
} catch (final JsonTypeNotParsableException e) {
return DittoRuntimeException.fromUnknownErrorJson(jsonObject, dittoHeaders)
.orElseThrow(() -> e);
}
})
.orElseThrow(() -> new JsonMissingFieldException(ThingCommandResponse.JsonFields.PAYLOAD));
final String thingId = topicPath.getNamespace() + ":" + topicPath.getId();
return ThingErrorResponse.of(thingId, dittoRuntimeException, dittoRuntimeException.getDittoHeaders());
}
}