Merge pull request #1 from selimaj-dev/client

Client
This commit is contained in:
2026-02-19 10:09:42 -08:00
committed by GitHub
16 changed files with 788 additions and 20 deletions
+16 -18
View File
@@ -1,24 +1,22 @@
# Compiled class file
*.class
# Gradle
.gradle/
build/
# Log file
*.log
# IntelliJ IDEA
.idea/
*.iml
# BlueJ files
*.ctxt
# Eclipse
.project
.classpath
.settings/
# Mobile Tools for Java (J2ME)
.mtj.tmp/
# macOS
.DS_Store
# Package Files #
*.jar
*.war
*.nar
*.ear
*.zip
*.tar.gz
*.rar
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
# Java
hs_err_pid*
replay_pid*
# Logs
*.log
+81 -2
View File
@@ -1,2 +1,81 @@
# session-java
A lightweight async protocol for WebSocket.
<p align="center">
<img src="logo.svg" alt="Session" width="150"/>
</p>
<h1 align="center">session-java</h1>
<p align="center">A lightweight, async WebSocket protocol for Java.</p>
## Introduction
This library provides **type-safe WebSocket communication** with a request-response and notification system built on top of a flexible protocol.
It ensures compile-time guarantees for message structure, reduces runtime errors, and simplifies building Rust client/server applications.
- **Dynamic Methods**: Each message includes a method enum for type safety.
- **Typed Requests & Responses**: Automatic serialization and deserialization.
- **Optional Notifications**: Send asynchronous notifications across sessions.
## Features
- Fully typed WebSocket sessions
- Type-safe request/response mechanism
- Optional typed notifications (Todo)
- Lightweight, minimal runtime overhead
## Installation
```bash
cargo add session-rs
```
---
### **Basic Example (client)**
```java
Session session = Session.connect("ws://localhost:8080/");
TextNode response = session.request(Methods.Data, TextNode.valueOf("Hello from client")).get();
System.out.println(response);
session.close();
```
### **Basic Example (server)**
#### ⚠️ Server functionality not done yet this is only for future examples
```java
SessionServer server = SessionServer.bind("ws://localhost:8080/");
server.onClient((session, addr) -> {
session.onRequest(Methods.Data, (id, data) -> {
return SessionResult.ok(TextNode.valueOf("Response from server"));
});
});
```
## Protocol
#### Request
The request `id` is separated from the peer, and will increment only on it's requests.
```json
{ "type": "request", "id": 1, "method": "data", "data": "Hello from client" }
```
#### Response
The response `id` **must** remain the same as the request.
```json
{ "type": "response", "id": 1, "result": "Hello from server" }
```
#### Notifications
A notification is a method that doesn't need validation or output, it simply notifies a peer for a specific information
```json
{ "type": "notification", "result": "Hello from server" }
```
+35
View File
@@ -0,0 +1,35 @@
plugins {
id 'java-library'
}
group = "dev.selimaj.session"
version = "0.1.0"
java {
toolchain {
languageVersion = JavaLanguageVersion.of(17)
}
}
repositories {
mavenCentral()
}
dependencies {
// JSON parsing and serialization
implementation 'com.fasterxml.jackson.core:jackson-databind:2.17.0'
implementation 'com.fasterxml.jackson.core:jackson-annotations:2.17.0'
implementation 'com.fasterxml.jackson.core:jackson-core:2.17.0'
// WebSocket API
implementation 'jakarta.websocket:jakarta.websocket-api:2.1.1'
// WebSocket client runtime
implementation 'org.glassfish.tyrus:tyrus-client:2.1.2'
// For testing
testImplementation 'org.junit.jupiter:junit-jupiter:5.10.0'
}
test {
useJUnitPlatform()
}
Binary file not shown.
+7
View File
@@ -0,0 +1,7 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
Vendored Executable
+249
View File
@@ -0,0 +1,249 @@
#!/bin/sh
#
# Copyright © 2015-2021 the original authors.
#
# 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
#
# https://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.
#
##############################################################################
#
# Gradle start up script for POSIX generated by Gradle.
#
# Important for running:
#
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
# noncompliant, but you have some other compliant shell such as ksh or
# bash, then to run this script, type that shell name before the whole
# command line, like:
#
# ksh Gradle
#
# Busybox and similar reduced shells will NOT work, because this script
# requires all of these POSIX shell features:
# * functions;
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
# * compound commands having a testable exit status, especially «case»;
# * various built-in commands including «command», «set», and «ulimit».
#
# Important for patching:
#
# (2) This script targets any POSIX shell, so it avoids extensions provided
# by Bash, Ksh, etc; in particular arrays are avoided.
#
# The "traditional" practice of packing multiple parameters into a
# space-separated string is a well documented source of bugs and security
# problems, so this is (mostly) avoided, by progressively accumulating
# options in "$@", and eventually passing that to Java.
#
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
# see the in-line comments for details.
#
# There are tweaks for specific operating systems such as AIX, CygWin,
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project.
#
# You can find Gradle at https://github.com/gradle/gradle/.
#
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
app_path=$0
# Need this for daisy-chained symlinks.
while
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
[ -h "$app_path" ]
do
ls=$( ls -ld "$app_path" )
link=${ls#*' -> '}
case $link in #(
/*) app_path=$link ;; #(
*) app_path=$APP_HOME$link ;;
esac
done
# This is normally unused
# shellcheck disable=SC2034
APP_BASE_NAME=${0##*/}
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum
warn () {
echo "$*"
} >&2
die () {
echo
echo "$*"
echo
exit 1
} >&2
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "$( uname )" in #(
CYGWIN* ) cygwin=true ;; #(
Darwin* ) darwin=true ;; #(
MSYS* | MINGW* ) msys=true ;; #(
NONSTOP* ) nonstop=true ;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD=$JAVA_HOME/jre/sh/java
else
JAVACMD=$JAVA_HOME/bin/java
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD=java
if ! command -v java >/dev/null 2>&1
then
die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
fi
# Increase the maximum file descriptors if we can.
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
case $MAX_FD in #(
max*)
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC2039,SC3045
MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit"
esac
case $MAX_FD in #(
'' | soft) :;; #(
*)
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC2039,SC3045
ulimit -n "$MAX_FD" ||
warn "Could not set maximum file descriptor limit to $MAX_FD"
esac
fi
# Collect all arguments for the java command, stacking in reverse order:
# * args from the command line
# * the main class name
# * -classpath
# * -D...appname settings
# * --module-path (only if needed)
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
# For Cygwin or MSYS, switch paths to Windows format before running java
if "$cygwin" || "$msys" ; then
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
JAVACMD=$( cygpath --unix "$JAVACMD" )
# Now convert the arguments - kludge to limit ourselves to /bin/sh
for arg do
if
case $arg in #(
-*) false ;; # don't mess with options #(
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
[ -e "$t" ] ;; #(
*) false ;;
esac
then
arg=$( cygpath --path --ignore --mixed "$arg" )
fi
# Roll the args list around exactly as many times as the number of
# args, so each arg winds up back in the position where it started, but
# possibly modified.
#
# NB: a `for` loop captures its iteration list before it begins, so
# changing the positional parameters here affects neither the number of
# iterations, nor the values presented in `arg`.
shift # remove old arg
set -- "$@" "$arg" # push replacement arg
done
fi
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Collect all arguments for the java command:
# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
# and any embedded shellness will be escaped.
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
# treated as '${Hostname}' itself on the command line.
set -- \
"-Dorg.gradle.appname=$APP_BASE_NAME" \
-classpath "$CLASSPATH" \
org.gradle.wrapper.GradleWrapperMain \
"$@"
# Stop when "xargs" is not available.
if ! command -v xargs >/dev/null 2>&1
then
die "xargs is not available"
fi
# Use "xargs" to parse quoted args.
#
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
#
# In Bash we could simply go:
#
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
# set -- "${ARGS[@]}" "$@"
#
# but POSIX shell has neither arrays nor command substitution, so instead we
# post-process each arg (as a line of input to sed) to backslash-escape any
# character that might be a shell metacharacter, then use eval to reverse
# that process (while maintaining the separation between arguments), and wrap
# the whole thing up as a single "set" statement.
#
# This will of course break if any of these variables contains a newline or
# an unmatched quote.
#
eval "set -- $(
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
xargs -n1 |
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
tr '\n' ' '
)" '"$@"'
exec "$JAVACMD" "$@"
Vendored
+92
View File
@@ -0,0 +1,92 @@
@rem
@rem Copyright 2015 the original author or authors.
@rem
@rem Licensed under the Apache License, Version 2.0 (the "License");
@rem you may not use this file except in compliance with the License.
@rem You may obtain a copy of the License at
@rem
@rem https://www.apache.org/licenses/LICENSE-2.0
@rem
@rem Unless required by applicable law or agreed to in writing, software
@rem distributed under the License is distributed on an "AS IS" BASIS,
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@rem See the License for the specific language governing permissions and
@rem limitations under the License.
@rem
@if "%DEBUG%"=="" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%"=="" set DIRNAME=.
@rem This is normally unused
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Resolve any "." and ".." in APP_HOME to make it shorter.
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if %ERRORLEVEL% equ 0 goto execute
echo. 1>&2
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
echo. 1>&2
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
echo location of your Java installation. 1>&2
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto execute
echo. 1>&2
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
echo. 1>&2
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
echo location of your Java installation. 1>&2
goto fail
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
:end
@rem End local scope for the variables with windows NT shell
if %ERRORLEVEL% equ 0 goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
set EXIT_CODE=%ERRORLEVEL%
if %EXIT_CODE% equ 0 set EXIT_CODE=1
if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
exit /b %EXIT_CODE%
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega
+1
View File
@@ -0,0 +1 @@
rootProject.name = "session"
@@ -0,0 +1,74 @@
package dev.selimaj.session;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.TextNode;
import dev.selimaj.session.types.SessionResult;
import dev.selimaj.session.types.Message;
import dev.selimaj.session.types.Method;
import dev.selimaj.session.types.MethodHandler;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.WebSocket;
import java.util.concurrent.CompletableFuture;
public final class Session {
private final WebSocket ws;
private final SessionListener listener;
public Session(WebSocket ws, SessionListener listener) {
this.ws = ws;
this.listener = listener;
}
public static Session connect(String uri) throws Exception {
SessionListener listener = new SessionListener();
WebSocket ws = HttpClient.newHttpClient()
.newWebSocketBuilder()
.buildAsync(URI.create(uri), listener)
.join();
return new Session(ws, listener);
}
public void send(Message msg) throws Exception {
listener.send(ws, msg);
}
public void respond(int to, JsonNode val) throws Exception {
listener.respond(ws, to, val);
}
public void respondError(int to, JsonNode val) throws Exception {
listener.respondError(ws, to, val);
}
public void notify(String method, Object data) throws Exception {
listener.notify(ws, method, data);
}
<Req extends JsonNode, Res extends JsonNode, Err extends JsonNode> CompletableFuture<Res> request(
Method<Req, Res, Err> method, Req req) throws Exception {
return listener.request(ws, method.getName(), req, method.getResClass());
}
<Req extends JsonNode, Res extends JsonNode, Err extends JsonNode> void onRequest(Method<Req, Res, Err> method,
MethodHandler<Req> handler) {
MethodHandler<JsonNode> wrapper = (id, value) -> {
try {
return handler.handle(id, listener.mapper.treeToValue(value, method.getReqClass()));
} catch (Exception e) {
return SessionResult.error(TextNode.valueOf(e.getMessage()));
}
};
this.listener.methods.put(method.getName(), wrapper);
}
public void close() throws Exception {
ws.sendClose(0, "Session closed");
}
}
@@ -0,0 +1,103 @@
package dev.selimaj.session;
import java.net.http.WebSocket;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionStage;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.atomic.AtomicInteger;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import dev.selimaj.session.types.Message;
import dev.selimaj.session.types.MethodHandler;
public class SessionListener implements WebSocket.Listener {
public final ConcurrentHashMap<String, MethodHandler<JsonNode>> methods = new ConcurrentHashMap<>();
final ObjectMapper mapper = new ObjectMapper();
private final ConcurrentHashMap<Integer, CompletableFuture<JsonNode>> pending = new ConcurrentHashMap<>();
private final AtomicInteger id = new AtomicInteger();
@Override
public CompletionStage<?> onText(WebSocket ws, CharSequence data, boolean last) {
Message msg = null;
try {
msg = mapper.readValue(data.toString(), Message.class);
} catch (Exception e) {
e.printStackTrace();
return null;
}
if (msg instanceof Message.Request r) {
MethodHandler<JsonNode> handler = methods.get(r.method());
if (handler != null) {
handler.handle(r.id(), r.data())
.thenAccept(res -> {
try {
if (res.isError()) {
respondError(ws, r.id(), res.value());
} else {
respond(ws, r.id(), res.value());
}
} catch (Exception ignored) {
}
});
}
} else if (msg instanceof Message.Response r) {
CompletableFuture<JsonNode> fut = pending.remove(r.id());
if (fut != null)
fut.complete(r.result());
} else if (msg instanceof Message.ErrorResponse r) {
CompletableFuture<JsonNode> fut = pending.remove(r.id());
if (fut != null)
fut.completeExceptionally(
new RuntimeException(r.error().toString()));
}
return null;
}
void send(WebSocket ws, Message msg) throws Exception {
ws.sendText(mapper.writeValueAsString(msg), true);
}
void respond(WebSocket ws, int to, JsonNode val) throws Exception {
send(ws, new Message.Response(to, val));
}
void respondError(WebSocket ws, int to, JsonNode val) throws Exception {
send(ws, new Message.ErrorResponse(to, val));
}
void notify(WebSocket ws, String method, Object data) throws Exception {
send(ws, new Message.Notification(method, mapper.valueToTree(data)));
}
<Req, Res> CompletableFuture<Res> request(
WebSocket ws,
String method,
Req data,
Class<Res> resType) throws Exception {
int id = this.id.incrementAndGet();
CompletableFuture<JsonNode> fut = new CompletableFuture<>();
pending.put(id, fut);
send(ws, new Message.Request(
id,
method,
mapper.valueToTree(data)));
return fut.thenApply(json -> {
try {
return mapper.treeToValue(json, resType);
} catch (Exception e) {
throw new RuntimeException(e);
}
});
}
}
@@ -0,0 +1,27 @@
package dev.selimaj.session.types;
import com.fasterxml.jackson.annotation.*;
import com.fasterxml.jackson.databind.JsonNode;
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type")
@JsonSubTypes({
@JsonSubTypes.Type(value = Message.Request.class, name = "request"),
@JsonSubTypes.Type(value = Message.Response.class, name = "response"),
@JsonSubTypes.Type(value = Message.ErrorResponse.class, name = "errorresponse"),
@JsonSubTypes.Type(value = Message.Notification.class, name = "notification")
})
public sealed interface Message
permits Message.Request, Message.Response, Message.ErrorResponse, Message.Notification {
record Request(int id, String method, JsonNode data) implements Message {
}
record Response(int id, JsonNode result) implements Message {
}
record ErrorResponse(int id, JsonNode error) implements Message {
}
record Notification(String method, JsonNode data) implements Message {
}
}
@@ -0,0 +1,33 @@
package dev.selimaj.session.types;
import com.fasterxml.jackson.databind.JsonNode;
public class Method<Req extends JsonNode, Res extends JsonNode, Err extends JsonNode> {
private final String name;
private final Class<Req> reqClass;
private final Class<Res> resClass;
private final Class<Err> errClass;
public Method(String name, Class<Req> reqClass, Class<Res> resClass, Class<Err> errClass) {
this.name = name;
this.reqClass = reqClass;
this.resClass = resClass;
this.errClass = errClass;
}
public String getName() {
return name;
}
public Class<Req> getReqClass() {
return reqClass;
}
public Class<Res> getResClass() {
return resClass;
}
public Class<Err> getErrClass() {
return errClass;
}
}
@@ -0,0 +1,10 @@
package dev.selimaj.session.types;
import java.util.concurrent.CompletableFuture;
import com.fasterxml.jackson.databind.JsonNode;
@FunctionalInterface
public interface MethodHandler<Req extends JsonNode> {
CompletableFuture<SessionResult> handle(int id, Req data);
}
@@ -0,0 +1,15 @@
package dev.selimaj.session.types;
import java.util.concurrent.CompletableFuture;
import com.fasterxml.jackson.databind.JsonNode;
public record SessionResult(boolean isError, JsonNode value) {
public static CompletableFuture<SessionResult> ok(JsonNode value) {
return CompletableFuture.completedFuture(new SessionResult(false, value));
}
public static CompletableFuture<SessionResult> error(JsonNode value) {
return CompletableFuture.completedFuture(new SessionResult(false, value));
}
}
@@ -0,0 +1,10 @@
package dev.selimaj.session;
import com.fasterxml.jackson.databind.node.TextNode;
import dev.selimaj.session.types.Method;
public class Methods {
public static final Method<TextNode, TextNode, TextNode> Data = new Method<>("data",
TextNode.class, TextNode.class, TextNode.class);
}
@@ -0,0 +1,35 @@
package dev.selimaj.session;
import org.junit.jupiter.api.Test;
import com.fasterxml.jackson.databind.node.TextNode;
import dev.selimaj.session.types.SessionResult;
public class SessionTest {
static void testRequest() throws Exception {
Session session = Session.connect("ws://localhost:8080/");
session.onRequest(Methods.Data, (id, data) -> {
return SessionResult.ok(TextNode.valueOf("Response from client"));
});
TextNode response = session.request(Methods.Data, TextNode.valueOf("Hello from client")).get();
System.out.println(response);
session.close();
}
@Test
void requestTest() throws Exception {
testRequest();
}
public static void main(String[] args) {
try {
testRequest();
} catch (Exception e) {
e.printStackTrace();
}
}
}