Skip to content

Commit

Permalink
[#1802] Switch pax-web-tomcat-websocket from javax to jakarta
Browse files Browse the repository at this point in the history
  • Loading branch information
@grgrzybek
grgrzybek committed Jun 16, 2023
1 parent 5f1f9a4 commit f69d3f0
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 58 deletions.
61 changes: 32 additions & 29 deletions pax-web-tomcat-websocket/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,16 @@
javax.naming,
javax.net.ssl,

javax.servlet;version="[3.1,5)",
javax.servlet.annotation;version="[3.1,5)",
javax.servlet.http;version="[3.1,5)",
javax.websocket;version="[1.1,2)",
javax.websocket.server;version="[1.1,2)",
<!-- ranges indicate Servlet API 6.0+ (JakartaEE 10+) -->
jakarta.servlet;version="[6,7)",
jakarta.servlet.annotation;version="[6,7)",
jakarta.servlet.http;version="[6,7)",

jakarta.websocket;version="[2.1,3)",
jakarta.websocket.server;version="[2.1,3)",

org.apache.coyote.http11.upgrade,
org.apache.juli.logging;version="[9.0,10)",
org.apache.juli.logging;version="[10.0,11)",

<!-- pax-web-tomcat-common / tomcat-api -->
org.apache.tomcat;version="${dependency.org.apache.tomcat}",
Expand Down Expand Up @@ -89,8 +91,13 @@

<dependencies>

<!-- JavaEE -->
<!-- JakartaEE -->

<dependency>
<groupId>jakarta.annotation</groupId>
<artifactId>jakarta.annotation-api</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>jakarta.servlet</groupId>
<artifactId>jakarta.servlet-api</artifactId>
Expand All @@ -101,6 +108,11 @@
<artifactId>jakarta.websocket-api</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>jakarta.websocket</groupId>
<artifactId>jakarta.websocket-client-api</artifactId>
<scope>provided</scope>
</dependency>

<!-- Tomcat -->

Expand Down Expand Up @@ -129,7 +141,7 @@
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-slf4j-impl</artifactId>
<artifactId>log4j-slf4j2-impl</artifactId>
<scope>test</scope>
</dependency>

Expand All @@ -144,8 +156,18 @@
<!-- Testing -->

<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-engine</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.assertj</groupId>
<artifactId>assertj-core</artifactId>
<scope>test</scope>
</dependency>
<dependency>
Expand All @@ -156,23 +178,4 @@

</dependencies>

<profiles>
<profile>
<id>jdk11</id>
<activation>
<jdk>[9,)</jdk>
</activation>
<dependencies>

<!-- JavaEE / JakartaEE -->

<dependency>
<groupId>jakarta.annotation</groupId>
<artifactId>jakarta.annotation-api</artifactId>
</dependency>

</dependencies>
</profile>
</profiles>

</project>
57 changes: 28 additions & 29 deletions ...rc/test/java/org/ops4j/pax/web/service/tomcat/websocket/EmbeddedTomcatWebSocketsTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,19 @@
import java.util.Map;
import java.util.ServiceLoader;
import java.util.Set;
import javax.websocket.ClientEndpointConfig;
import javax.websocket.ContainerProvider;
import javax.websocket.Endpoint;
import javax.websocket.EndpointConfig;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.RemoteEndpoint;
import javax.websocket.Session;
import javax.websocket.WebSocketContainer;
import javax.websocket.server.ServerApplicationConfig;
import javax.websocket.server.ServerContainer;
import javax.websocket.server.ServerEndpoint;
import javax.websocket.server.ServerEndpointConfig;
import jakarta.websocket.ClientEndpointConfig;
import jakarta.websocket.ContainerProvider;
import jakarta.websocket.Endpoint;
import jakarta.websocket.EndpointConfig;
import jakarta.websocket.OnMessage;
import jakarta.websocket.OnOpen;
import jakarta.websocket.RemoteEndpoint;
import jakarta.websocket.Session;
import jakarta.websocket.WebSocketContainer;
import jakarta.websocket.server.ServerApplicationConfig;
import jakarta.websocket.server.ServerContainer;
import jakarta.websocket.server.ServerEndpoint;
import jakarta.websocket.server.ServerEndpointConfig;

import org.apache.catalina.Context;
import org.apache.catalina.Engine;
Expand All @@ -58,28 +58,27 @@
import org.apache.commons.io.FileUtils;
import org.apache.tomcat.websocket.Constants;
import org.apache.tomcat.websocket.server.WsSci;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.Test;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.bridge.SLF4JBridgeHandler;

import static org.hamcrest.CoreMatchers.equalTo;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.Assert.assertNotNull;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertNotNull;

public class EmbeddedTomcatWebSocketsTest {

public static final Logger LOG = LoggerFactory.getLogger(EmbeddedTomcatWebSocketsTest.class);

@BeforeClass
@BeforeAll
public static void initClass() {
SLF4JBridgeHandler.removeHandlersForRootLogger();
SLF4JBridgeHandler.install();
}

@AfterClass
@AfterAll
public static void cleanupClass() {
SLF4JBridgeHandler.uninstall();
}
Expand Down Expand Up @@ -143,24 +142,24 @@ public void webSockets() throws Exception {

LOG.info("Local port after start: {}", connector.getLocalPort());

// javax.websocket.Endpoint - A logical websocket endpoint to handle endpoint's lifecycle endpoints
// jakarta.websocket.Endpoint - A logical websocket endpoint to handle endpoint's lifecycle endpoints
// There is one instance per application per VM of the Endpoint class to represent the logical endpoint
// per connected peer (unless special configuration is specified by
// javax.websocket.server.ServerEndpointConfig.Configurator.getEndpointInstance()) implementation
// jakarta.websocket.server.ServerEndpointConfig.Configurator.getEndpointInstance()) implementation
//
// javax.websocket.Session - models the sequence of interactions between an endpoint and each of its peers
// jakarta.websocket.Session - models the sequence of interactions between an endpoint and each of its peers
// the interaction begins with onOpen() method called on an Endpoint
//
// javax.websocket.MessageHandler - is registered on a Session object to handle messages between open and
// jakarta.websocket.MessageHandler - is registered on a Session object to handle messages between open and
// close events. There may be only one MessageHandler per type of message (text, binary, pong)
// The API forces implementations to get the MessageHandler’s type parameter in runtime, so it's
// not possible to pass lambdas
//
// javax.websocket.RemoteEndpoint - models a peer of a Session for an Endpoint
// jakarta.websocket.RemoteEndpoint - models a peer of a Session for an Endpoint
//
// javax.websocket.WebSocketContainer - websocket implementation used to deploy endpoints. In server
// jakarta.websocket.WebSocketContainer - websocket implementation used to deploy endpoints. In server
// deployments, there's one instance per application per VM. In client deployments, an instance is
// obtained using ServiceLocator and javax.websocket.ContainerProvider.class service
// obtained using ServiceLocator and jakarta.websocket.ContainerProvider.class service
// (in Tomcat it's org.apache.tomcat.websocket.WsContainerProvider)

// coniguration (chapter 3) includes:
Expand Down Expand Up @@ -190,7 +189,7 @@ public void beforeRequest(Map<String, List<String>> headers) {
URI.create("ws://localhost:" + connector.getLocalPort() + "/endpoint1"));

ServerContainer sc = (ServerContainer) context.getServletContext().getAttribute(ServerContainer.class.getName());
assertThat(sc.getClass().getName(), equalTo("org.apache.tomcat.websocket.server.WsServerContainer"));
assertThat(sc.getClass().getName()).isEqualTo("org.apache.tomcat.websocket.server.WsServerContainer");
sc.addEndpoint(MyAnnotatedEndpoint.class);

container.connectToServer(new MyClientEndpoint("c2"), config,
Expand Down

0 comments on commit f69d3f0

Please sign in to comment.