From 3c4651d4daf9179119bc77a17d199df82ab4e091 Mon Sep 17 00:00:00 2001 From: Simon Bernard Date: Fri, 6 Oct 2023 16:57:02 +0200 Subject: [PATCH 1/7] Add support of multiple endpoint provider at server side. --- .../californium/LeshanServerBuilderTest.java | 10 +- .../server/californium/LeshanServerTest.java | 8 +- .../eclipse/leshan/server/LeshanServer.java | 10 +- .../leshan/server/LeshanServerBuilder.java | 32 +++++- .../CompositeServerEndpointsProvider.java | 33 ++++++ ...faultCompositeServerEndpointsProvider.java | 102 ++++++++++++++++++ .../leshan/server/demo/LeshanServerDemo.java | 2 +- 7 files changed, 179 insertions(+), 18 deletions(-) create mode 100644 leshan-server-core/src/main/java/org/eclipse/leshan/server/endpoint/CompositeServerEndpointsProvider.java create mode 100644 leshan-server-core/src/main/java/org/eclipse/leshan/server/endpoint/DefaultCompositeServerEndpointsProvider.java diff --git a/leshan-server-cf/src/test/java/org/eclipse/leshan/server/californium/LeshanServerBuilderTest.java b/leshan-server-cf/src/test/java/org/eclipse/leshan/server/californium/LeshanServerBuilderTest.java index e8eb52cec8..ab7d18fdf3 100644 --- a/leshan-server-cf/src/test/java/org/eclipse/leshan/server/californium/LeshanServerBuilderTest.java +++ b/leshan-server-cf/src/test/java/org/eclipse/leshan/server/californium/LeshanServerBuilderTest.java @@ -90,7 +90,7 @@ public void start() { @Test public void create_server_with_default_californiumEndpointsProvider() { - builder.setEndpointsProvider(new CaliforniumServerEndpointsProvider()); + builder.setEndpointsProviders(new CaliforniumServerEndpointsProvider()); server = builder.build(); assertEquals(1, server.getEndpoints().size()); @@ -101,7 +101,7 @@ public void create_server_with_default_californiumEndpointsProvider() { public void create_server_without_securityStore() { Builder endpointsBuilder = new CaliforniumServerEndpointsProvider.Builder(new CoapServerProtocolProvider(), new CoapsServerProtocolProvider()); - builder.setEndpointsProvider(endpointsBuilder.build()); + builder.setEndpointsProviders(endpointsBuilder.build()); server = builder.build(); assertEquals(1, server.getEndpoints().size()); @@ -113,7 +113,7 @@ public void create_server_without_securityStore() { public void create_server_with_securityStore() { Builder endpointsBuilder = new CaliforniumServerEndpointsProvider.Builder(new CoapServerProtocolProvider(), new CoapsServerProtocolProvider()); - builder.setEndpointsProvider(endpointsBuilder.build()); + builder.setEndpointsProviders(endpointsBuilder.build()); builder.setSecurityStore(new InMemorySecurityStore()); server = builder.build(); @@ -126,7 +126,7 @@ public void create_server_with_securityStore() { @Test public void create_server_with_coaps_only() { Builder endpointsBuilder = new CaliforniumServerEndpointsProvider.Builder(new CoapsServerProtocolProvider()); - builder.setEndpointsProvider(endpointsBuilder.build()); + builder.setEndpointsProviders(endpointsBuilder.build()); builder.setSecurityStore(new InMemorySecurityStore()); server = builder.build(); @@ -146,7 +146,7 @@ public void create_server_without_psk_cipher() { builder.setPrivateKey(privateKey); builder.setPublicKey(publicKey); builder.setSecurityStore(new InMemorySecurityStore()); - builder.setEndpointsProvider(endpointsBuilder.build()); + builder.setEndpointsProviders(endpointsBuilder.build()); server = builder.build(); diff --git a/leshan-server-cf/src/test/java/org/eclipse/leshan/server/californium/LeshanServerTest.java b/leshan-server-cf/src/test/java/org/eclipse/leshan/server/californium/LeshanServerTest.java index 3e199755aa..6caa09d0cd 100644 --- a/leshan-server-cf/src/test/java/org/eclipse/leshan/server/californium/LeshanServerTest.java +++ b/leshan-server-cf/src/test/java/org/eclipse/leshan/server/californium/LeshanServerTest.java @@ -41,7 +41,7 @@ public class LeshanServerTest { public void testStartStopStart() throws InterruptedException { Builder EndpointProviderbuilder = new CaliforniumServerEndpointsProvider.Builder(); EndpointProviderbuilder.addEndpoint(new InetSocketAddress(0), Protocol.COAP); - LeshanServer server = new LeshanServerBuilder().setEndpointsProvider(EndpointProviderbuilder.build()).build(); + LeshanServer server = new LeshanServerBuilder().setEndpointsProviders(EndpointProviderbuilder.build()).build(); server.start(); Thread.sleep(100); @@ -57,7 +57,7 @@ public void testStartDestroy() throws InterruptedException { Builder EndpointProviderbuilder = new CaliforniumServerEndpointsProvider.Builder(); EndpointProviderbuilder.addEndpoint(new InetSocketAddress(0), Protocol.COAP); - LeshanServer server = new LeshanServerBuilder().setEndpointsProvider(EndpointProviderbuilder.build()).build(); + LeshanServer server = new LeshanServerBuilder().setEndpointsProviders(EndpointProviderbuilder.build()).build(); server.start(); Thread.sleep(100); @@ -78,7 +78,7 @@ public void testStartStopDestroy() throws InterruptedException { Builder EndpointProviderbuilder = new CaliforniumServerEndpointsProvider.Builder(); EndpointProviderbuilder.addEndpoint(new InetSocketAddress(0), Protocol.COAP); - LeshanServer server = new LeshanServerBuilder().setEndpointsProvider(EndpointProviderbuilder.build()).build(); + LeshanServer server = new LeshanServerBuilder().setEndpointsProviders(EndpointProviderbuilder.build()).build(); server.start(); Thread.sleep(100); @@ -101,7 +101,7 @@ public void testStartStopDestroyQueueModeDisabled() throws InterruptedException Builder EndpointProviderbuilder = new CaliforniumServerEndpointsProvider.Builder(); EndpointProviderbuilder.addEndpoint(new InetSocketAddress(0), Protocol.COAP); - LeshanServer server = new LeshanServerBuilder().setEndpointsProvider(EndpointProviderbuilder.build()) + LeshanServer server = new LeshanServerBuilder().setEndpointsProviders(EndpointProviderbuilder.build()) .disableQueueModeSupport().build(); server.start(); Thread.sleep(100); diff --git a/leshan-server-core/src/main/java/org/eclipse/leshan/server/LeshanServer.java b/leshan-server-core/src/main/java/org/eclipse/leshan/server/LeshanServer.java index 6a45b97cc9..7c98976a75 100644 --- a/leshan-server-core/src/main/java/org/eclipse/leshan/server/LeshanServer.java +++ b/leshan-server-core/src/main/java/org/eclipse/leshan/server/LeshanServer.java @@ -17,8 +17,8 @@ *******************************************************************************/ package org.eclipse.leshan.server; -import java.util.Arrays; import java.util.Collection; +import java.util.Collections; import java.util.List; import org.eclipse.leshan.core.Destroyable; @@ -42,6 +42,7 @@ import org.eclipse.leshan.core.response.LwM2mResponse; import org.eclipse.leshan.core.response.ResponseCallback; import org.eclipse.leshan.core.util.Validate; +import org.eclipse.leshan.server.endpoint.CompositeServerEndpointsProvider; import org.eclipse.leshan.server.endpoint.LwM2mServerEndpoint; import org.eclipse.leshan.server.endpoint.LwM2mServerEndpointsProvider; import org.eclipse.leshan.server.endpoint.ServerEndpointToolbox; @@ -376,9 +377,10 @@ public LwM2mModelProvider getModelProvider() { } public Collection getEndpointsProvider() { - // TODO current we support only 1 endpoints provider but we will add support for multiple endpoints provider - // soon - return Arrays.asList(endpointsProvider); + if (endpointsProvider instanceof CompositeServerEndpointsProvider) { + return ((CompositeServerEndpointsProvider) endpointsProvider).getProviders(); + } + return Collections.singleton(endpointsProvider); } public List getEndpoints() { diff --git a/leshan-server-core/src/main/java/org/eclipse/leshan/server/LeshanServerBuilder.java b/leshan-server-core/src/main/java/org/eclipse/leshan/server/LeshanServerBuilder.java index fdda49f7f5..6edb62120c 100644 --- a/leshan-server-core/src/main/java/org/eclipse/leshan/server/LeshanServerBuilder.java +++ b/leshan-server-core/src/main/java/org/eclipse/leshan/server/LeshanServerBuilder.java @@ -23,6 +23,8 @@ import java.security.PublicKey; import java.security.cert.Certificate; import java.security.cert.X509Certificate; +import java.util.Arrays; +import java.util.Collection; import javax.security.auth.login.Configuration; @@ -35,6 +37,7 @@ import org.eclipse.leshan.core.node.codec.LwM2mEncoder; import org.eclipse.leshan.core.observation.Observation; import org.eclipse.leshan.core.request.exception.ClientSleepingException; +import org.eclipse.leshan.server.endpoint.DefaultCompositeServerEndpointsProvider; import org.eclipse.leshan.server.endpoint.LwM2mServerEndpointsProvider; import org.eclipse.leshan.server.model.LwM2mModelProvider; import org.eclipse.leshan.server.model.StandardModelProvider; @@ -82,7 +85,7 @@ public class LeshanServerBuilder { private boolean updateRegistrationOnNotification = false; private boolean updateRegistrationOnSend = false; - private LwM2mServerEndpointsProvider endpointProvider; + private LwM2mServerEndpointsProvider endpointsProvider; /** *

@@ -296,8 +299,29 @@ public LeshanServerBuilder setUpdateRegistrationOnSend(boolean updateRegistratio return this; } - public LeshanServerBuilder setEndpointsProvider(LwM2mServerEndpointsProvider endpointProvider) { - this.endpointProvider = endpointProvider; + /** + * By default LeshanServer doesn't support any protocol. Users need to provide 1 or several + * {@link LwM2mServerEndpointsProvider} implementation. + *

+ * Leshan project provides {@code coap} and {@code coaps} support based on Californium/Scandium in + * leshan-server-cf. + */ + public LeshanServerBuilder setEndpointsProviders(LwM2mServerEndpointsProvider... endpointsProvider) { + return setEndpointsProviders(Arrays.asList(endpointsProvider)); + } + + /** + * @see #setEndpointsProviders(LwM2mServerEndpointsProvider...) + */ + public LeshanServerBuilder setEndpointsProviders(Collection providers) { + if (providers == null || providers.isEmpty()) { + throw new IllegalStateException("At least one endpoint provider should be set"); + } + if (providers.size() == 1) { + this.endpointsProvider = providers.iterator().next(); + } else { + this.endpointsProvider = new DefaultCompositeServerEndpointsProvider(providers); + } return this; } @@ -335,7 +359,7 @@ public LeshanServer build() { ServerSecurityInfo serverSecurityInfo = new ServerSecurityInfo(privateKey, publicKey, certificateChain, trustedCertificates); - return createServer(endpointProvider, registrationStore, securityStore, authorizer, modelProvider, encoder, + return createServer(endpointsProvider, registrationStore, securityStore, authorizer, modelProvider, encoder, decoder, noQueueMode, awakeTimeProvider, registrationIdProvider, registrationDataExtractor, linkParser, serverSecurityInfo, updateRegistrationOnNotification, updateRegistrationOnSend); } diff --git a/leshan-server-core/src/main/java/org/eclipse/leshan/server/endpoint/CompositeServerEndpointsProvider.java b/leshan-server-core/src/main/java/org/eclipse/leshan/server/endpoint/CompositeServerEndpointsProvider.java new file mode 100644 index 0000000000..38b6f090a2 --- /dev/null +++ b/leshan-server-core/src/main/java/org/eclipse/leshan/server/endpoint/CompositeServerEndpointsProvider.java @@ -0,0 +1,33 @@ +/******************************************************************************* + * 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.server.endpoint; + +import java.util.Collection; + +/** + * A {@link LwM2mServerEndpointsProvider} composed of several internal {@link LwM2mServerEndpointsProvider}. + *

+ * Implementation should allow to use several {@link LwM2mServerEndpointsProvider}. + * + * @see DefaultCompositeServerEndpointsProvider + */ +public interface CompositeServerEndpointsProvider extends LwM2mServerEndpointsProvider { + + /** + * @return all internal {@link LwM2mServerEndpointsProvider}. + */ + Collection getProviders(); +} diff --git a/leshan-server-core/src/main/java/org/eclipse/leshan/server/endpoint/DefaultCompositeServerEndpointsProvider.java b/leshan-server-core/src/main/java/org/eclipse/leshan/server/endpoint/DefaultCompositeServerEndpointsProvider.java new file mode 100644 index 0000000000..b59252763f --- /dev/null +++ b/leshan-server-core/src/main/java/org/eclipse/leshan/server/endpoint/DefaultCompositeServerEndpointsProvider.java @@ -0,0 +1,102 @@ +/******************************************************************************* + * 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.server.endpoint; + +import java.net.URI; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import java.util.List; + +import org.eclipse.leshan.core.util.Validate; +import org.eclipse.leshan.server.LeshanServer; +import org.eclipse.leshan.server.observation.LwM2mNotificationReceiver; +import org.eclipse.leshan.server.request.UplinkRequestReceiver; +import org.eclipse.leshan.server.security.ServerSecurityInfo; + +/** + * Default implementation of {@link CompositeServerEndpointsProvider}. + *

+ * It allows to use several {@link LwM2mServerEndpointsProvider} on same Leshan server. + */ +public class DefaultCompositeServerEndpointsProvider implements CompositeServerEndpointsProvider { + + private final List providers; + + public DefaultCompositeServerEndpointsProvider(LwM2mServerEndpointsProvider... providers) { + this(Arrays.asList(providers)); + } + + public DefaultCompositeServerEndpointsProvider(Collection providers) { + Validate.notEmpty(providers); + this.providers = Collections.unmodifiableList(new ArrayList<>(providers)); + } + + @Override + public List getEndpoints() { + List endpoints = new ArrayList<>(); + for (LwM2mServerEndpointsProvider provider : providers) { + endpoints.addAll(provider.getEndpoints()); + } + return endpoints; + } + + @Override + public LwM2mServerEndpoint getEndpoint(URI uri) { + for (LwM2mServerEndpointsProvider provider : providers) { + LwM2mServerEndpoint endpoint = provider.getEndpoint(uri); + if (endpoint != null) { + return endpoint; + } + } + return null; + } + + @Override + public void createEndpoints(UplinkRequestReceiver requestReceiver, LwM2mNotificationReceiver observationService, + ServerEndpointToolbox toolbox, ServerSecurityInfo serverSecurityInfo, LeshanServer server) { + for (LwM2mServerEndpointsProvider provider : providers) { + provider.createEndpoints(requestReceiver, observationService, toolbox, serverSecurityInfo, server); + } + } + + @Override + public void start() { + for (LwM2mServerEndpointsProvider provider : providers) { + provider.start(); + } + } + + @Override + public void stop() { + for (LwM2mServerEndpointsProvider provider : providers) { + provider.stop(); + } + } + + @Override + public void destroy() { + for (LwM2mServerEndpointsProvider provider : providers) { + provider.destroy(); + } + } + + @Override + public Collection getProviders() { + return providers; + } +} diff --git a/leshan-server-demo/src/main/java/org/eclipse/leshan/server/demo/LeshanServerDemo.java b/leshan-server-demo/src/main/java/org/eclipse/leshan/server/demo/LeshanServerDemo.java index e9873ece63..e9f194df38 100644 --- a/leshan-server-demo/src/main/java/org/eclipse/leshan/server/demo/LeshanServerDemo.java +++ b/leshan-server-demo/src/main/java/org/eclipse/leshan/server/demo/LeshanServerDemo.java @@ -250,7 +250,7 @@ public static LeshanServer createLeshanServer(LeshanServerDemoCLI cli) throws Ex endpointsBuilder.addEndpoint(coapsAddr, Protocol.COAPS); // Create LWM2M server - builder.setEndpointsProvider(endpointsBuilder.build()); + builder.setEndpointsProviders(endpointsBuilder.build()); return builder.build(); } From 73b6c8615cc299b16edfd19e82df287bf88bd1d1 Mon Sep 17 00:00:00 2001 From: Simon Bernard Date: Thu, 5 Oct 2023 15:28:40 +0200 Subject: [PATCH 2/7] Add support of multiple endpoint provider at client side. --- .../CaliforniumClientEndpointsProvider.java | 2 +- .../leshan/client/LeshanClientBuilder.java | 26 +++- .../CompositeClientEndpointsProvider.java | 29 ++++ ...faultCompositeClientEndpointsProvider.java | 127 ++++++++++++++++++ .../leshan/client/demo/LeshanClientDemo.java | 2 +- .../tests/ServerOnlySecurityTest.java | 2 +- .../tests/util/LeshanTestClientBuilder.java | 6 +- 7 files changed, 185 insertions(+), 9 deletions(-) create mode 100644 leshan-client-core/src/main/java/org/eclipse/leshan/client/endpoint/CompositeClientEndpointsProvider.java create mode 100644 leshan-client-core/src/main/java/org/eclipse/leshan/client/endpoint/DefaultCompositeClientEndpointsProvider.java diff --git a/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/CaliforniumClientEndpointsProvider.java b/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/CaliforniumClientEndpointsProvider.java index 2dac882fd4..1be948c179 100644 --- a/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/CaliforniumClientEndpointsProvider.java +++ b/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/CaliforniumClientEndpointsProvider.java @@ -261,7 +261,7 @@ public CoapServer getCoapServer() { @Override public LwM2mClientEndpoint getEndpoint(LwM2mServer server) { - if (currentServer.equals(server)) { + if (currentServer != null && currentServer.equals(server)) { return endpoint; } return null; diff --git a/leshan-client-core/src/main/java/org/eclipse/leshan/client/LeshanClientBuilder.java b/leshan-client-core/src/main/java/org/eclipse/leshan/client/LeshanClientBuilder.java index 7c01f5df6f..c3d49f78ef 100644 --- a/leshan-client-core/src/main/java/org/eclipse/leshan/client/LeshanClientBuilder.java +++ b/leshan-client-core/src/main/java/org/eclipse/leshan/client/LeshanClientBuilder.java @@ -19,6 +19,7 @@ import java.security.cert.Certificate; import java.util.ArrayList; import java.util.Arrays; +import java.util.Collection; import java.util.EnumSet; import java.util.List; import java.util.Map; @@ -26,6 +27,7 @@ import org.eclipse.leshan.client.bootstrap.BootstrapConsistencyChecker; import org.eclipse.leshan.client.bootstrap.DefaultBootstrapConsistencyChecker; +import org.eclipse.leshan.client.endpoint.DefaultCompositeClientEndpointsProvider; import org.eclipse.leshan.client.endpoint.LwM2mClientEndpointsProvider; import org.eclipse.leshan.client.engine.DefaultRegistrationEngineFactory; import org.eclipse.leshan.client.engine.RegistrationEngine; @@ -266,10 +268,28 @@ public LeshanClientBuilder setSharedExecutor(ScheduledExecutorService executor) } /** - * @return the builder for fluent client creation. + * By default LeshanClient doesn't support any protocol. Users need to provide 1 or several + * {@link LwM2mClientEndpointsProvider} implementation. + *

+ * Leshan project provides {@code coap} and {@code coaps} support based on Californium/Scandium in + * leshan-client-cf. + */ + public LeshanClientBuilder setEndpointsProviders(LwM2mClientEndpointsProvider... endpointsProvider) { + return setEndpointsProviders(Arrays.asList(endpointsProvider)); + } + + /** + * @see #setEndpointsProviders(LwM2mClientEndpointsProvider...) */ - public LeshanClientBuilder setEndpointsProvider(LwM2mClientEndpointsProvider endpointsProvider) { - this.endpointsProvider = endpointsProvider; + public LeshanClientBuilder setEndpointsProviders(Collection providers) { + if (providers == null || providers.isEmpty()) { + throw new IllegalStateException("At least one endpoint provider should be set"); + } + if (providers.size() == 1) { + endpointsProvider = providers.iterator().next(); + } else { + endpointsProvider = new DefaultCompositeClientEndpointsProvider(providers); + } return this; } diff --git a/leshan-client-core/src/main/java/org/eclipse/leshan/client/endpoint/CompositeClientEndpointsProvider.java b/leshan-client-core/src/main/java/org/eclipse/leshan/client/endpoint/CompositeClientEndpointsProvider.java new file mode 100644 index 0000000000..dd9d1e742c --- /dev/null +++ b/leshan-client-core/src/main/java/org/eclipse/leshan/client/endpoint/CompositeClientEndpointsProvider.java @@ -0,0 +1,29 @@ +/******************************************************************************* + * 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.client.endpoint; + +import java.util.Collection; + +/** + * A {@link LwM2mClientEndpointsProvider} composed of several internal {@link LwM2mClientEndpointsProvider}. + *

+ * Implementation should allow to use several {@link LwM2mClientEndpointsProvider}. + * + * @see DefaultCompositeClientEndpointsProvider + */ +public interface CompositeClientEndpointsProvider extends LwM2mClientEndpointsProvider { + Collection getProviders(); +} diff --git a/leshan-client-core/src/main/java/org/eclipse/leshan/client/endpoint/DefaultCompositeClientEndpointsProvider.java b/leshan-client-core/src/main/java/org/eclipse/leshan/client/endpoint/DefaultCompositeClientEndpointsProvider.java new file mode 100644 index 0000000000..64e8192e12 --- /dev/null +++ b/leshan-client-core/src/main/java/org/eclipse/leshan/client/endpoint/DefaultCompositeClientEndpointsProvider.java @@ -0,0 +1,127 @@ +/******************************************************************************* + * 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.client.endpoint; + +import java.security.cert.Certificate; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import java.util.List; + +import org.eclipse.leshan.client.request.DownlinkRequestReceiver; +import org.eclipse.leshan.client.resource.LwM2mObjectTree; +import org.eclipse.leshan.client.servers.LwM2mServer; +import org.eclipse.leshan.client.servers.ServerInfo; + +/** + * Default implementation of {@link CompositeClientEndpointsProvider}. + *

+ * It allows to use several {@link LwM2mClientEndpointsProvider} on same Leshan server. + */ +public class DefaultCompositeClientEndpointsProvider implements CompositeClientEndpointsProvider { + + private final List providers; + + public DefaultCompositeClientEndpointsProvider(LwM2mClientEndpointsProvider... providers) { + this(Arrays.asList(providers)); + } + + public DefaultCompositeClientEndpointsProvider(Collection providers) { + this.providers = Collections.unmodifiableList(new ArrayList<>(providers)); + } + + @Override + public void init(LwM2mObjectTree objectTree, DownlinkRequestReceiver requestReceiver, + ClientEndpointToolbox toolbox) { + for (LwM2mClientEndpointsProvider provider : providers) { + provider.init(objectTree, requestReceiver, toolbox); + } + } + + @Override + public LwM2mServer createEndpoint(ServerInfo serverInfo, boolean clientInitiatedOnly, List trustStore, + ClientEndpointToolbox toolbox) { + for (LwM2mClientEndpointsProvider provider : providers) { + LwM2mServer server = provider.createEndpoint(serverInfo, clientInitiatedOnly, trustStore, toolbox); + if (server != null) { + return server; + } + } + return null; + } + + @Override + public Collection createEndpoints(Collection serverInfo, + boolean clientInitiatedOnly, List trustStore, ClientEndpointToolbox toolbox) { + // not implemented yet ... + return null; + } + + @Override + public void destroyEndpoints() { + for (LwM2mClientEndpointsProvider provider : providers) { + provider.destroyEndpoints(); + } + } + + @Override + public void start() { + for (LwM2mClientEndpointsProvider provider : providers) { + provider.start(); + } + } + + @Override + public List getEndpoints() { + List endpoints = new ArrayList<>(); + for (LwM2mClientEndpointsProvider provider : providers) { + endpoints.addAll(provider.getEndpoints()); + } + return endpoints; + } + + @Override + public LwM2mClientEndpoint getEndpoint(LwM2mServer server) { + for (LwM2mClientEndpointsProvider provider : providers) { + LwM2mClientEndpoint endpoint = provider.getEndpoint(server); + if (endpoint != null) { + return endpoint; + } + } + return null; + } + + @Override + public void stop() { + for (LwM2mClientEndpointsProvider provider : providers) { + provider.stop(); + } + + } + + @Override + public void destroy() { + for (LwM2mClientEndpointsProvider provider : providers) { + provider.destroy(); + } + } + + @Override + public Collection getProviders() { + return providers; + } +} diff --git a/leshan-client-demo/src/main/java/org/eclipse/leshan/client/demo/LeshanClientDemo.java b/leshan-client-demo/src/main/java/org/eclipse/leshan/client/demo/LeshanClientDemo.java index bcef53caeb..03045c1a60 100644 --- a/leshan-client-demo/src/main/java/org/eclipse/leshan/client/demo/LeshanClientDemo.java +++ b/leshan-client-demo/src/main/java/org/eclipse/leshan/client/demo/LeshanClientDemo.java @@ -291,7 +291,7 @@ protected DtlsConnectorConfig.Builder createRootDtlsConnectorConfigBuilder( // Create client LeshanClientBuilder builder = new LeshanClientBuilder(cli.main.endpoint); builder.setObjects(enablers); - builder.setEndpointsProvider(endpointsBuilder.build()); + builder.setEndpointsProviders(endpointsBuilder.build()); builder.setDataSenders(new ManualDataSender()); if (cli.identity.isx509()) builder.setTrustStore(cli.identity.getX509().trustStore); diff --git a/leshan-integration-tests/src/test/java/org/eclipse/leshan/integration/tests/ServerOnlySecurityTest.java b/leshan-integration-tests/src/test/java/org/eclipse/leshan/integration/tests/ServerOnlySecurityTest.java index ad8d7926d3..8e64c8744b 100644 --- a/leshan-integration-tests/src/test/java/org/eclipse/leshan/integration/tests/ServerOnlySecurityTest.java +++ b/leshan-integration-tests/src/test/java/org/eclipse/leshan/integration/tests/ServerOnlySecurityTest.java @@ -147,7 +147,7 @@ protected Builder createEffectiveDtlsConnectorConfigBuilder(InetSocketAddress ad }; CaliforniumClientEndpointsProvider endpointsProvider = new CaliforniumClientEndpointsProvider.Builder( coapsProtocolProvider).build(); - givenClient.setEndpointsProvider(endpointsProvider); + givenClient.setEndpointsProviders(endpointsProvider); } @AfterEach diff --git a/leshan-integration-tests/src/test/java/org/eclipse/leshan/integration/tests/util/LeshanTestClientBuilder.java b/leshan-integration-tests/src/test/java/org/eclipse/leshan/integration/tests/util/LeshanTestClientBuilder.java index aa04b0190b..1145ce3935 100644 --- a/leshan-integration-tests/src/test/java/org/eclipse/leshan/integration/tests/util/LeshanTestClientBuilder.java +++ b/leshan-integration-tests/src/test/java/org/eclipse/leshan/integration/tests/util/LeshanTestClientBuilder.java @@ -248,17 +248,17 @@ public static LeshanTestClientBuilder givenClient() { } public LeshanTestClientBuilder with(LwM2mClientEndpointsProvider endpointsProvider) { - setEndpointsProvider(endpointsProvider); + setEndpointsProviders(endpointsProvider); return this; } public LeshanTestClientBuilder with(String endpointProvider) { if (endpointProvider.equals("Californium")) { - setEndpointsProvider( + setEndpointsProviders( new CaliforniumClientEndpointsProvider.Builder(getCaliforniumProtocolProvider(protocolToUse)) .build()); } else if (endpointProvider.equals("Californium-OSCORE")) { - setEndpointsProvider(new CaliforniumClientEndpointsProvider.Builder( + setEndpointsProviders(new CaliforniumClientEndpointsProvider.Builder( getCaliforniumProtocolProviderSupportingOscore(protocolToUse)).build()); } return this; From cd722fa0cacea4ebc83b2db769e22e071a7d9265 Mon Sep 17 00:00:00 2001 From: Simon Bernard Date: Mon, 9 Oct 2023 17:05:54 +0200 Subject: [PATCH 3/7] Add support of multiple endpoint provider at bootstrap server side. --- .../demo/LeshanBootstrapServerDemo.java | 2 +- .../LeshanBootstrapServerBuilderTest.java | 10 +- .../bootstrap/LeshanBootstrapServerTest.java | 2 +- .../bootstrap/LeshanBootstrapServer.java | 11 +- .../LeshanBootstrapServerBuilder.java | 30 +++++- ...ositeBootstrapServerEndpointsProvider.java | 36 +++++++ ...ositeBootstrapServerEndpointsProvider.java | 102 ++++++++++++++++++ 7 files changed, 180 insertions(+), 13 deletions(-) create mode 100644 leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/endpoint/CompositeBootstrapServerEndpointsProvider.java create mode 100644 leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/endpoint/DefaultCompositeBootstrapServerEndpointsProvider.java diff --git a/leshan-bsserver-demo/src/main/java/org/eclipse/leshan/server/bootstrap/demo/LeshanBootstrapServerDemo.java b/leshan-bsserver-demo/src/main/java/org/eclipse/leshan/server/bootstrap/demo/LeshanBootstrapServerDemo.java index e36bf88e0f..58076931e8 100755 --- a/leshan-bsserver-demo/src/main/java/org/eclipse/leshan/server/bootstrap/demo/LeshanBootstrapServerDemo.java +++ b/leshan-bsserver-demo/src/main/java/org/eclipse/leshan/server/bootstrap/demo/LeshanBootstrapServerDemo.java @@ -199,7 +199,7 @@ public static LeshanBootstrapServer createBsLeshanServer(LeshanBsServerDemoCLI c endpointsBuilder.addEndpoint(coapsAddr, Protocol.COAPS); // Create LWM2M server - builder.setEndpointsProvider(endpointsBuilder.build()); + builder.setEndpointsProviders(endpointsBuilder.build()); return builder.build(); } diff --git a/leshan-server-cf/src/test/java/org/eclipse/leshan/server/californium/bootstrap/LeshanBootstrapServerBuilderTest.java b/leshan-server-cf/src/test/java/org/eclipse/leshan/server/californium/bootstrap/LeshanBootstrapServerBuilderTest.java index c5a33556f6..d70be2fd24 100644 --- a/leshan-server-cf/src/test/java/org/eclipse/leshan/server/californium/bootstrap/LeshanBootstrapServerBuilderTest.java +++ b/leshan-server-cf/src/test/java/org/eclipse/leshan/server/californium/bootstrap/LeshanBootstrapServerBuilderTest.java @@ -104,7 +104,7 @@ public BootstrapConfig get(BootstrapSession session) { @Test public void create_server_with_default_californiumEndpointsProvider() { - builder.setEndpointsProvider(new CaliforniumBootstrapServerEndpointsProvider()); + builder.setEndpointsProviders(new CaliforniumBootstrapServerEndpointsProvider()); server = builder.build(); assertEquals(1, server.getEndpoints().size()); @@ -115,7 +115,7 @@ public void create_server_with_default_californiumEndpointsProvider() { public void create_server_without_securityStore() { Builder endpointsBuilder = new CaliforniumBootstrapServerEndpointsProvider.Builder( new CoapBootstrapServerProtocolProvider(), new CoapsBootstrapServerProtocolProvider()); - builder.setEndpointsProvider(endpointsBuilder.build()); + builder.setEndpointsProviders(endpointsBuilder.build()); server = builder.build(); assertEquals(1, server.getEndpoints().size()); @@ -127,7 +127,7 @@ public void create_server_without_securityStore() { public void create_server_with_securityStore() { Builder endpointsBuilder = new CaliforniumBootstrapServerEndpointsProvider.Builder( new CoapBootstrapServerProtocolProvider(), new CoapsBootstrapServerProtocolProvider()); - builder.setEndpointsProvider(endpointsBuilder.build()); + builder.setEndpointsProviders(endpointsBuilder.build()); builder.setSecurityStore(new BootstrapSecurityStore() { @Override public SecurityInfo getByIdentity(String pskIdentity) { @@ -156,7 +156,7 @@ public SecurityInfo getByOscoreIdentity(OscoreIdentity oscoreIdentity) { public void create_server_with_coaps_only() { Builder endpointsBuilder = new CaliforniumBootstrapServerEndpointsProvider.Builder( new CoapsBootstrapServerProtocolProvider()); - builder.setEndpointsProvider(endpointsBuilder.build()); + builder.setEndpointsProviders(endpointsBuilder.build()); builder.setSecurityStore(new BootstrapSecurityStore() { @Override public SecurityInfo getByIdentity(String pskIdentity) { @@ -187,7 +187,7 @@ public void create_server_without_psk_cipher() { endpointsBuilder.setConfiguration(c -> { c.setAsList(DtlsConfig.DTLS_CIPHER_SUITES, CipherSuite.TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8); }); - builder.setEndpointsProvider(endpointsBuilder.build()); + builder.setEndpointsProviders(endpointsBuilder.build()); builder.setPrivateKey(privateKey); builder.setPublicKey(publicKey); diff --git a/leshan-server-cf/src/test/java/org/eclipse/leshan/server/californium/bootstrap/LeshanBootstrapServerTest.java b/leshan-server-cf/src/test/java/org/eclipse/leshan/server/californium/bootstrap/LeshanBootstrapServerTest.java index b6c4412f8b..7d1b7616a3 100644 --- a/leshan-server-cf/src/test/java/org/eclipse/leshan/server/californium/bootstrap/LeshanBootstrapServerTest.java +++ b/leshan-server-cf/src/test/java/org/eclipse/leshan/server/californium/bootstrap/LeshanBootstrapServerTest.java @@ -63,7 +63,7 @@ public BootstrapConfig get(BootstrapSession session) { return config; } }); - builder.setEndpointsProvider(new CaliforniumBootstrapServerEndpointsProvider()); + builder.setEndpointsProviders(new CaliforniumBootstrapServerEndpointsProvider()); return builder.build(); } diff --git a/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/LeshanBootstrapServer.java b/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/LeshanBootstrapServer.java index 82377a998e..f451842a12 100644 --- a/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/LeshanBootstrapServer.java +++ b/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/LeshanBootstrapServer.java @@ -16,8 +16,8 @@ *******************************************************************************/ package org.eclipse.leshan.server.bootstrap; -import java.util.Arrays; import java.util.Collection; +import java.util.Collections; import java.util.List; import org.eclipse.leshan.core.Destroyable; @@ -29,11 +29,13 @@ import org.eclipse.leshan.core.node.codec.LwM2mEncoder; import org.eclipse.leshan.core.util.Validate; import org.eclipse.leshan.server.bootstrap.endpoint.BootstrapServerEndpointToolbox; +import org.eclipse.leshan.server.bootstrap.endpoint.CompositeBootstrapServerEndpointsProvider; import org.eclipse.leshan.server.bootstrap.endpoint.LwM2mBootstrapServerEndpoint; import org.eclipse.leshan.server.bootstrap.endpoint.LwM2mBootstrapServerEndpointsProvider; import org.eclipse.leshan.server.bootstrap.request.BootstrapDownlinkRequestSender; import org.eclipse.leshan.server.bootstrap.request.DefaultBootstrapDownlinkRequestSender; import org.eclipse.leshan.server.bootstrap.request.DefaultBootstrapUplinkRequestReceiver; +import org.eclipse.leshan.server.endpoint.CompositeServerEndpointsProvider; import org.eclipse.leshan.server.security.BootstrapSecurityStore; import org.eclipse.leshan.server.security.ServerSecurityInfo; import org.slf4j.Logger; @@ -148,9 +150,10 @@ public List getEndpoints() { } public Collection getEndpointsProvider() { - // TODO current we support only 1 endpoints provider but we will add support for multiple endpoints provider - // soon - return Arrays.asList(endpointsProvider); + if (endpointsProvider instanceof CompositeServerEndpointsProvider) { + return ((CompositeBootstrapServerEndpointsProvider) endpointsProvider).getProviders(); + } + return Collections.singleton(endpointsProvider); } public LwM2mBootstrapServerEndpoint getEndpoint(Protocol protocol) { diff --git a/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/LeshanBootstrapServerBuilder.java b/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/LeshanBootstrapServerBuilder.java index d659ba90ed..0fca22bfb2 100644 --- a/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/LeshanBootstrapServerBuilder.java +++ b/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/LeshanBootstrapServerBuilder.java @@ -21,6 +21,8 @@ import java.security.PublicKey; import java.security.cert.Certificate; import java.security.cert.X509Certificate; +import java.util.Arrays; +import java.util.Collection; import org.eclipse.leshan.core.link.lwm2m.DefaultLwM2mLinkParser; import org.eclipse.leshan.core.link.lwm2m.LwM2mLinkParser; @@ -29,6 +31,7 @@ import org.eclipse.leshan.core.node.codec.DefaultLwM2mEncoder; import org.eclipse.leshan.core.node.codec.LwM2mDecoder; import org.eclipse.leshan.core.node.codec.LwM2mEncoder; +import org.eclipse.leshan.server.bootstrap.endpoint.DefaultCompositeBootstrapServerEndpointsProvider; import org.eclipse.leshan.server.bootstrap.endpoint.LwM2mBootstrapServerEndpointsProvider; import org.eclipse.leshan.server.bootstrap.request.BootstrapDownlinkRequestSender; import org.eclipse.leshan.server.model.LwM2mBootstrapModelProvider; @@ -255,8 +258,31 @@ public LeshanBootstrapServerBuilder setAuthorizer(BootstrapAuthorizer authorizer return this; } - public LeshanBootstrapServerBuilder setEndpointsProvider(LwM2mBootstrapServerEndpointsProvider endpointsProvider) { - this.endpointsProvider = endpointsProvider; + /** + * By default LeshanBootstrapServer doesn't support any protocol. Users need to provide 1 or several + * {@link LwM2mBootstrapServerEndpointsProvider} implementation. + *

+ * Leshan project provides {@code coap} and {@code coaps} support based on Californium/Scandium in + * leshan-server-cf. + */ + public LeshanBootstrapServerBuilder setEndpointsProviders( + LwM2mBootstrapServerEndpointsProvider... endpointsProvider) { + return setEndpointsProviders(Arrays.asList(endpointsProvider)); + } + + /** + * @see #setEndpointsProviders(LwM2mBootstrapServerEndpointsProvider...) + */ + public LeshanBootstrapServerBuilder setEndpointsProviders( + Collection providers) { + if (providers == null || providers.isEmpty()) { + throw new IllegalStateException("At least one endpoint provider should be set"); + } + if (providers.size() == 1) { + this.endpointsProvider = providers.iterator().next(); + } else { + this.endpointsProvider = new DefaultCompositeBootstrapServerEndpointsProvider(providers); + } return this; } diff --git a/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/endpoint/CompositeBootstrapServerEndpointsProvider.java b/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/endpoint/CompositeBootstrapServerEndpointsProvider.java new file mode 100644 index 0000000000..35926b4621 --- /dev/null +++ b/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/endpoint/CompositeBootstrapServerEndpointsProvider.java @@ -0,0 +1,36 @@ +/******************************************************************************* + * 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.server.bootstrap.endpoint; + +import java.util.Collection; + +import org.eclipse.leshan.server.endpoint.LwM2mServerEndpointsProvider; + +/** + * A {@link LwM2mBootstrapServerEndpointsProvider} composed of several internal + * {@link LwM2mBootstrapServerEndpointsProvider}. + *

+ * Implementation should allow to use several {@link LwM2mBootstrapServerEndpointsProvider}. + * + * @see DefaultCompositeBootstrapServerEndpointsProvider + */ +public interface CompositeBootstrapServerEndpointsProvider extends LwM2mBootstrapServerEndpointsProvider { + + /** + * @return all internal {@link LwM2mServerEndpointsProvider}. + */ + Collection getProviders(); +} diff --git a/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/endpoint/DefaultCompositeBootstrapServerEndpointsProvider.java b/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/endpoint/DefaultCompositeBootstrapServerEndpointsProvider.java new file mode 100644 index 0000000000..7257a8f17b --- /dev/null +++ b/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/endpoint/DefaultCompositeBootstrapServerEndpointsProvider.java @@ -0,0 +1,102 @@ +/******************************************************************************* + * 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.server.bootstrap.endpoint; + +import java.net.URI; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import java.util.List; + +import org.eclipse.leshan.core.util.Validate; +import org.eclipse.leshan.server.bootstrap.LeshanBootstrapServer; +import org.eclipse.leshan.server.bootstrap.request.BootstrapUplinkRequestReceiver; +import org.eclipse.leshan.server.security.ServerSecurityInfo; + +/** + * Default implementation of {@link CompositeBootstrapServerEndpointsProvider}. + *

+ * It allows to use several {@link LwM2mBootstrapServerEndpointsProvider} on same Leshan server. + */ +public class DefaultCompositeBootstrapServerEndpointsProvider implements CompositeBootstrapServerEndpointsProvider { + + private final List providers; + + public DefaultCompositeBootstrapServerEndpointsProvider(LwM2mBootstrapServerEndpointsProvider... providers) { + this(Arrays.asList(providers)); + } + + public DefaultCompositeBootstrapServerEndpointsProvider( + Collection providers) { + Validate.notEmpty(providers); + this.providers = Collections.unmodifiableList(new ArrayList<>(providers)); + } + + @Override + public List getEndpoints() { + List endpoints = new ArrayList<>(); + for (LwM2mBootstrapServerEndpointsProvider provider : providers) { + endpoints.addAll(provider.getEndpoints()); + } + return endpoints; + } + + @Override + public LwM2mBootstrapServerEndpoint getEndpoint(URI uri) { + for (LwM2mBootstrapServerEndpointsProvider provider : providers) { + LwM2mBootstrapServerEndpoint endpoint = provider.getEndpoint(uri); + if (endpoint != null) { + return endpoint; + } + } + return null; + } + + @Override + public void createEndpoints(BootstrapUplinkRequestReceiver requestReceiver, BootstrapServerEndpointToolbox toolbox, + ServerSecurityInfo serverSecurityInfo, LeshanBootstrapServer server) { + for (LwM2mBootstrapServerEndpointsProvider provider : providers) { + provider.createEndpoints(requestReceiver, toolbox, serverSecurityInfo, server); + } + } + + @Override + public void start() { + for (LwM2mBootstrapServerEndpointsProvider provider : providers) { + provider.start(); + } + } + + @Override + public void stop() { + for (LwM2mBootstrapServerEndpointsProvider provider : providers) { + provider.stop(); + } + } + + @Override + public void destroy() { + for (LwM2mBootstrapServerEndpointsProvider provider : providers) { + provider.destroy(); + } + } + + @Override + public Collection getProviders() { + return providers; + } +} From 89efce7957b751354f8b7fb816430f5d8967ce2c Mon Sep 17 00:00:00 2001 From: Simon Bernard Date: Fri, 6 Oct 2023 18:29:51 +0200 Subject: [PATCH 4/7] Add description to LwM2mServerEndpoint --- .../endpoint/CaliforniumServerEndpoint.java | 15 +++++++++++---- .../CaliforniumServerEndpointFactory.java | 2 ++ .../CaliforniumServerEndpointsProvider.java | 4 ++-- .../coap/CoapOscoreServerEndpointFactory.java | 5 +++++ .../endpoint/coap/CoapServerEndpointFactory.java | 5 +++++ .../coaps/CoapsServerEndpointFactory.java | 5 +++++ .../observation/ObservationServiceTest.java | 5 +++++ .../org/eclipse/leshan/server/LeshanServer.java | 2 +- .../server/endpoint/LwM2mServerEndpoint.java | 2 ++ 9 files changed, 38 insertions(+), 7 deletions(-) diff --git a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/CaliforniumServerEndpoint.java b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/CaliforniumServerEndpoint.java index f47f39e488..1c56d79224 100644 --- a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/CaliforniumServerEndpoint.java +++ b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/CaliforniumServerEndpoint.java @@ -51,6 +51,7 @@ public class CaliforniumServerEndpoint implements LwM2mServerEndpoint { private final Protocol protocol; + private final String description; private final ScheduledExecutorService executor; private final CoapEndpoint endpoint; private final ServerEndpointToolbox toolbox; @@ -63,11 +64,12 @@ public class CaliforniumServerEndpoint implements LwM2mServerEndpoint { // This is used to be able to cancel request private final ConcurrentNavigableMap ongoingRequests = new ConcurrentSkipListMap<>(); - public CaliforniumServerEndpoint(Protocol protocol, CoapEndpoint endpoint, ServerCoapMessageTranslator translator, - ServerEndpointToolbox toolbox, LwM2mNotificationReceiver notificationReceiver, - IdentityHandler identityHandler, ExceptionTranslator exceptionTranslator, - ScheduledExecutorService executor) { + public CaliforniumServerEndpoint(Protocol protocol, String description, CoapEndpoint endpoint, + ServerCoapMessageTranslator translator, ServerEndpointToolbox toolbox, + LwM2mNotificationReceiver notificationReceiver, IdentityHandler identityHandler, + ExceptionTranslator exceptionTranslator, ScheduledExecutorService executor) { this.protocol = protocol; + this.description = description; this.translator = translator; this.toolbox = toolbox; this.endpoint = endpoint; @@ -87,6 +89,11 @@ public URI getURI() { return EndpointUriUtil.createUri(protocol.getUriScheme(), endpoint.getAddress()); } + @Override + public String getDescription() { + return description; + } + public CoapEndpoint getCoapEndpoint() { return endpoint; } diff --git a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/CaliforniumServerEndpointFactory.java b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/CaliforniumServerEndpointFactory.java index c1cb1d4ab5..b1aae04788 100644 --- a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/CaliforniumServerEndpointFactory.java +++ b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/CaliforniumServerEndpointFactory.java @@ -32,6 +32,8 @@ public interface CaliforniumServerEndpointFactory { URI getUri(); + String getEndpointDescription(); + CoapEndpoint createCoapEndpoint(Configuration defaultCaliforniumConfiguration, ServerSecurityInfo serverSecurityInfo, LwM2mNotificationReceiver notificationReceiver, LeshanServer server); diff --git a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/CaliforniumServerEndpointsProvider.java b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/CaliforniumServerEndpointsProvider.java index a2af997b0d..28425c3c3d 100644 --- a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/CaliforniumServerEndpointsProvider.java +++ b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/CaliforniumServerEndpointsProvider.java @@ -138,8 +138,8 @@ protected Resource createRoot() { // create LWM2M endpoint CaliforniumServerEndpoint lwm2mEndpoint = new CaliforniumServerEndpoint(endpointFactory.getProtocol(), - coapEndpoint, messagetranslator, toolbox, notificatonReceiver, identityHandler, - exceptionTranslator, executor); + endpointFactory.getEndpointDescription(), coapEndpoint, messagetranslator, toolbox, + notificatonReceiver, identityHandler, exceptionTranslator, executor); endpoints.add(lwm2mEndpoint); // add Californium endpoint to coap server diff --git a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/coap/CoapOscoreServerEndpointFactory.java b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/coap/CoapOscoreServerEndpointFactory.java index 3e5df1d6b6..b299731e0c 100644 --- a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/coap/CoapOscoreServerEndpointFactory.java +++ b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/coap/CoapOscoreServerEndpointFactory.java @@ -49,6 +49,11 @@ public CoapOscoreServerEndpointFactory(URI uri) { super(uri); } + @Override + public String getEndpointDescription() { + return super.getEndpointDescription() + " with very experimental support of OSCORE"; + } + /** * This method is intended to be overridden. * diff --git a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/coap/CoapServerEndpointFactory.java b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/coap/CoapServerEndpointFactory.java index 9b54b463c6..bbb3e91777 100644 --- a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/coap/CoapServerEndpointFactory.java +++ b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/coap/CoapServerEndpointFactory.java @@ -84,6 +84,11 @@ public Protocol getProtocol() { return getSupportedProtocol(); } + @Override + public String getEndpointDescription() { + return "CoAP over UDP endpoint based on Californium library"; + } + @Override public URI getUri() { return endpointUri; diff --git a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/coaps/CoapsServerEndpointFactory.java b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/coaps/CoapsServerEndpointFactory.java index a88524ed36..35d4aee219 100644 --- a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/coaps/CoapsServerEndpointFactory.java +++ b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/endpoint/coaps/CoapsServerEndpointFactory.java @@ -94,6 +94,11 @@ public static Protocol getSupportedProtocol() { return Protocol.COAPS; } + @Override + public String getEndpointDescription() { + return "CoAP over DTLS endpoint based on Californium/Scandium library"; + } + public static void applyDefaultValue(Configuration configuration) { configuration.set(CoapConfig.MID_TRACKER, TrackerMode.NULL); // Do no allow Server to initiated Handshake by default, for U device request will be allowed to initiate diff --git a/leshan-server-cf/src/test/java/org/eclipse/leshan/server/californium/observation/ObservationServiceTest.java b/leshan-server-cf/src/test/java/org/eclipse/leshan/server/californium/observation/ObservationServiceTest.java index 8bbbbd13b4..c97aca5560 100644 --- a/leshan-server-cf/src/test/java/org/eclipse/leshan/server/californium/observation/ObservationServiceTest.java +++ b/leshan-server-cf/src/test/java/org/eclipse/leshan/server/californium/observation/ObservationServiceTest.java @@ -213,6 +213,11 @@ public URI getURI() { return null; } + @Override + public String getDescription() { + return null; + } + @Override public Protocol getProtocol() { return null; diff --git a/leshan-server-core/src/main/java/org/eclipse/leshan/server/LeshanServer.java b/leshan-server-core/src/main/java/org/eclipse/leshan/server/LeshanServer.java index 7c98976a75..1a865cf2ef 100644 --- a/leshan-server-core/src/main/java/org/eclipse/leshan/server/LeshanServer.java +++ b/leshan-server-core/src/main/java/org/eclipse/leshan/server/LeshanServer.java @@ -261,7 +261,7 @@ public void start() { if (LOG.isInfoEnabled()) { LOG.info("LWM2M server started."); for (LwM2mServerEndpoint endpoint : endpointsProvider.getEndpoints()) { - LOG.info("{} endpoint available at {}.", endpoint.getProtocol().getName(), endpoint.getURI()); + LOG.info("{} available at {}.", endpoint.getDescription(), endpoint.getURI()); } } } diff --git a/leshan-server-core/src/main/java/org/eclipse/leshan/server/endpoint/LwM2mServerEndpoint.java b/leshan-server-core/src/main/java/org/eclipse/leshan/server/endpoint/LwM2mServerEndpoint.java index 2710792287..7ea72f7ccb 100644 --- a/leshan-server-core/src/main/java/org/eclipse/leshan/server/endpoint/LwM2mServerEndpoint.java +++ b/leshan-server-core/src/main/java/org/eclipse/leshan/server/endpoint/LwM2mServerEndpoint.java @@ -32,6 +32,8 @@ public interface LwM2mServerEndpoint { URI getURI(); + String getDescription(); + T send(ClientProfile destination, DownlinkRequest request, LowerLayerConfig lowerLayerConfig, long timeoutInMs) throws InterruptedException; From d561e9e65415ad13b5d54d70e2086065db878361 Mon Sep 17 00:00:00 2001 From: Simon Bernard Date: Mon, 9 Oct 2023 17:35:47 +0200 Subject: [PATCH 5/7] Add description to LwM2mClientEndpoint --- .../endpoint/CaliforniumClientEndpoint.java | 12 +++++++++--- .../endpoint/CaliforniumClientEndpointFactory.java | 3 ++- .../endpoint/CaliforniumClientEndpointsProvider.java | 11 ++++++----- .../endpoint/coap/CoapClientEndpointFactory.java | 5 +++++ .../coap/CoapOscoreClientEndpointFactory.java | 5 +++++ .../endpoint/coaps/CoapsClientEndpointFactory.java | 5 +++++ .../leshan/client/endpoint/LwM2mClientEndpoint.java | 2 ++ 7 files changed, 34 insertions(+), 9 deletions(-) diff --git a/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/CaliforniumClientEndpoint.java b/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/CaliforniumClientEndpoint.java index 99fa3f9922..109f800e9b 100644 --- a/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/CaliforniumClientEndpoint.java +++ b/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/CaliforniumClientEndpoint.java @@ -48,6 +48,7 @@ public class CaliforniumClientEndpoint implements LwM2mClientEndpoint { private final Logger LOG = LoggerFactory.getLogger(CaliforniumClientEndpoint.class); private final Protocol protocol; + private final String description; private final ScheduledExecutorService executor; private final CoapEndpoint endpoint; private final ClientEndpointToolbox toolbox; @@ -57,11 +58,12 @@ public class CaliforniumClientEndpoint implements LwM2mClientEndpoint { private final LwM2mModel model; private final ExceptionTranslator exceptionTranslator; - public CaliforniumClientEndpoint(Protocol protocol, CoapEndpoint endpoint, ClientCoapMessageTranslator translator, - ClientEndpointToolbox toolbox, IdentityHandler identityHandler, + public CaliforniumClientEndpoint(Protocol protocol, String description, CoapEndpoint endpoint, + ClientCoapMessageTranslator translator, ClientEndpointToolbox toolbox, IdentityHandler identityHandler, CaliforniumConnectionController connectionController, LwM2mModel model, ExceptionTranslator exceptionTranslator, ScheduledExecutorService executor) { this.protocol = protocol; + this.description = description; this.translator = translator; this.toolbox = toolbox; this.endpoint = endpoint; @@ -84,11 +86,15 @@ public URI getURI() { getCoapEndpoint().getAddress().getPort(), null, null, null); } catch (URISyntaxException e) { // TODO TL : handle this properly - e.printStackTrace(); throw new IllegalStateException(e); } } + @Override + public String getDescription() { + return description; + } + @Override public long getMaxCommunicationPeriodFor(long lifetimeInMs) { // See https://github.com/OpenMobileAlliance/OMA_LwM2M_for_Developers/issues/283 to better understand. diff --git a/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/CaliforniumClientEndpointFactory.java b/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/CaliforniumClientEndpointFactory.java index c89426dd48..fccf8fad29 100644 --- a/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/CaliforniumClientEndpointFactory.java +++ b/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/CaliforniumClientEndpointFactory.java @@ -32,6 +32,8 @@ public interface CaliforniumClientEndpointFactory { Protocol getProtocol(); + String getEndpointDescription(); + CoapEndpoint createCoapEndpoint(InetAddress clientAddress, Configuration defaultConfiguration, ServerInfo serverInfo, boolean clientInitiatedOnly, List trustStore, ClientEndpointToolbox toolbox); @@ -41,5 +43,4 @@ CoapEndpoint createCoapEndpoint(InetAddress clientAddress, Configuration default IdentityHandler createIdentityHandler(); ExceptionTranslator createExceptionTranslator(); - } diff --git a/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/CaliforniumClientEndpointsProvider.java b/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/CaliforniumClientEndpointsProvider.java index 1be948c179..926b82b434 100644 --- a/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/CaliforniumClientEndpointsProvider.java +++ b/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/CaliforniumClientEndpointsProvider.java @@ -182,9 +182,10 @@ public LwM2mServer createEndpoint(ServerInfo serverInfo, boolean clientInitiated identityHandlerProvider.addIdentityHandler(coapEndpoint, identityHandler); // create LWM2M endpoint - endpoint = new CaliforniumClientEndpoint(endpointFactory.getProtocol(), coapEndpoint, - messagetranslator, toolbox, identityHandler, endpointFactory.createConnectionController(), - objectTree.getModel(), endpointFactory.createExceptionTranslator(), executor); + endpoint = new CaliforniumClientEndpoint(endpointFactory.getProtocol(), + endpointFactory.getEndpointDescription(), coapEndpoint, messagetranslator, toolbox, + identityHandler, endpointFactory.createConnectionController(), objectTree.getModel(), + endpointFactory.createExceptionTranslator(), executor); // add Californium endpoint to coap server coapServer.addEndpoint(coapEndpoint); @@ -194,8 +195,8 @@ public LwM2mServer createEndpoint(ServerInfo serverInfo, boolean clientInitiated coapServer.start(); try { coapEndpoint.start(); - LOG.info("New endpoint created for server {} at {}", currentServer.getUri(), - coapEndpoint.getUri()); + LOG.info("New {} created, \n for server {} at {}.", endpoint.getDescription(), + currentServer.getUri(), coapEndpoint.getUri()); } catch (IOException e) { throw new RuntimeException("Unable to start endpoint", e); } diff --git a/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/coap/CoapClientEndpointFactory.java b/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/coap/CoapClientEndpointFactory.java index bd75d0504f..f61afa4c9e 100644 --- a/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/coap/CoapClientEndpointFactory.java +++ b/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/coap/CoapClientEndpointFactory.java @@ -56,6 +56,11 @@ public Protocol getProtocol() { return Protocol.COAP; } + @Override + public String getEndpointDescription() { + return "CoAP over UDP endpoint based on Californium library"; + } + protected String getLoggingTag(URI uri) { if (loggingTagPrefix != null) { return String.format("[%s-%s]", loggingTagPrefix, uri); diff --git a/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/coap/CoapOscoreClientEndpointFactory.java b/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/coap/CoapOscoreClientEndpointFactory.java index f6719e5437..6b6ac0cf80 100644 --- a/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/coap/CoapOscoreClientEndpointFactory.java +++ b/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/coap/CoapOscoreClientEndpointFactory.java @@ -51,6 +51,11 @@ public class CoapOscoreClientEndpointFactory extends CoapClientEndpointFactory { private static final Logger LOG = LoggerFactory.getLogger(CoapOscoreClientEndpointFactory.class); + @Override + public String getEndpointDescription() { + return super.getEndpointDescription() + " with very experimental support of OSCORE"; + } + /** * This method is intended to be overridden. * diff --git a/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/coaps/CoapsClientEndpointFactory.java b/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/coaps/CoapsClientEndpointFactory.java index bfd0557717..6c707258d3 100644 --- a/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/coaps/CoapsClientEndpointFactory.java +++ b/leshan-client-cf/src/main/java/org/eclipse/leshan/client/californium/endpoint/coaps/CoapsClientEndpointFactory.java @@ -93,6 +93,11 @@ public CoapsClientEndpointFactory() { this("LWM2M Client"); } + @Override + public String getEndpointDescription() { + return "CoAP over DTLS endpoint based on Californium/Scandium library"; + } + public CoapsClientEndpointFactory(String loggingTagPrefix) { this.loggingTagPrefix = loggingTagPrefix; } diff --git a/leshan-client-core/src/main/java/org/eclipse/leshan/client/endpoint/LwM2mClientEndpoint.java b/leshan-client-core/src/main/java/org/eclipse/leshan/client/endpoint/LwM2mClientEndpoint.java index 51af38bfcf..72649692cd 100644 --- a/leshan-client-core/src/main/java/org/eclipse/leshan/client/endpoint/LwM2mClientEndpoint.java +++ b/leshan-client-core/src/main/java/org/eclipse/leshan/client/endpoint/LwM2mClientEndpoint.java @@ -30,6 +30,8 @@ public interface LwM2mClientEndpoint { URI getURI(); + String getDescription(); + void forceReconnection(LwM2mServer server, boolean resume); long getMaxCommunicationPeriodFor(long lifetimeInMs); From 05ff45c3679d6aead422c7d7d0b9fd9e6dc46443 Mon Sep 17 00:00:00 2001 From: Simon Bernard Date: Mon, 9 Oct 2023 17:52:19 +0200 Subject: [PATCH 6/7] Add description to LwM2mBootstrapServerEndpoint --- .../endpoint/CaliforniumBootstrapServerEndpoint.java | 9 ++++++++- .../CaliforniumBootstrapServerEndpointFactory.java | 2 ++ .../CaliforniumBootstrapServerEndpointsProvider.java | 4 ++-- .../coap/CoapBootstrapServerEndpointFactory.java | 5 +++++ .../coap/CoapOscoreBootstrapServerEndpointFactory.java | 5 +++++ .../coaps/CoapsBootstrapServerEndpointFactory.java | 5 +++++ .../leshan/server/bootstrap/LeshanBootstrapServer.java | 2 +- .../bootstrap/endpoint/LwM2mBootstrapServerEndpoint.java | 2 ++ 8 files changed, 30 insertions(+), 4 deletions(-) diff --git a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/CaliforniumBootstrapServerEndpoint.java b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/CaliforniumBootstrapServerEndpoint.java index 6aedd42668..63d6fb3eb2 100644 --- a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/CaliforniumBootstrapServerEndpoint.java +++ b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/CaliforniumBootstrapServerEndpoint.java @@ -45,6 +45,7 @@ public class CaliforniumBootstrapServerEndpoint implements LwM2mBootstrapServerEndpoint { private final Protocol protocol; + private final String description; private final ScheduledExecutorService executor; private final CoapEndpoint endpoint; private final BootstrapServerEndpointToolbox toolbox; @@ -56,11 +57,12 @@ public class CaliforniumBootstrapServerEndpoint implements LwM2mBootstrapServerE // This is used to be able to cancel request private final ConcurrentNavigableMap ongoingRequests = new ConcurrentSkipListMap<>(); - public CaliforniumBootstrapServerEndpoint(Protocol protocol, CoapEndpoint endpoint, + public CaliforniumBootstrapServerEndpoint(Protocol protocol, String description, CoapEndpoint endpoint, BootstrapServerCoapMessageTranslator translator, BootstrapServerEndpointToolbox toolbox, IdentityHandler identityHandler, ExceptionTranslator exceptionTranslator, ScheduledExecutorService executor) { this.protocol = protocol; + this.description = description; this.translator = translator; this.toolbox = toolbox; this.endpoint = endpoint; @@ -79,6 +81,11 @@ public URI getURI() { return EndpointUriUtil.createUri(protocol.getUriScheme(), endpoint.getAddress()); } + @Override + public String getDescription() { + return description; + } + public CoapEndpoint getCoapEndpoint() { return endpoint; } diff --git a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/CaliforniumBootstrapServerEndpointFactory.java b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/CaliforniumBootstrapServerEndpointFactory.java index a33d376117..c97eaa427b 100644 --- a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/CaliforniumBootstrapServerEndpointFactory.java +++ b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/CaliforniumBootstrapServerEndpointFactory.java @@ -31,6 +31,8 @@ public interface CaliforniumBootstrapServerEndpointFactory { URI getUri(); + String getEndpointDescription(); + CoapEndpoint createCoapEndpoint(Configuration defaultCaliforniumConfiguration, ServerSecurityInfo serverSecurityInfo, LeshanBootstrapServer server); diff --git a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/CaliforniumBootstrapServerEndpointsProvider.java b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/CaliforniumBootstrapServerEndpointsProvider.java index e1489a51b4..157125f75b 100644 --- a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/CaliforniumBootstrapServerEndpointsProvider.java +++ b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/CaliforniumBootstrapServerEndpointsProvider.java @@ -124,8 +124,8 @@ protected Resource createRoot() { // create LWM2M endpoint CaliforniumBootstrapServerEndpoint lwm2mEndpoint = new CaliforniumBootstrapServerEndpoint( - endpointFactory.getProtocol(), coapEndpoint, messagetranslator, toolbox, identityHandler, - exceptionTranslator, executor); + endpointFactory.getProtocol(), endpointFactory.getEndpointDescription(), coapEndpoint, + messagetranslator, toolbox, identityHandler, exceptionTranslator, executor); endpoints.add(lwm2mEndpoint); // add Californium endpoint to coap server diff --git a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/coap/CoapBootstrapServerEndpointFactory.java b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/coap/CoapBootstrapServerEndpointFactory.java index b0d47f535e..e7075f392d 100644 --- a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/coap/CoapBootstrapServerEndpointFactory.java +++ b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/coap/CoapBootstrapServerEndpointFactory.java @@ -85,6 +85,11 @@ public URI getUri() { return endpointUri; } + @Override + public String getEndpointDescription() { + return "CoAP over UDP endpoint based on Californium library"; + } + protected String getLoggingTag() { if (loggingTagPrefix != null) { return String.format("[%s-%s]", loggingTagPrefix, getUri().toString()); diff --git a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/coap/CoapOscoreBootstrapServerEndpointFactory.java b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/coap/CoapOscoreBootstrapServerEndpointFactory.java index d0ec3b17f2..83575fec3e 100644 --- a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/coap/CoapOscoreBootstrapServerEndpointFactory.java +++ b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/coap/CoapOscoreBootstrapServerEndpointFactory.java @@ -49,6 +49,11 @@ public CoapOscoreBootstrapServerEndpointFactory(URI uri) { super(uri); } + @Override + public String getEndpointDescription() { + return super.getEndpointDescription() + " with very experimental support of OSCORE"; + } + /** * This method is intended to be overridden. * diff --git a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/coaps/CoapsBootstrapServerEndpointFactory.java b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/coaps/CoapsBootstrapServerEndpointFactory.java index 469b53df6f..9d29009e74 100644 --- a/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/coaps/CoapsBootstrapServerEndpointFactory.java +++ b/leshan-server-cf/src/main/java/org/eclipse/leshan/server/californium/bootstrap/endpoint/coaps/CoapsBootstrapServerEndpointFactory.java @@ -84,6 +84,11 @@ public static Protocol getSupportedProtocol() { return Protocol.COAPS; } + @Override + public String getEndpointDescription() { + return "CoAP over DTLS endpoint based on Californium/Scandium library"; + } + public static void applyDefaultValue(Configuration configuration) { configuration.set(CoapConfig.MID_TRACKER, TrackerMode.NULL); configuration.set(DtlsConfig.DTLS_ROLE, DtlsRole.SERVER_ONLY); diff --git a/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/LeshanBootstrapServer.java b/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/LeshanBootstrapServer.java index f451842a12..b0b0f2dfe8 100644 --- a/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/LeshanBootstrapServer.java +++ b/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/LeshanBootstrapServer.java @@ -104,7 +104,7 @@ public void start() { if (LOG.isInfoEnabled()) { LOG.info("Bootstrap server started."); for (LwM2mBootstrapServerEndpoint endpoint : endpointsProvider.getEndpoints()) { - LOG.info("{} endpoint available at {}.", endpoint.getProtocol().getName(), endpoint.getURI()); + LOG.info("{} available at {}.", endpoint.getDescription(), endpoint.getURI()); } } } diff --git a/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/endpoint/LwM2mBootstrapServerEndpoint.java b/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/endpoint/LwM2mBootstrapServerEndpoint.java index d27034d503..23b328e34f 100644 --- a/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/endpoint/LwM2mBootstrapServerEndpoint.java +++ b/leshan-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/endpoint/LwM2mBootstrapServerEndpoint.java @@ -30,6 +30,8 @@ public interface LwM2mBootstrapServerEndpoint { URI getURI(); + String getDescription(); + T send(BootstrapSession destination, BootstrapDownlinkRequest request, long timeoutInMs) throws InterruptedException; From 8be094d1b6b224e44a66120ca4d689b1d9c4b0e6 Mon Sep 17 00:00:00 2001 From: Simon Bernard Date: Mon, 9 Oct 2023 18:10:17 +0200 Subject: [PATCH 7/7] UI demos get (bootstrap) server endpoints dynamically. --- .../bootstrap/demo/servlet/ServerServlet.java | 30 +++++----- .../webapp/src/views/Server.vue | 59 ++++++++++++++----- .../server/demo/servlet/ServerServlet.java | 30 +++++----- 3 files changed, 74 insertions(+), 45 deletions(-) diff --git a/leshan-bsserver-demo/src/main/java/org/eclipse/leshan/server/bootstrap/demo/servlet/ServerServlet.java b/leshan-bsserver-demo/src/main/java/org/eclipse/leshan/server/bootstrap/demo/servlet/ServerServlet.java index 351d580dfe..4011af7d42 100644 --- a/leshan-bsserver-demo/src/main/java/org/eclipse/leshan/server/bootstrap/demo/servlet/ServerServlet.java +++ b/leshan-bsserver-demo/src/main/java/org/eclipse/leshan/server/bootstrap/demo/servlet/ServerServlet.java @@ -27,12 +27,12 @@ import javax.servlet.http.HttpServletResponse; import org.apache.commons.lang.StringUtils; -import org.eclipse.leshan.core.endpoint.Protocol; import org.eclipse.leshan.server.bootstrap.LeshanBootstrapServer; import org.eclipse.leshan.server.bootstrap.endpoint.LwM2mBootstrapServerEndpoint; import org.eclipse.leshan.server.core.demo.json.PublicKeySerDes; import org.eclipse.leshan.server.core.demo.json.X509CertificateSerDes; +import com.fasterxml.jackson.databind.node.ArrayNode; import com.fasterxml.jackson.databind.node.JsonNodeFactory; import com.fasterxml.jackson.databind.node.ObjectNode; @@ -86,22 +86,22 @@ protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws Se } // search coap and coaps port - Integer coapPort = null; - Integer coapsPort = null; - for (LwM2mBootstrapServerEndpoint endpoint : server.getEndpoints()) { - if (endpoint.getProtocol().equals(Protocol.COAP)) { - coapPort = endpoint.getURI().getPort(); - } else if (endpoint.getProtocol().equals(Protocol.COAPS)) { - coapsPort = endpoint.getURI().getPort(); - } - } - if ("endpoint".equals(path[0])) { - resp.setStatus(HttpServletResponse.SC_OK); + ArrayNode endpoints = JsonNodeFactory.instance.arrayNode(); + for (LwM2mBootstrapServerEndpoint endpoint : server.getEndpoints()) { + ObjectNode ep = JsonNodeFactory.instance.objectNode(); + ObjectNode uri = JsonNodeFactory.instance.objectNode(); + ep.set("uri", uri); + uri.put("full", endpoint.getURI().toString()); + uri.put("scheme", endpoint.getURI().getScheme()); + uri.put("host", endpoint.getURI().getHost()); + uri.put("port", endpoint.getURI().getPort()); + ep.put("description", endpoint.getDescription()); + endpoints.add(ep); + } resp.setContentType("application/json"); - resp.getOutputStream().write(String - .format("{ \"securedEndpointPort\":\"%s\", \"unsecuredEndpointPort\":\"%s\"}", coapsPort, coapPort) - .getBytes(StandardCharsets.UTF_8)); + resp.getOutputStream().write(endpoints.toString().getBytes(StandardCharsets.UTF_8)); + resp.setStatus(HttpServletResponse.SC_OK); return; } diff --git a/leshan-server-core-demo/webapp/src/views/Server.vue b/leshan-server-core-demo/webapp/src/views/Server.vue index 6d3ba5108c..49c3165a6f 100644 --- a/leshan-server-core-demo/webapp/src/views/Server.vue +++ b/leshan-server-core-demo/webapp/src/views/Server.vue @@ -22,7 +22,7 @@ - + @@ -38,21 +38,20 @@

    -
  • +
  • {{ coapurl }} : CoAP over UDP. -
    • -
  • - {{ coapsurl }} : CoAP over DTLS. + >{{ endpoint.uri.scheme }}://{{ hostname() }}:{{ + endpoint.uri.port + }} : .
- + @@ -109,7 +108,7 @@ - + @@ -161,8 +160,7 @@ export default { props: { pubkeyFileName: String, certFileName: String }, data() { return { - coapurl: "", - coapsurl: "", + endpoints: {}, certificate: {}, pubkey: {}, }; @@ -172,11 +170,42 @@ export default { var blob = new Blob([bytes], { type: "application/octet-stream" }); saveAs(blob, filename); }, + hostname() { + return location.hostname; + }, }, beforeMount() { this.axios.get("api/server/endpoint").then((response) => { - this.coapurl = `coap://${location.hostname}:${response.data.unsecuredEndpointPort}`; - this.coapsurl = `coaps://${location.hostname}:${response.data.securedEndpointPort}`; + let eps = response.data; + + // bold key word + const keywords = [ + "CoAP", + "UDP", + "DTLS", + "OSCORE", + "Californium", + "Scandium", + "java-coap", + ]; + const strongKeywords = ["experimental"]; + + eps.forEach((ep) => { + keywords.forEach((keyword) => { + ep.description = ep.description.replace( + keyword, + `${keyword}` + ); + }); + strongKeywords.forEach((keyword) => { + ep.description = ep.description.replace( + keyword, + `${keyword}` + ); + }); + }); + + this.endpoints = eps; }); this.axios.get("api/server/security").then((response) => { if (response.data.certificate) { diff --git a/leshan-server-demo/src/main/java/org/eclipse/leshan/server/demo/servlet/ServerServlet.java b/leshan-server-demo/src/main/java/org/eclipse/leshan/server/demo/servlet/ServerServlet.java index 4331142077..8d72272406 100644 --- a/leshan-server-demo/src/main/java/org/eclipse/leshan/server/demo/servlet/ServerServlet.java +++ b/leshan-server-demo/src/main/java/org/eclipse/leshan/server/demo/servlet/ServerServlet.java @@ -27,12 +27,12 @@ import javax.servlet.http.HttpServletResponse; import org.apache.commons.lang.StringUtils; -import org.eclipse.leshan.core.endpoint.Protocol; import org.eclipse.leshan.server.LeshanServer; import org.eclipse.leshan.server.core.demo.json.PublicKeySerDes; import org.eclipse.leshan.server.core.demo.json.X509CertificateSerDes; import org.eclipse.leshan.server.endpoint.LwM2mServerEndpoint; +import com.fasterxml.jackson.databind.node.ArrayNode; import com.fasterxml.jackson.databind.node.JsonNodeFactory; import com.fasterxml.jackson.databind.node.ObjectNode; @@ -87,22 +87,22 @@ protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws Se } // search coap and coaps port - Integer coapPort = null; - Integer coapsPort = null; - for (LwM2mServerEndpoint endpoint : server.getEndpoints()) { - if (endpoint.getProtocol().equals(Protocol.COAP)) { - coapPort = endpoint.getURI().getPort(); - } else if (endpoint.getProtocol().equals(Protocol.COAPS)) { - coapsPort = endpoint.getURI().getPort(); - } - } - if ("endpoint".equals(path[0])) { - resp.setStatus(HttpServletResponse.SC_OK); + ArrayNode endpoints = JsonNodeFactory.instance.arrayNode(); + for (LwM2mServerEndpoint endpoint : server.getEndpoints()) { + ObjectNode ep = JsonNodeFactory.instance.objectNode(); + ObjectNode uri = JsonNodeFactory.instance.objectNode(); + ep.set("uri", uri); + uri.put("full", endpoint.getURI().toString()); + uri.put("scheme", endpoint.getURI().getScheme()); + uri.put("host", endpoint.getURI().getHost()); + uri.put("port", endpoint.getURI().getPort()); + ep.put("description", endpoint.getDescription()); + endpoints.add(ep); + } resp.setContentType("application/json"); - resp.getOutputStream().write(String - .format("{ \"securedEndpointPort\":\"%s\", \"unsecuredEndpointPort\":\"%s\"}", coapsPort, coapPort) - .getBytes(StandardCharsets.UTF_8)); + resp.getOutputStream().write(endpoints.toString().getBytes(StandardCharsets.UTF_8)); + resp.setStatus(HttpServletResponse.SC_OK); return; }