This is the code repository of the WebSocket support used by HtmlUnit.

The default WebSocket client used by HtmlUnit is based on Jetty 12. To avoid conflicts in projects using different versions of Jetty, this repo provides a shaded version of the jetty websocket stuff.

❤️ Sponsor

Developer Blog

HtmlUnit@mastodon | HtmlUnit@bsky | HtmlUnit@Twitter

Starting with version 5.0.0, JDK 17 or higher is required.
If you are still on JDK 8, see Legacy Support (JDK 8) below.

Add to your pom.xml:

<dependency>
    <groupId>org.htmlunit</groupId>
    <artifactId>htmlunit-websocket-client</artifactId>
    <version>5.4.0</version>
</dependency>

Add to your build.gradle:

implementation group: 'org.htmlunit', name: 'htmlunit-websocket-client', version: '5.4.0'

If you need to continue using JDK 8, versions 4.x remain available as-is. Ongoing maintenance and fixes for JDK 8 are only available through sponsorship — please contact me via email to discuss options. Sponsorship provides:

• Backporting security and bug fixes to the 4.x branch
• Compatibility maintenance with older Java versions
• Timely releases for critical issues

Without sponsorship, the 4.x branch will not receive further updates.

The latest builds are available from our Jenkins CI build server

htmlunit-websocket-client

If you use maven please add:

<dependency>
    <groupId>org.htmlunit</groupId>
    <artifactId>htmlunit-websocket-client</artifactId>
    <version>5.5.0-SNAPSHOT</version>
</dependency>

You have to add the sonatype-central snapshot repository to your pom repositories section also:

<repositories>
    <repository>
        <name>Central Portal Snapshots</name>
        <id>central-portal-snapshots</id>
        <url>https://central.sonatype.com/repository/maven-snapshots/</url>
        <releases>
            <enabled>false</enabled>
        </releases>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

You simply only need a local maven installation.

Create a local clone of the repository and you are ready to start.

Open a command line window from the root folder of the project and call

mvn compile

mvn test

Pull Requests and and all other Community Contributions are essential for open source software. Every contribution - from bug reports to feature requests, typos to full new features - are greatly appreciated.

This part is intended for committer who are packaging a release.

• Check all your files are checked in
• Execute these mvn commands to be sure all tests are passing and everything is up to data

   mvn versions:display-plugin-updates
   mvn versions:display-dependency-updates
   mvn -U clean test

• Update the version number in pom.xml and README.md

• Commit the changes

• Build and deploy the artifacts

   mvn -up clean deploy

• Go to Maven Central Portal and process the deploy

  • publish the package and wait until it is processed

• Create the version on Github

  • login to Github and open project https://github.com/HtmlUnit/htmlunit-websocket-client
  • click Releases > Draft new release
  • fill the tag and title field with the release number (e.g. 4.0.0)
  • append
    • htmlunit-websocket-client-5.x.x.jar
    • htmlunit-websocket-client-5.x.x.jar.asc
    • htmlunit-websocket-client-5.x.x.pom
    • htmlunit-websocket-client-5.x.x.pom.asc
    • htmlunit-websocket-client-5.x.x-javadoc.jar
    • htmlunit-websocket-client-5.x.x-javadoc.jar.asc
    • htmlunit-websocket-client-5.x.x-sources.jar
    • htmlunit-websocket-client-5.x.x-sources.jar.asc
  • and publish the release

• Update the version number in pom.xml to start next snapshot development

• Update the htmlunit pom to use the new release

• RBRi
• all the contributors to the Jetty project

This project is licensed under the Apache 2.0 License

Many thanks to all of you contributing to HtmlUnit/CSSParser/Rhino in the past.