@@ -9,7 +9,7 @@ and an example function that shows how to extend Jactl with your own application
9
9
## Requirements
10
10
11
11
* Java 11+
12
- * Jactl 1.0
12
+ * Jactl 1.0.0
13
13
* Gradle 8.0.2
14
14
* Vert.x 4.4.0
15
15
* jackson-databind 2.0.1
@@ -22,7 +22,7 @@ cd jactl-vertx
22
22
./gradlew build testJar
23
23
```
24
24
25
- That will build ` jactl-vertx-1.0.jar ` and ` jactl-vertx-1.0-SNAPSHOT-tests.jar ` under the ` build/libs ` directory.
25
+ That will build ` jactl-vertx-1.0.0. jar ` and ` jactl-vertx-1.0 .0-SNAPSHOT-tests.jar ` under the ` build/libs ` directory.
26
26
27
27
To push to your Maven repository you can use ` publishToMaven ` :
28
28
``` shell
@@ -31,16 +31,44 @@ To push to your Maven repository you can use `publishToMaven`:
31
31
32
32
## Integration
33
33
34
- To include the library in your application add the following gradle dependency:
34
+ ### Dependency
35
+
36
+ To use Jactl you will need to add a dependency on the Jactl library.
37
+
38
+ #### Gradle
39
+
40
+ In the ` dependencies ` section of your ` build.gradle ` file:
35
41
``` groovy
36
- implementation group:'io.jactl', name:'jactl-vertx', version:'1 .0'
42
+ implementation group: 'io.jactl', name: 'jactl-vertx', version: '1.0 .0'
37
43
```
38
44
39
45
If you want to use the example ` sendReceiveJson() ` function then also include a dependency on the ` tests ` jar:
40
46
``` groovy
41
- implementation group:'io.jactl', name:'jactl-vertx', version:'1.0', classifier:'tests'
47
+ implementation group:'io.jactl', name:'jactl-vertx', version:'1.0.0 ', classifier:'tests'
42
48
```
43
49
50
+ ### Maven
51
+
52
+ In the ` dependencies ` section of your ` pom.xml ` :
53
+ ``` xml
54
+ <dependency >
55
+ <groupId >io.jactl</groupId >
56
+ <artifactId >jactl-vertx</artifactId >
57
+ <version >1.0.0</version >
58
+ </dependency >
59
+ ```
60
+
61
+ To also include the ` tests ` jar:
62
+ ``` xml
63
+ <dependency >
64
+ <groupId >io.jactl</groupId >
65
+ <artifactId >jactl-vertx</artifactId >
66
+ <version >1.0.0</version >
67
+ <classifier >tests</classifier >
68
+ </dependency >
69
+ ```
70
+
71
+
44
72
### Jactl Environment Class
45
73
46
74
The ` io.jactl.vertx.JactlVertxEnv ` class provides a bridge between the Jactl runtime and the Vert.x runtime
@@ -88,7 +116,7 @@ To include these methods/functions in your Jactl REPL or Jactl commandline scrip
88
116
configuration file to include something like the following:
89
117
90
118
``` groovy
91
- def VERS = '1.0' // The jactl-vertx version to use
119
+ def VERS = '1.0.0 ' // The jactl-vertx version to use
92
120
def LIBS = "~/.m2/repository/io/jactl/jactl-vertx/${VERS}" // Location of the jars
93
121
94
122
// Specify the Vertx based environment class to use
@@ -203,19 +231,19 @@ going to run from and then add the `jactl-vertx` jar and `jactl-vertx` `tests` j
203
231
and invoke ` io.jactl.vertx.example.ExampleWebServer ` .
204
232
By default, it will listen on a random port:
205
233
``` shell
206
- $ java -cp jactl-vertx-1.0-tests.jar:jactl-vertx-1.0.jar io.jactl.vertx.example.ExampleWebServer
234
+ $ java -cp jactl-vertx-1.0.0 -tests.jar:jactl-vertx-1.0 .0.jar io.jactl.vertx.example.ExampleWebServer
207
235
Listening on localhost:52178
208
236
```
209
237
210
238
If you pass in a port number on the command line it will use that instead:
211
239
``` shell
212
- $ java -cp jactl-vertx-1.0-tests.jar:jactl-vertx-1.0.jar io.jactl.vertx.example.ExampleWebServer 8080
240
+ $ java -cp jactl-vertx-1.0.0 -tests.jar:jactl-vertx-1.0 .0.jar io.jactl.vertx.example.ExampleWebServer 8080
213
241
Listening on localhost:8080
214
242
```
215
243
216
244
You can specify the host address to listen on by using ` hostname:port ` :
217
245
``` shell
218
- $ java -cp jactl-vertx-1.0-tests.jar:jactl-vertx-1.0.jar io.jactl.vertx.example.ExampleWebServer 8080
246
+ $ java -cp jactl-vertx-1.0.0 -tests.jar:jactl-vertx-1.0 .0.jar io.jactl.vertx.example.ExampleWebServer 8080
219
247
Listening on localhost:8080
220
248
```
221
249
@@ -227,7 +255,7 @@ port.
227
255
228
256
Assume we run it on port 8080:
229
257
``` shell
230
- $ java -cp jactl-vertx-1.0-tests.jar:jactl-vertx-1.0.jar io.jactl.vertx.example.ExampleWebServer 8080
258
+ $ java -cp jactl-vertx-1.0.0 -tests.jar:jactl-vertx-1.0 .0.jar io.jactl.vertx.example.ExampleWebServer 8080
231
259
Listening on localhost:8080
232
260
```
233
261
0 commit comments