You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-31Lines changed: 14 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,12 @@ This is an open source rest service written in java which can be used to connect
4
4
5
5
## Pre-requisite Configuration
6
6
##### Properties
7
-
There is an application.properties file in the resources folder, connect the rest service and the instance of kdb by updating the properties below:
7
+
There is an `application.properties` file in the resources folder, connect the rest service and the instance of kdb by updating the properties below:
8
8
9
9
kdb.host=localhost
10
-
11
10
kdb.port=6007
12
-
13
11
kdb.username=admin
14
-
15
12
kdb.password=admin
16
-
17
13
server.port=8080
18
14
19
15
@@ -24,48 +20,41 @@ The executeFunction provides a means to call a predefined function and pass para
24
20
For example this is the format of a request call a function called plus which passes two arguments labelled "xarg" and "yarg" with values 96.3 and 9.7:
25
21
26
22
e.g.
27
-
{
28
-
23
+
24
+
{
29
25
"function_name" : "plus",
30
26
"arguments" :
31
27
{
32
28
"xarg" : "96.3",
33
29
"yarg" : "9.7"
34
30
}
35
-
}
31
+
}
36
32
37
33
The executeQuery provides a means to provide a query to the kdb instance, by default this endpoint is disabled using the property freeform.query.mode.enabled, to enable change the value to true.
38
34
For example this is the format of a synchronous query request where the user expects a response to be returned:
39
35
40
36
e.g.
41
-
{
42
-
43
-
"type" : "sync",
44
-
45
-
"query" : "select from table",
46
-
47
-
"response" : true
37
+
48
38
49
-
}
39
+
{
40
+
"type" : "sync",
41
+
"query" : "select from table",
42
+
"response" : true
43
+
}
50
44
51
45
##### Certificates
52
-
The requests are sent in HTTPS format and to provide this the project has a self-signed certifiate embedded within. It is strongly recommended that you add your own certificate. Updating the certificate will require and update to the following properties in application.properties:
46
+
The requests are sent in HTTPS format and to provide this the project has a self-signed certifiate embedded within. It is strongly recommended that you add your own certificate. Updating the certificate will require an update to the following properties in `application.properties`:
53
47
54
48
security.require-ssl=true
55
-
56
49
server.ssl.key-store-type=PKCS12
57
-
58
50
server.ssl.key-store=classpath:keystore.p12
59
-
60
51
server.ssl.key-store-password=aquaq2018
61
-
62
52
server.ssl.key-alias=tomcat
63
53
64
54
##### Authentication
65
-
The rest service uses basic authentication and is using a single username and password which are configured in the application.properties file:
55
+
The rest service uses basic authentication and is using a single username and password which are configured in the `application.properties` file:
66
56
67
57
basic.authentication.user=user
68
-
69
58
basic.authentication.password=pass
70
59
71
60
These value are provided within the header of the request, it is strongly recommended to invoke your own security if you use the project.
@@ -75,13 +64,7 @@ These value are provided within the header of the request, it is strongly recomm
75
64
76
65
There is a DockerFile within the project for deploying the project on docker.
77
66
78
-
Alternatively it can be run locally by providing the appropriate build configuration via command line or ide.
79
-
80
-
## Built with
81
-
Maven
82
-
83
-
## Licensing
84
-
Please see license file.
67
+
Alternatively it can be run locally by providing the appropriate build configuration via command line or IDE.
85
68
86
69
## Contributing
87
-
The branch is currently locked down and will require a pull request reviewed by a member of the aquaq team before any changes can be committed.
70
+
The branch is currently locked down and will require a pull request reviewed by a member of the AQUAQ team before any changes can be committed.
0 commit comments