Skip to content

Decouple rest from iotdb-server using ExternalService framework #17099

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CritasWang merged 10 commits into from
Jan 28, 2026
+431 −1,612
Merged

Decouple rest from iotdb-server using ExternalService framework #17099

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
25d1132
Move rest to independent module
LJW21-02 Jan 21, 2026
a4bf091
Move openapi to independent module + Fix tests
LJW21-02 Jan 22, 2026
c684121
Fix dependencies
LJW21-02 Jan 26, 2026
48abc0b
Fix dependencies
LJW21-02 Jan 27, 2026
3fbe138
Remove unnecessary code
LJW21-02 Jan 28, 2026
c984e48
Add comments
LJW21-02 Jan 28, 2026
3a15324
Remove unnecessary code
LJW21-02 Jan 28, 2026
b50a956
Remove unnecessary code + Move dependencies
LJW21-02 Jan 28, 2026
2288a13
Remove unnecessary tests
LJW21-02 Jan 28, 2026
14d34da
Remove unused dependencies
LJW21-02 Jan 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions distribution/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,12 @@
<version>2.0.7-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.iotdb</groupId>
<artifactId>rest</artifactId>
<version>2.0.7-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
</dependencies>
<build>
<plugins>
Expand Down
4 changes: 4 additions & 0 deletions distribution/src/assembly/all.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,10 @@
<source>${maven.multiModuleProjectDirectory}/external-service-impl/mqtt/target/mqtt-${project.version}-jar-with-dependencies.jar</source>
<outputDirectory>lib</outputDirectory>
</file>
<file>
<source>${maven.multiModuleProjectDirectory}/external-service-impl/rest/target/rest-${project.version}-jar-with-dependencies.jar</source>
<outputDirectory>lib</outputDirectory>
</file>
</files>
<componentDescriptors>
<componentDescriptor>common-files.xml</componentDescriptor>
Expand Down
4 changes: 4 additions & 0 deletions distribution/src/assembly/datanode.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,10 @@
<source>${maven.multiModuleProjectDirectory}/external-service-impl/mqtt/target/mqtt-${project.version}-jar-with-dependencies.jar</source>
<outputDirectory>lib</outputDirectory>
</file>
<file>
<source>${maven.multiModuleProjectDirectory}/external-service-impl/rest/target/rest-${project.version}-jar-with-dependencies.jar</source>
<outputDirectory>lib</outputDirectory>
</file>
</files>
<componentDescriptors>
<componentDescriptor>common-files.xml</componentDescriptor>
Expand Down
4 changes: 4 additions & 0 deletions distribution/src/assembly/external-service-impl.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,9 @@
<source>${maven.multiModuleProjectDirectory}/external-service-impl/mqtt/target/mqtt-${project.version}-jar-with-dependencies.jar</source>
<outputDirectory>/</outputDirectory>
</file>
<file>
<source>${maven.multiModuleProjectDirectory}/external-service-impl/rest/target/rest-${project.version}-jar-with-dependencies.jar</source>
<outputDirectory>/</outputDirectory>
</file>
</files>
</assembly>
2 changes: 2 additions & 0 deletions external-service-impl/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
<packaging>pom</packaging>
<modules>
<module>mqtt</module>
<module>rest</module>
<module>rest-openapi</module>
</modules>
<properties>
<maven.compiler.source>8</maven.compiler.source>
Expand Down
34 changes: 19 additions & 15 deletions iotdb-protocol/openapi/pom.xml → external-service-impl/rest-openapi/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.apache.iotdb</groupId>
<artifactId>iotdb-protocol</artifactId>
<artifactId>external-service-impl</artifactId>
<version>2.0.7-SNAPSHOT</version>
</parent>
<artifactId>openapi</artifactId>
<name>IoTDB: Protocol: OpenAPI</name>
<artifactId>rest-openapi</artifactId>
<name>IoTDB: External-Service-Impl: Rest-OpenAPI</name>
<dependencies>
<dependency>
<groupId>io.swagger</groupId>
Expand Down Expand Up @@ -91,9 +91,9 @@
<configuration>
<inputSpec>${project.basedir}/src/main/openapi3/iotdb_rest_common.yaml</inputSpec>
<output>${project.build.directory}/generated-sources/java</output>
<apiPackage>org.apache.iotdb.db.protocol.rest</apiPackage>
<modelPackage>org.apache.iotdb.db.protocol.rest.model</modelPackage>
<invokerPackage>org.apache.iotdb.db.protocol.rest.invoker</invokerPackage>
<apiPackage>org.apache.iotdb.rest.protocol</apiPackage>
<modelPackage>org.apache.iotdb.rest.protocol.model</modelPackage>
<invokerPackage>org.apache.iotdb.rest.protocol.invoker</invokerPackage>
<generatorName>jaxrs-jersey</generatorName>
<groupId>org.apache.iotdb</groupId>
<artifactId>iotdb-rest-service</artifactId>
Expand All @@ -118,9 +118,9 @@
<configuration>
<inputSpec>${project.basedir}/src/main/openapi3/iotdb_rest_v1.yaml</inputSpec>
<output>${project.build.directory}/generated-sources/java</output>
<apiPackage>org.apache.iotdb.db.protocol.rest.v1</apiPackage>
<modelPackage>org.apache.iotdb.db.protocol.rest.v1.model</modelPackage>
<invokerPackage>org.apache.iotdb.db.protocol.rest.v1.invoker</invokerPackage>
<apiPackage>org.apache.iotdb.rest.protocol.v1</apiPackage>
<modelPackage>org.apache.iotdb.rest.protocol.v1.model</modelPackage>
<invokerPackage>org.apache.iotdb.rest.protocol.v1.invoker</invokerPackage>
<generatorName>jaxrs-jersey</generatorName>
<groupId>org.apache.iotdb</groupId>
<artifactId>iotdb-rest-service</artifactId>
Expand All @@ -145,9 +145,9 @@
<configuration>
<inputSpec>${project.basedir}/src/main/openapi3/iotdb_rest_v2.yaml</inputSpec>
<output>${project.build.directory}/generated-sources/java</output>
<apiPackage>org.apache.iotdb.db.protocol.rest.v2</apiPackage>
<modelPackage>org.apache.iotdb.db.protocol.rest.v2.model</modelPackage>
<invokerPackage>org.apache.iotdb.db.protocol.rest.v2.invoker</invokerPackage>
<apiPackage>org.apache.iotdb.rest.protocol.v2</apiPackage>
<modelPackage>org.apache.iotdb.rest.protocol.v2.model</modelPackage>
<invokerPackage>org.apache.iotdb.rest.protocol.v2.invoker</invokerPackage>
<generatorName>jaxrs-jersey</generatorName>
<groupId>org.apache.iotdb</groupId>
<artifactId>iotdb-rest-service</artifactId>
Expand All @@ -172,9 +172,9 @@
<configuration>
<inputSpec>${project.basedir}/src/main/openapi3/iotdb_rest_table_v1.yaml</inputSpec>
<output>${project.build.directory}/generated-sources/java</output>
<apiPackage>org.apache.iotdb.db.protocol.rest.table.v1</apiPackage>
<modelPackage>org.apache.iotdb.db.protocol.rest.table.v1.model</modelPackage>
<invokerPackage>org.apache.iotdb.db.protocol.rest.table.v1.invoker</invokerPackage>
<apiPackage>org.apache.iotdb.rest.protocol.table.v1</apiPackage>
<modelPackage>org.apache.iotdb.rest.protocol.table.v1.model</modelPackage>
<invokerPackage>org.apache.iotdb.rest.protocol.table.v1.invoker</invokerPackage>
<generatorName>jaxrs-jersey</generatorName>
<groupId>org.apache.iotdb</groupId>
<artifactId>iotdb-rest-service</artifactId>
Expand Down Expand Up @@ -232,6 +232,10 @@
<!-- We just need this dependency to prevent the compiler from freaking out on unused imports -->
<usedDependency>org.glassfish.jersey.media:jersey-media-multipart</usedDependency>
</usedDependencies>
<ignoredDependencies>
<ignoredDependency>org.apache.iotdb:external-service-api</ignoredDependency>
<ignoredDependency>junit:junit</ignoredDependency>
</ignoredDependencies>
</configuration>
</plugin>
</plugins>
Expand Down
0 .../src/main/openapi3/iotdb_rest_common.yaml → .../src/main/openapi3/iotdb_rest_common.yaml
View file
Open in desktop
File renamed without changes.
0 ...rc/main/openapi3/iotdb_rest_table_v1.yaml → ...rc/main/openapi3/iotdb_rest_table_v1.yaml
View file
Open in desktop
File renamed without changes.
0 ...napi/src/main/openapi3/iotdb_rest_v1.yaml → ...napi/src/main/openapi3/iotdb_rest_v1.yaml
View file
Open in desktop
File renamed without changes.
0 ...napi/src/main/openapi3/iotdb_rest_v2.yaml → ...napi/src/main/openapi3/iotdb_rest_v2.yaml
View file
Open in desktop
File renamed without changes.
226 changes: 226 additions & 0 deletions external-service-impl/rest/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,226 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.

