jlengrand/helidon
1
0
Fork 0
mirror of https://github.com/jlengrand/helidon.git synced 2026-03-10 08:21:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

WebSocket Extensions (#1934)

Browse Source 
* Addresses #1607
This commit is contained in:
dansiviter
2020-09-14 23:17:00 +01:00
committed by GitHub
parent b08b86243c
commit 701a01cdae
7 changed files with 190 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
dependencies/pom.xml vendored
View File

@@ -110,7 +110,7 @@
<version.lib.snakeyaml>1.24</version.lib.snakeyaml>
<version.lib.transaction-api>1.3.3</version.lib.transaction-api>
<version.lib.typesafe-config>1.4.0</version.lib.typesafe-config>
<version.lib.tyrus>1.15</version.lib.tyrus>
<version.lib.tyrus>1.17</version.lib.tyrus>
<version.lib.ucp>${version.lib.ojdbc8}</version.lib.ucp>
<version.lib.validation-api>2.0.2</version.lib.validation-api>
<version.lib.websockets-api>1.1.2</version.lib.websockets-api>

24
microprofile/websocket/src/main/java/io/helidon/microprofile/tyrus/WebSocketApplication.java
View File

@@ -22,6 +22,7 @@ import java.util.Set;
import java.util.logging.Logger;
import javax.websocket.Endpoint;
import javax.websocket.Extension;
import javax.websocket.server.ServerApplicationConfig;
/**
@@ -32,11 +33,13 @@ public final class WebSocketApplication {
private Class<? extends ServerApplicationConfig> applicationClass;
private Set<Class<?>> annotatedEndpoints;
private Set<Class<? extends Endpoint>> programmaticEndpoints;
private Set<Extension> extensions;
private WebSocketApplication(Builder builder) {
this.applicationClass = builder.applicationClass;
this.annotatedEndpoints = builder.annotatedEndpoints;
this.programmaticEndpoints = builder.programmaticEndpoints;
this.extensions = builder.extensions;
}
/**
@@ -75,6 +78,15 @@ public final class WebSocketApplication {
return annotatedEndpoints;
}
/**
* Get list of installed extensions.
*
* @return List of installed extensions.
*/
public Set<Extension> extensions() {
return extensions;
}
/**
* Fluent API builder to create {@link WebSocketApplication} instances.
*/
@@ -84,6 +96,7 @@ public final class WebSocketApplication {
private Class<? extends ServerApplicationConfig> applicationClass;
private Set<Class<?>> annotatedEndpoints = new HashSet<>();
private Set<Class<? extends Endpoint>> programmaticEndpoints = new HashSet<>();
private Set<Extension> extensions = new HashSet<>();
/**
* Updates an application class in the builder. Clears all results from scanning.
@@ -135,6 +148,17 @@ public final class WebSocketApplication {
return this;
}
/**
* Add single extension.
*
* @param extension Extension.
* @return The builder.
*/
public Builder extension(Extension extension) {
extensions.add(extension);
return this;
}
/**
* Builds application.
*

23
microprofile/websocket/src/main/java/io/helidon/microprofile/tyrus/WebSocketCdiExtension.java
View File

@@ -100,7 +100,7 @@ public class WebSocketCdiExtension implements Extension {
}
/**
* Collects programmatic endpoints .
* Collects programmatic endpoints.
*
* @param endpoint The endpoint.
*/
@@ -109,6 +109,26 @@ public class WebSocketCdiExtension implements Extension {
appBuilder.programmaticEndpoint(endpoint.getAnnotatedType().getJavaClass());
}
/**
* Collects extensions.
*
* @param extension The extension.
*/
private void extension(@Observes ProcessAnnotatedType<? extends javax.websocket.Extension> extension) {
LOGGER.finest(() -> "Extension found " + extension.getAnnotatedType().getJavaClass());
Class<? extends javax.websocket.Extension> cls = extension.getAnnotatedType().getJavaClass();
try {
javax.websocket.Extension instance = cls.getConstructor().newInstance();
appBuilder.extension(instance);
} catch (NoSuchMethodException e) {
LOGGER.warning(() -> "Extension does not have no-args constructor for "
+ extension.getAnnotatedType().getJavaClass() + "! Skppping.");
} catch (ReflectiveOperationException e) {
throw new IllegalStateException("Unable to load WebSocket extension", e);
}
}
/**
* Provides access to websocket application.
*
@@ -165,6 +185,7 @@ public class WebSocketCdiExtension implements Extension {
// Direct registration without calling application class
app.annotatedEndpoints().forEach(builder::register);
app.programmaticEndpoints().forEach(builder::register);
app.extensions().forEach(builder::register);
// Create routing builder
routing = serverCdiExtension.serverRoutingBuilder();

13
microprofile/websocket/src/test/java/io/helidon/microprofile/tyrus/EchoClient.java
View File

@@ -20,10 +20,13 @@ import javax.websocket.ClientEndpointConfig;
import javax.websocket.CloseReason;
import javax.websocket.Endpoint;
import javax.websocket.EndpointConfig;
import javax.websocket.Extension;
import javax.websocket.MessageHandler;
import javax.websocket.Session;
import java.io.IOException;
import java.net.URI;
import java.util.Arrays;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
@@ -46,14 +49,20 @@ class EchoClient {
private final URI uri;
private final BiFunction<String, String, Boolean> equals;
private final List<Extension> extensions;
public EchoClient(URI uri) {
this(uri, String::equals);
}
public EchoClient(URI uri, BiFunction<String, String, Boolean> equals) {
public EchoClient(URI uri, Extension... extensions) {
this(uri, String::equals, extensions);
}
public EchoClient(URI uri, BiFunction<String, String, Boolean> equals, Extension... extensions) {
this.uri = uri;
this.equals = equals;
this.extensions = Arrays.asList(extensions);
}
/**
@@ -66,7 +75,7 @@ class EchoClient {
CountDownLatch messageLatch = new CountDownLatch(messages.length);
CompletableFuture<Void> openFuture = new CompletableFuture<>();
CompletableFuture<Void> closeFuture = new CompletableFuture<>();
ClientEndpointConfig config = ClientEndpointConfig.Builder.create().build();
ClientEndpointConfig config = ClientEndpointConfig.Builder.create().extensions(extensions).build();
client.connectToServer(new Endpoint() {
@Override

2
microprofile/websocket/src/test/java/io/helidon/microprofile/tyrus/WebSocketEndpointAppTest.java
View File

@@ -22,14 +22,12 @@ import java.util.Set;
import javax.enterprise.context.Dependent;
import javax.enterprise.inject.se.SeContainerInitializer;
import javax.enterprise.inject.spi.CDI;
import javax.websocket.Endpoint;
import javax.websocket.server.ServerApplicationConfig;
import javax.websocket.server.ServerEndpointConfig;
import io.helidon.microprofile.server.RoutingPath;
import io.helidon.microprofile.server.ServerCdiExtension;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;

94
microprofile/websocket/src/test/java/io/helidon/microprofile/tyrus/WebSocketExtensionEndpointTest.java Normal file
View File

@@ -0,0 +1,94 @@
/*
* Copyright (c) 2020 Oracle and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.helidon.microprofile.tyrus;
import java.net.URI;
import java.util.Collections;
import java.util.List;
import java.util.logging.Logger;
import javax.enterprise.inject.se.SeContainer;
import javax.enterprise.inject.se.SeContainerInitializer;
import javax.enterprise.inject.spi.CDI;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import io.helidon.microprofile.server.ServerCdiExtension;
import javax.websocket.Extension;
import javax.websocket.OnMessage;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;
/**
* A test that mixes Websocket endpoints and extensions in the same application.
*/
public class WebSocketExtensionEndpointTest {
static SeContainer container;
@BeforeAll
static void initClass() {
container = SeContainerInitializer.newInstance()
.addBeanClasses(ExtensionEndpointAnnot.class, TestExtension.class)
.initialize();
}
@AfterAll
static void destroyClass() {
container.close();
}
public int port() {
ServerCdiExtension cdiExtension = CDI.current().getBeanManager().getExtension(ServerCdiExtension.class);
return cdiExtension.port();
}
@Test
public void test() throws Exception {
URI echoUri = URI.create("ws://localhost:" + port() + "/extAnnot");
EchoClient echoClient = new EchoClient(echoUri, new TestExtension());
echoClient.echo("hi", "how are you?");
}
@ServerEndpoint("/extAnnot")
public static class ExtensionEndpointAnnot {
private static final Logger LOGGER = Logger.getLogger(ExtensionEndpointAnnot.class.getName());
@OnMessage
public void echo(Session session, String message) throws Exception {
LOGGER.info("OnMessage called '" + message + "'");
if (session.getNegotiatedExtensions().isEmpty()) {
throw new IllegalStateException();
}
session.getBasicRemote().sendObject(message);
}
}
public static class TestExtension implements Extension {
@Override
public String getName() {
return "testExtension";
}
@Override
public List<Parameter> getParameters() {
return Collections.emptyList();
}
}
}

40
webserver/tyrus/src/main/java/io/helidon/webserver/tyrus/TyrusSupport.java
View File

@@ -27,6 +27,7 @@ import java.util.concurrent.ExecutorService;
import java.util.logging.Logger;
import javax.websocket.DeploymentException;
import javax.websocket.Extension;
import javax.websocket.server.HandshakeRequest;
import javax.websocket.server.ServerEndpointConfig;
@@ -60,6 +61,7 @@ public class TyrusSupport implements Service {
private final TyrusHandler handler = new TyrusHandler();
private Set<Class<?>> endpointClasses;
private Set<ServerEndpointConfig> endpointConfigs;
private Set<Extension> extensions;
/**
* Create from another instance.
@@ -70,12 +72,18 @@ public class TyrusSupport implements Service {
this.engine = other.engine;
this.endpointClasses = other.endpointClasses;
this.endpointConfigs = other.endpointConfigs;
this.extensions = other.extensions;
}
TyrusSupport(WebSocketEngine engine, Set<Class<?>> endpointClasses, Set<ServerEndpointConfig> endpointConfigs) {
TyrusSupport(
WebSocketEngine engine,
Set<Class<?>> endpointClasses,
Set<ServerEndpointConfig> endpointConfigs,
Set<Extension> extensions) {
this.engine = engine;
this.endpointClasses = endpointClasses;
this.endpointConfigs = endpointConfigs;
this.extensions = extensions;
}
/**
@@ -108,6 +116,15 @@ public class TyrusSupport implements Service {
return Collections.unmodifiableSet(endpointConfigs);
}
/**
* Access to extensions.
*
* @return Immutable set of extensions.
*/
public Set<Extension> extensions() {
return Collections.unmodifiableSet(extensions);
}
/**
* Returns executor service, can be overridden.
*
@@ -133,6 +150,7 @@ public class TyrusSupport implements Service {
private Set<Class<?>> endpointClasses = new HashSet<>();
private Set<ServerEndpointConfig> endpointConfigs = new HashSet<>();
private Set<Extension> extensions = new HashSet<>();
private Builder() {
}
@@ -159,8 +177,21 @@ public class TyrusSupport implements Service {
return this;
}
/**
* Register an extension.
*
* @param extension The extension.
* @return The builder.
*/
public Builder register(Extension extension) {
extensions.add(extension);
return this;
}
@Override
public TyrusSupport build() {
// a purposefully mutable extensions
Set<Extension> installedExtensions = new HashSet<>(extensions);
// Create container and WebSocket engine
TyrusServerContainer serverContainer = new TyrusServerContainer(endpointClasses) {
private final WebSocketEngine engine =
@@ -176,6 +207,11 @@ public class TyrusSupport implements Service {
throw new UnsupportedOperationException("Use TyrusWebSocketEngine for registration");
}
@Override
public Set<Extension> getInstalledExtensions() {
return installedExtensions;
}
@Override
public WebSocketEngine getWebSocketEngine() {
return engine;
@@ -202,7 +238,7 @@ public class TyrusSupport implements Service {
});
// Create TyrusSupport using WebSocket engine
return new TyrusSupport(serverContainer.getWebSocketEngine(), endpointClasses, endpointConfigs);
return new TyrusSupport(serverContainer.getWebSocketEngine(), endpointClasses, endpointConfigs, extensions);
}
}