Mule Shell (Still in Development)

A cloud-based shell application with JDK JShell API.

Requirements

The project has the following (minimum) requirements to compile/run:

Java Development Kit 11

The project used Java Development Kit version 11 (Oracle) to compile the Java sources.

The project uses the JShell included in the JDK, so running the program under just the Java Runtime Environment will not work.
Apache Maven 3.6

The project used Maven 3.6.1 to manage/build with dependencies.

To run the demonstration project:

Make sure you have at least Java Development Kit 11 (project created with JDK 11.0.2 Oracle).
Make sure you have at least Apache Maven 3.6 (project tested with Maven 3.6.1).
Create the demo.jar file by packaging the project:
```
 mvn package -f pom.xml
```
Run the demo.jar file with JDK Java (The JDK is needed as the JRE does not have the JDK JShell modules):
```
 java -jar mule-shell-universe/demo.jar
```
Navigate to the local host in a browser:
```
 http://localhost:8080/mule-shell-demo
```
Try out the interactive console (still in development).

To compile/package the project with Apache Maven:

Rebuild base project (skipping tests):

mvn clean package -pl '!mule-shell-universe' -DskipTests=true

Generate model:

mvn clean generate-sources -pl=mule-shell-model -am

Compile debug:

mvn test-compile -pl=mule-shell-debug -am

Compile common:

mvn test-compile -pl=mule-shell-common -am

Compile model:

mvn test-compile -pl=mule-shell-model -am

Compile client:

mvn test-compile -pl=mule-shell-client -am

Compile server:

mvn test-compile -pl=mule-shell-server -am

Compiling the project in an IDE:

Jetbrains IntelliJ IDEA:

To rebuild the project in IntelliJ, simply call the clean and/or package Maven goals.

IntelliJ IDE does not (or shouldn't?) include the BOM POM as a resolved dependency. To be able to repackage only a given module, ensure that you add the BOM module to the Maven module playlist.

Repackage mule-shell-debug with resolve workspace dependencies selected:
```
clean package -pl=mule-shell-debug,mule-shell-bom -f pom.xml
```
Repackage mule-shell-common with resolve workspace dependencies selected:
```
clean package -pl=mule-shell-common,mule-shell-bom -f pom.xml
```
Repackage mule-shell-model with resolve workspace dependencies selected:
```
clean package -pl=mule-shell-model,mule-shell-bom -f pom.xml
```
Repackage mule-shell-client with resolve workspace dependencies selected:
```
 clean package -pl=mule-shell-client,mule-shell-bom -f pom.xml
```
Repackage mule-shell-server with resolve workspace dependencies selected:
```
clean package -pl=mule-shell-server,mule-shell-bom -f pom.xml
```
Repackage mule-shell-universe with resolve workspace dependencies selected:
```
clean package -pl=mule-shell-universe,mule-shell-bom -f pom.xml
```

When running a Maven goal against a single module, ensure that all other project modules, that are dependencies, are built.

Running the Drop Wizard application in Java 9, 10, 11

The Java Platform Module System will print a warning message about illegal reflective access. At the time of writing, no added effort has been made by the contributors of Mule Shell to bring the application to JPMS (as most dependencies are/were unnamed modules). The only reflective access dependency noted was that of Faster XML. The message can "suppressed" by flagging all unnamed modules as open (JVM parameter):

--add-opens java.base/java.lang=ALL-UNNAMED

To install/deploy the project with Apache Maven:

Artifacts can be installed to the local repository, ensuring that test jar dependencies are also installed. The shadePhase property is to suppress the creation of the shaded demo.jar file.

Install the base project to the local repository (skip tests and shading):

mvn clean install -pl '!mule-shell-universe' -DskipTests=true -DshadePhase=none -f pom.xml

Install the project to the local repository (skip tests and shading):

mvn clean install -DskipTests=true -DshadePhase=none -f pom.xml

osmundf / mule-shell