-->
<project xmlns="http://maven.apache.org/POM/4.0.0" 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">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.apache.iotdb</groupId>
<artifactId>external-service-impl</artifactId>
<version>2.0.7-SNAPSHOT</version>
</parent>
<artifactId>rest</artifactId>
<name>IoTDB: External-Service-Impl: Rest</name>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>org.glassfish.jersey.inject</groupId>
<artifactId>jersey-hk2</artifactId>
<scope>runtime</scope>
<exclusions>
<!-- repeated in node commons -->
<exclusion>
<groupId>jakarta.annotation</groupId>
<artifactId>jakarta.annotation-api</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.apache.iotdb</groupId>
<artifactId>rest-openapi</artifactId>
<version>2.0.7-SNAPSHOT</version>
<exclusions>
<!-- repeated in datanode -->
<exclusion>
<groupId>jakarta.xml.bind</groupId>
<artifactId>jakarta.xml.bind-api</artifactId>
</exclusion>
<!-- repeated in datanode -->
<exclusion>
<groupId>jakarta.validation</groupId>
<artifactId>jakarta.validation-api</artifactId>
</exclusion>
<!-- repeated in datanode -->
<exclusion>
<groupId>org.javassist</groupId>
<artifactId>javassist</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>jakarta.servlet</groupId>
<artifactId>jakarta.servlet-api</artifactId>
</dependency>
<dependency>
<groupId>org.glassfish.jersey.containers</groupId>
<artifactId>jersey-container-servlet-core</artifactId>
<exclusions>
<!-- repeated in datanode -->
<exclusion>
<groupId>jakarta.validation</groupId>
<artifactId>jakarta.validation-api</artifactId>
</exclusion>
<!-- repeated in node commons -->
<exclusion>
<groupId>jakarta.annotation</groupId>
<artifactId>jakarta.annotation-api</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.eclipse.jetty</groupId>
<artifactId>jetty-servlet</artifactId>
</dependency>
<dependency>
<groupId>org.eclipse.jetty</groupId>
<artifactId>jetty-util</artifactId>
</dependency>
<dependency>
<groupId>org.eclipse.jetty</groupId>
<artifactId>jetty-server</artifactId>
</dependency>
<dependency>
<groupId>org.eclipse.jetty</groupId>
<artifactId>jetty-http</artifactId>
</dependency>
<dependency>
<groupId>org.apache.iotdb</groupId>
<artifactId>node-commons</artifactId>
<version>2.0.7-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.iotdb</groupId>
<artifactId>iotdb-server</artifactId>
<version>2.0.7-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.iotdb</groupId>
<artifactId>iotdb-session</artifactId>
<version>2.0.7-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.github.ben-manes.caffeine</groupId>
<artifactId>caffeine</artifactId>
<scope>provided</scope>
<exclusions>
<!-- version conflicts with checker-qual in guava -->
<exclusion>
<groupId>org.checkerframework</groupId>
<artifactId>checker-qual</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.apache.iotdb</groupId>
<artifactId>service-rpc</artifactId>
<version>2.0.7-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>jakarta.ws.rs</groupId>
<artifactId>jakarta.ws.rs-api</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.iotdb</groupId>
<artifactId>iotdb-thrift</artifactId>
<version>2.0.7-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.tsfile</groupId>
<artifactId>tsfile</artifactId>
<version>${tsfile.version}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.tsfile</groupId>
<artifactId>common</artifactId>
<version>${tsfile.version}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.iotdb</groupId>
<artifactId>iotdb-thrift-commons</artifactId>
<version>2.0.7-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.antlr</groupId>
<artifactId>antlr4-runtime</artifactId>
<scope>provided</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<version>${maven.assembly.version}</version>
<configuration>
<descriptorRefs>
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
</configuration>
<executions>
<execution>
<id>make-assembly</id>
<!-- bind to the packaging phase -->
<goals>
<goal>single</goal>
</goals>
<!-- this is used for inheritance merges -->
<phase>package</phase>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<configuration>
<ignoredDependencies>
<ignoredDependency>org.apache.tsfile:common</ignoredDependency>
<ignoredDependency>junit:junit</ignoredDependency>
</ignoredDependencies>
<usedDependencies>
<!-- This dependency is required at runtime, when enabling the rest service -->
<usedDependency>org.glassfish.jersey.inject:jersey-hk2</usedDependency>
</usedDependencies>
</configuration>
</plugin>
</plugins>
</build>
</project>
Loading
Loading