/
JavaCoapServerEndpoint.java
243 lines (208 loc) · 10.3 KB
/
JavaCoapServerEndpoint.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
/*******************************************************************************
* Copyright (c) 2023 Sierra Wireless and others.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v2.0
* and Eclipse Distribution License v1.0 which accompany this distribution.
*
* The Eclipse Public License is available at
* http://www.eclipse.org/legal/epl-v20.html
* and the Eclipse Distribution License is available at
* http://www.eclipse.org/org/documents/edl-v10.html.
*
* Contributors:
* Sierra Wireless - initial API and implementation
*******************************************************************************/
package org.eclipse.leshan.transport.javacoap.server.endpoint;
import java.net.URI;
import java.util.SortedMap;
import java.util.concurrent.CancellationException;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionException;
import java.util.concurrent.ConcurrentNavigableMap;
import java.util.concurrent.ConcurrentSkipListMap;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicLong;
import org.eclipse.leshan.core.endpoint.EndpointUriUtil;
import org.eclipse.leshan.core.endpoint.Protocol;
import org.eclipse.leshan.core.observation.Observation;
import org.eclipse.leshan.core.request.DownlinkRequest;
import org.eclipse.leshan.core.request.exception.RequestCanceledException;
import org.eclipse.leshan.core.request.exception.SendFailedException;
import org.eclipse.leshan.core.request.exception.TimeoutException.Type;
import org.eclipse.leshan.core.response.ErrorCallback;
import org.eclipse.leshan.core.response.LwM2mResponse;
import org.eclipse.leshan.core.response.ResponseCallback;
import org.eclipse.leshan.core.util.NamedThreadFactory;
import org.eclipse.leshan.core.util.Validate;
import org.eclipse.leshan.server.endpoint.LwM2mServerEndpoint;
import org.eclipse.leshan.server.endpoint.ServerEndpointToolbox;
import org.eclipse.leshan.server.profile.ClientProfile;
import org.eclipse.leshan.server.request.LowerLayerConfig;
import com.mbed.coap.exception.CoapTimeoutException;
import com.mbed.coap.packet.CoapRequest;
import com.mbed.coap.packet.CoapResponse;
import com.mbed.coap.server.CoapServer;
public class JavaCoapServerEndpoint implements LwM2mServerEndpoint {
private final CoapServer coapServer;
private final ServerCoapMessageTranslator translator;
private final ServerEndpointToolbox toolbox;
private final ScheduledExecutorService executor = Executors.newScheduledThreadPool(1,
new NamedThreadFactory("Leshan Async Request timeout"));
// A map which contains all ongoing CoAP requests
// This is used to be able to cancel request
private final ConcurrentNavigableMap< //
String, // sessionId#requestId
CompletableFuture<? extends LwM2mResponse>> // future of the ongoing Coap Request
ongoingRequests = new ConcurrentSkipListMap<>();
public JavaCoapServerEndpoint(CoapServer coapServer, ServerCoapMessageTranslator translator,
ServerEndpointToolbox toolbox) {
this.coapServer = coapServer;
this.translator = translator;
this.toolbox = toolbox;
}
@Override
public Protocol getProtocol() {
return Protocol.COAP;
}
@Override
public String getDescription() {
return "CoAP over UDP based on java-coap library";
}
@Override
public URI getURI() {
return EndpointUriUtil.createUri(getProtocol().getUriScheme(), coapServer.getLocalSocketAddress());
}
@Override
public <T extends LwM2mResponse> T send(ClientProfile destination, DownlinkRequest<T> request,
LowerLayerConfig lowerLayerConfig, long timeoutInMs) throws InterruptedException {
// Send LWM2M Request
CompletableFuture<T> lwm2mResponseFuture = sendLwM2mRequest(destination, request, lowerLayerConfig);
// Wait synchronously for LWM2M response
try {
return lwm2mResponseFuture.get(timeoutInMs, TimeUnit.MILLISECONDS);
} catch (CompletionException | ExecutionException | CancellationException exception) {
if (lwm2mResponseFuture.isCancelled()) {
throw new RequestCanceledException();
} else {
if (exception.getCause() instanceof CoapTimeoutException) {
return null;
} else {
throw new SendFailedException("Unable to send request " + exception.getCause(), exception);
}
}
} catch (TimeoutException e) {
lwm2mResponseFuture.cancel(true);
return null;
}
}
@Override
public <T extends LwM2mResponse> void send(ClientProfile destination, DownlinkRequest<T> request,
ResponseCallback<T> responseCallback, ErrorCallback errorCallback, LowerLayerConfig lowerLayerConfig,
long timeoutInMs) {
// Send LWM2M Request
CompletableFuture<T> lwm2mResponseFuture = sendLwM2mRequest(destination, request, lowerLayerConfig);
// Attach callback
lwm2mResponseFuture.whenComplete((lwM2mResponse, exception) -> {
// Handle Exception
if (exception != null) {
if (exception instanceof CancellationException) {
errorCallback.onError(new RequestCanceledException());
} else if (exception instanceof TimeoutException) {
errorCallback.onError(new org.eclipse.leshan.core.request.exception.TimeoutException(
Type.RESPONSE_TIMEOUT, exception.getCause(), "LWM2M response Timeout"));
} else if (exception instanceof CompletionException
&& exception.getCause() instanceof CoapTimeoutException) {
errorCallback.onError(new org.eclipse.leshan.core.request.exception.TimeoutException(
Type.COAP_TIMEOUT, exception.getCause(), "Coap Timeout"));
} else {
errorCallback.onError(new SendFailedException("Unable to send request " + exception.getCause(),
exception.getCause()));
}
} else {
// Handle CoAP Response
responseCallback.onResponse(lwM2mResponse);
}
});
// Handle timeout
timeoutAfter(lwm2mResponseFuture, timeoutInMs);
}
protected <T extends LwM2mResponse> CompletableFuture<T> sendLwM2mRequest(ClientProfile destination,
DownlinkRequest<T> lwm2mRequest, LowerLayerConfig lowerLayerConfig) {
CompletableFuture<T> lwm2mResponseFuture;
// Create Coap Request to send from LWM2M Request
CoapRequest coapRequest = translator.createCoapRequest(destination, lwm2mRequest, toolbox);
// Apply Users customization
applyUserConfig(lowerLayerConfig, coapRequest);
// Send CoAP Request
CompletableFuture<CoapResponse> coapResponseFuture = coapServer.clientService().apply(coapRequest);
// On response, create LWM2M Response from CoAP response
lwm2mResponseFuture = coapResponseFuture.thenApply(coapResponse -> translator.createLwM2mResponse(destination,
lwm2mRequest, coapResponse, coapRequest, toolbox));
// store ongoing request
addOngoingRequest(destination.getRegistrationId(), lwm2mResponseFuture);
return lwm2mResponseFuture;
}
public void timeoutAfter(CompletableFuture<?> future, long timeoutInMs) {
// schedule a timeout task to stop future after given amount of time
ScheduledFuture<?> timeoutTask = executor.schedule(() -> {
if (future != null && !future.isDone()) {
future.completeExceptionally(new TimeoutException());
}
}, timeoutInMs, TimeUnit.MILLISECONDS);
future.whenComplete((r, e) -> {
// Cancel TimeoutTask just above when future is complete
if (e == null && timeoutTask != null && !timeoutTask.isDone()) {
timeoutTask.cancel(false);
}
});
}
@Override
public void cancelRequests(String sessionID) {
Validate.notNull(sessionID);
SortedMap<String, CompletableFuture<? extends LwM2mResponse>> requests = ongoingRequests
.subMap(getFloorKey(sessionID), getCeilingKey(sessionID));
for (CompletableFuture<? extends LwM2mResponse> request : requests.values()) {
request.cancel(false);
}
requests.clear();
}
@Override
public void cancelObservation(Observation observation) {
// TODO not sure there is something to implement here.
// Maybe trying to cancel ongoing observe request linked to this observation ?
}
private static String getFloorKey(String sessionID) {
// The key format is sessionid#long, So we need a key which is always before this pattern (in natural order).
return sessionID + '#';
}
private static String getCeilingKey(String sessionID) {
// The key format is sessionid#long, So we need a key which is always after this pattern (in natural order).
return sessionID + "#A";
}
private static String getKey(String sessionID, long requestId) {
return sessionID + '#' + requestId;
}
private final AtomicLong idGenerator = new AtomicLong(0l);
private void addOngoingRequest(String sessionID, CompletableFuture<? extends LwM2mResponse> coapRequest) {
if (sessionID != null) {
final String key = getKey(sessionID, idGenerator.incrementAndGet());
ongoingRequests.put(key, coapRequest);
coapRequest.whenComplete((r, e) -> {
ongoingRequests.remove(key);
});
}
}
private void applyUserConfig(LowerLayerConfig lowerLayerConfig, CoapRequest request) {
// TODO This is probably not so useful because of
// https://github.com/open-coap/java-coap/issues/27#issuecomment-1514790233
// But with should help to adapt the code : https://github.com/open-coap/java-coap/pull/68
if (lowerLayerConfig != null)
lowerLayerConfig.apply(request);
}
}