diff --git a/README.md b/README.md index 3c68f368..85ac5b58 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,7 @@ The rest of this README is structured as follows: - [Developer information](#developer-information) - [Components](#components) - [Release steps](#release-steps) + - [Code conventions](#code-conventions) - [(advanced) Administering a Knowledge Engine runtime](#advanced-administering-a-knowledge-engine-runtime) - [Starting the Knowledge Engine in local mode](#starting-the-knowledge-engine-in-local-mode) - [Starting the Knowledge Engine in distributed mode](#starting-the-knowledge-engine-in-distributed-mode) @@ -181,15 +182,19 @@ This section gives more detailed information about the project's structure, and The Knowledge Engine project consists of the following Maven modules: - `smart-connector` - - This is the implementation of the smart connector, with the Java developer API. For instructions on how to use it, refer to [the documentation](./docs/docs/getting_started.md). + - This is the implementation of the smart connector, with the Java developer API. For instructions on how to use it, refer to [the documentation](./docs/docs/getting_started.md). The high-level design of the smart connector can be found in [the wiki](https://github.com/TNO/knowledge-engine/wiki/High%E2%80%90level-Design). - `smart-connector-api` - This module contains interfaces for the smart connector and other classes. It is made as a separate module so that it is easy to use different implementations of the interfaces. - `smart-connector-rest-server` - This module contains the REST API layer that is built on top of the Java Developer API. - `smart-connector-rest-dist` - - A distribution of the server that provides the REST API layer for your smart connector(s), and uses the smart connector implementation from the `smart-connector` module. For instructions on how to use it, refer to [the section below](#using-the-rest-api). For instructions on how to set it up, refer to [this section](#advanced-administering-a-knowledge-engine-runtime). + - A distribution of the server that provides the REST API layer for your smart connector(s), and uses the smart connector implementation from the `smart-connector` module. For instructions on how to use it, refer to [the section below](#using-the-rest-api). For instructions on how to set it up, refer to [this section](#advanced-administering-a-knowledge-engine-runtime). - `admin-ui` - A REST API which provides meta-data about smart connectors in a knowledge network. Can be used in an administration inferface for a knowledge network. It is implemented as a knowledge base that uses metadata of other knowledge bases. +- `reasoner` + - This module contains the reasoner specifically designed for the distributive nature of the knowledge engine. +- `knowledge-directory` + - This module contains the Knowledge Directory which is used to find other knowledge engine runtimes. ## Release steps These are instructions on what to do when we release a new version of the knowledge engine. @@ -231,6 +236,9 @@ docker buildx build ./admin-ui --platform linux/arm64,linux/amd64 --tag ghcr.io/ 2. Include the same release notes 10. Inform mailing list(s) (and [the blog](https://www.knowledge-engine.eu/blog/)) about the new release. +## Code conventions +The code conventions of the knowledge-engine can be found in the `/ide` folder in the Eclipse IDE format. The format can often also be imported in other Java IDEs like IntelliJ, VSCode or Netbeans. + ## (advanced) Administering a Knowledge Engine runtime To start a new instance of the REST API knowledge engine version 1.2.5, make sure you have `git checkout 1.2.5` the tag `1.2.5`. Now make sure you run the `mvn clean install` command successfully from the root of the repository. diff --git a/admin-ui/pom.xml b/admin-ui/pom.xml index ea68c557..1c267656 100644 --- a/admin-ui/pom.xml +++ b/admin-ui/pom.xml @@ -16,9 +16,6 @@ 2.2.26 - 11.0.24 - 3.1.9 - 2.18.2 UTF-8 @@ -39,12 +36,10 @@ com.fasterxml.jackson.datatype jackson-datatype-joda - ${jackson-version} com.fasterxml.jackson.jaxrs jackson-jaxrs-json-provider - ${jackson-version} @@ -52,25 +47,20 @@ org.slf4j slf4j-simple - 2.0.16 - org.eclipse.jetty jetty-util - ${jetty-version} org.eclipse.jetty jetty-servlet - ${jetty-version} org.eclipse.jetty jetty-server - ${jetty-version} @@ -78,22 +68,18 @@ org.glassfish.jersey.containers jersey-container-servlet-core - ${jersey3-version} org.glassfish.jersey.inject jersey-hk2 - ${jersey3-version} org.glassfish.jersey.media jersey-media-multipart - ${jersey3-version} org.glassfish.jersey.containers jersey-container-servlet - ${jersey3-version} @@ -115,22 +101,19 @@ org.junit.jupiter junit-jupiter-api - 5.11.3 test org.junit.jupiter junit-jupiter-engine - 5.11.3 test org.junit.jupiter junit-jupiter - 5.11.3 test - + eu.knowledge.engine smart-connector-rest-server diff --git a/examples/java-api/pom.xml b/examples/java-api/pom.xml index d3c048da..b4394b48 100644 --- a/examples/java-api/pom.xml +++ b/examples/java-api/pom.xml @@ -1,5 +1,6 @@ + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 4.0.0 examples jar @@ -11,7 +12,8 @@ ../.. - A Knowledge Base that shares power measurements of an EEBUS submeter. + A Knowledge Base that shares power measurements of an EEBUS + submeter. @@ -43,20 +45,17 @@ org.slf4j slf4j-simple - 2.0.16 org.junit.jupiter junit-jupiter-api - 5.11.3 test org.junit.jupiter junit-jupiter-engine - 5.11.3 test diff --git a/knowledge-directory/pom.xml b/knowledge-directory/pom.xml index 0f95288f..840ce1b0 100644 --- a/knowledge-directory/pom.xml +++ b/knowledge-directory/pom.xml @@ -16,10 +16,6 @@ 2.2.26 3.1.0 - 11.0.24 - 3.1.9 - 2.18.2 - 4.13.1 UTF-8 @@ -38,45 +34,37 @@ org.junit.jupiter junit-jupiter-api - 5.11.3 test org.junit.jupiter junit-jupiter-engine - 5.11.3 test org.junit.jupiter junit-jupiter - 5.11.3 test org.glassfish.jersey.containers jersey-container-servlet-core - ${jersey3-version} org.glassfish.jersey.inject jersey-hk2 - ${jersey3-version} org.glassfish.jersey.media jersey-media-multipart - ${jersey3-version} com.fasterxml.jackson.datatype jackson-datatype-joda - ${jackson-version} com.fasterxml.jackson.jaxrs jackson-jaxrs-json-provider - ${jackson-version} com.fasterxml.jackson.core @@ -117,25 +105,22 @@ org.slf4j slf4j-simple - 2.0.16 + org.eclipse.jetty jetty-util - ${jetty-version} org.eclipse.jetty jetty-servlet - ${jetty-version} org.eclipse.jetty jetty-server - ${jetty-version} diff --git a/pom.xml b/pom.xml index a14ab417..2e4ea77a 100644 --- a/pom.xml +++ b/pom.xml @@ -7,7 +7,8 @@ ke-parent pom ${revision} - This artifact is a suite of tools for orchestrating semantic data exchange through a knowledge network. + This artifact is a suite of tools for orchestrating semantic + data exchange through a knowledge network. smart-connector @@ -71,7 +72,10 @@ + 11.0.24 17 + 3.1.9 + 2.18.2 17 17 1.2.6-SNAPSHOT @@ -79,12 +83,87 @@ + + + org.eclipse.jetty + jetty-util + ${jetty-version} + + + + org.eclipse.jetty + jetty-servlet + ${jetty-version} + + + + org.eclipse.jetty + jetty-server + ${jetty-version} + + + + org.glassfish.jersey.containers + jersey-container-servlet-core + ${jersey3-version} + + + org.glassfish.jersey.inject + jersey-hk2 + ${jersey3-version} + + + org.glassfish.jersey.media + jersey-media-multipart + ${jersey3-version} + + + org.glassfish.jersey.containers + jersey-container-servlet + ${jersey3-version} + + + + com.fasterxml.jackson.datatype + jackson-datatype-joda + ${jackson-version} + + + com.fasterxml.jackson.jaxrs + jackson-jaxrs-json-provider + ${jackson-version} + + + + + + org.junit.jupiter + junit-jupiter-api + 5.11.3 + + + org.junit.jupiter + junit-jupiter-engine + 5.11.3 + + + org.junit.jupiter + junit-jupiter + 5.11.3 + org.apache.jena apache-jena-libs 5.2.0 pom + + + + org.slf4j + slf4j-simple + 2.0.16 + diff --git a/reasoner/pom.xml b/reasoner/pom.xml index bf282b0d..1cfbddf1 100644 --- a/reasoner/pom.xml +++ b/reasoner/pom.xml @@ -19,27 +19,23 @@ org.junit.jupiter junit-jupiter-api - 5.11.3 test org.junit.jupiter junit-jupiter-engine - 5.11.3 test org.junit.jupiter junit-jupiter - 5.11.3 test - + org.slf4j slf4j-simple - 2.0.16 diff --git a/smart-connector-api/pom.xml b/smart-connector-api/pom.xml index b7f5c165..365a8cb2 100644 --- a/smart-connector-api/pom.xml +++ b/smart-connector-api/pom.xml @@ -15,7 +15,6 @@ org.slf4j slf4j-simple - 2.0.16 eu.knowledge.engine diff --git a/smart-connector-rest-dist/pom.xml b/smart-connector-rest-dist/pom.xml index 6de1e16e..d5b4f2cf 100644 --- a/smart-connector-rest-dist/pom.xml +++ b/smart-connector-rest-dist/pom.xml @@ -25,19 +25,16 @@ org.junit.jupiter junit-jupiter-api - 5.11.3 test org.junit.jupiter junit-jupiter-engine - 5.11.3 test org.junit.jupiter junit-jupiter - 5.11.3 test @@ -47,7 +44,8 @@ org.apache.maven.plugins maven-surefire-plugin - false + false diff --git a/smart-connector-rest-server/pom.xml b/smart-connector-rest-server/pom.xml index 052e483a..b677632b 100644 --- a/smart-connector-rest-server/pom.xml +++ b/smart-connector-rest-server/pom.xml @@ -12,9 +12,6 @@ 2.2.26 - 11.0.24 - 3.1.9 - 2.18.2 UTF-8 @@ -34,30 +31,25 @@ com.fasterxml.jackson.jaxrs jackson-jaxrs-json-provider - ${jackson-version} org.slf4j slf4j-simple - 2.0.16 org.eclipse.jetty jetty-util - ${jetty-version} org.eclipse.jetty jetty-servlet - ${jetty-version} org.eclipse.jetty jetty-server - ${jetty-version} @@ -65,22 +57,18 @@ org.glassfish.jersey.containers jersey-container-servlet-core - ${jersey3-version} org.glassfish.jersey.inject jersey-hk2 - ${jersey3-version} org.glassfish.jersey.media jersey-media-multipart - ${jersey3-version} org.glassfish.jersey.containers jersey-container-servlet - ${jersey3-version} @@ -120,19 +108,16 @@ org.junit.jupiter junit-jupiter-api - 5.11.3 test org.junit.jupiter junit-jupiter-engine - 5.11.3 test org.junit.jupiter junit-jupiter - 5.11.3 test diff --git a/smart-connector/pom.xml b/smart-connector/pom.xml index 410f0422..86b260c9 100644 --- a/smart-connector/pom.xml +++ b/smart-connector/pom.xml @@ -25,26 +25,22 @@ org.slf4j slf4j-simple - 2.0.16 org.junit.jupiter junit-jupiter-api - 5.11.3 test org.junit.jupiter junit-jupiter-engine - 5.11.3 test org.junit.jupiter junit-jupiter - 5.11.3 test @@ -95,12 +91,10 @@ com.fasterxml.jackson.datatype jackson-datatype-joda - ${jackson-version} com.fasterxml.jackson.jaxrs jackson-jaxrs-json-provider - ${jackson-version} jakarta.xml.bind @@ -128,31 +122,26 @@ org.glassfish.jersey.containers jersey-container-servlet-core - ${jersey3-version} org.glassfish.jersey.inject jersey-hk2 - ${jersey3-version} org.eclipse.jetty jetty-util - ${jetty-version} org.eclipse.jetty jetty-servlet - ${jetty-version} org.eclipse.jetty jetty-server - ${jetty-version} @@ -193,9 +182,6 @@ 2.2.26 - 11.0.24 - 3.1.9 - 2.18.2 6.1.0