JDWP over Web Socket

Sonar status :

JDWP over Web Socket aim to help Java developer debugging on cloud environment. No need to open debugging port you can use the HTTP or HTTPS port.

Prerequisites

• Enable web socket on revers proxies
• JDWP compatible debugger like Intellij/Eclipse/Netbeans

Downloads

https://github.com/famaridon/jdwp-over-ws/releases

How dose it works?

All debug tcp traffic is forwarded over web socket.

Debug JEE (Wildfly, JBoss, ... )

How dose it works

This is the best use case. The jdwp-over-ws server get web socket ws:// or wss:// on the current http:// or https:// listening port. You don't need to open new port or run an other process.

Installation

Simply add the jdwp-over-ws.war to your JEE server.

Configuration

Configuration search for YAML files in this order:

• if JDWP_OVER_WS_CONF environment variable is set and file exist (if not found WARN log)
• if jdwp-over-ws.yaml exist in working directory
• if jdwp-over-ws.yaml exist in classpath
• always jdwp-over-ws-default.yaml in classpath for default configuration

All files are merged and the first overwrite the second, the second overwrite the third, ...

Default configuration jdwp-over-ws-default.yaml is like this.

server:
  security:
    token: "${env:DEBUG_TOKEN}"
  remote-debug:
    host: "127.0.0.1"
    port: 5005

Note you can force server.security.token by setting DEBUG_TOKEN environment variable.

Client usage

Display help :

java -jar jdwp-over-ws-client-<version>-shaded.jar -h

usage: cli
    --disable-reconnect   if connexion fail will not wait for new
                          connection
 -h,--help                print the help
 -p,--port <arg>          the local listening port
 -r,--remote <arg>        the remote web service url
 -t,--token <arg>         the generated server token

Sample usage :

java -jar jdwp-over-ws-client-<version>-shaded.jar -p 9999 -r ws://localhost:8080/tcp-over-ws/ws/tunnel -t <token> 

Roadmap

https://github.com/famaridon/jdwp-over-ws/milestones

Developer guide

Build

mvn clean install

Code style

This project use the Google style guide.

You can install this code style as describe https://github.com/HPI-Information-Systems/Metanome/wiki/Installing-the-google-styleguide-settings-in-intellij-and-eclipse