This is an automated email from the ASF dual-hosted git repository.
jackietien pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iotdb.git
The following commit(s) were added to refs/heads/master by this push:
new 79e4a73d1f [IOTDB-4321] Migrate Trigger-API into a seperate module
(#7218)
79e4a73d1f is described below
commit 79e4a73d1fc1f1f9d01bc5c3dc4d1da009e7aaa2
Author: Liao Lanyu <[email protected]>
AuthorDate: Sun Sep 4 20:43:39 2022 +0800
[IOTDB-4321] Migrate Trigger-API into a seperate module (#7218)
---
docs/UserGuide/Process-Data/Triggers.md | 2 +-
docs/zh/UserGuide/Process-Data/Triggers.md | 2 +-
.../org/apache/iotdb/trigger/AlertingExample.java | 2 +-
.../org/apache/iotdb/trigger/TriggerExample.java | 2 +-
.../db/engine/trigger/example/Accumulator.java | 2 +-
.../iotdb/db/engine/trigger/example/Counter.java | 2 +-
node-commons/pom.xml | 5 ++
pom.xml | 1 +
.../iotdb/db/engine/trigger/api/Trigger.java | 1 +
.../db/engine/trigger/builtin/ForwardTrigger.java | 2 +-
.../engine/trigger/executor/TriggerExecutor.java | 2 +-
.../metadata/idtable/trigger_example/Counter.java | 2 +-
trigger-api/pom.xml | 73 ++++++++++++++++++++++
.../java/org/apache/iotdb/trigger/api/Trigger.java | 68 ++++++++++++++++++++
.../iotdb}/trigger/api/TriggerAttributes.java | 2 +-
15 files changed, 158 insertions(+), 10 deletions(-)
diff --git a/docs/UserGuide/Process-Data/Triggers.md
b/docs/UserGuide/Process-Data/Triggers.md
index 950aa50b4c..0dc5407b42 100644
--- a/docs/UserGuide/Process-Data/Triggers.md
+++ b/docs/UserGuide/Process-Data/Triggers.md
@@ -804,7 +804,7 @@ It shows:
package org.apache.iotdb.trigger;
import org.apache.iotdb.db.engine.trigger.api.Trigger;
-import org.apache.iotdb.db.engine.trigger.api.TriggerAttributes;
+import org.apache.iotdb.trigger.api.TriggerAttributes;
import org.apache.iotdb.commons.path.PartialPath;
import org.apache.iotdb.db.engine.trigger.sink.mqtt.MQTTConfiguration;
import org.apache.iotdb.db.engine.trigger.sink.mqtt.MQTTEvent;
diff --git a/docs/zh/UserGuide/Process-Data/Triggers.md
b/docs/zh/UserGuide/Process-Data/Triggers.md
index 5413f81766..1ef4ffdb41 100644
--- a/docs/zh/UserGuide/Process-Data/Triggers.md
+++ b/docs/zh/UserGuide/Process-Data/Triggers.md
@@ -743,7 +743,7 @@ INSERT INTO root.mqtt.d1(timestamp, s2) VALUES (2, true);
package org.apache.iotdb.trigger;
import org.apache.iotdb.db.engine.trigger.api.Trigger;
-import org.apache.iotdb.db.engine.trigger.api.TriggerAttributes;
+import org.apache.iotdb.trigger.api.TriggerAttributes;
import org.apache.iotdb.commons.path.PartialPath;
import org.apache.iotdb.db.engine.trigger.sink.mqtt.MQTTConfiguration;
import org.apache.iotdb.db.engine.trigger.sink.mqtt.MQTTEvent;
diff --git
a/example/trigger/src/main/java/org/apache/iotdb/trigger/AlertingExample.java
b/example/trigger/src/main/java/org/apache/iotdb/trigger/AlertingExample.java
index 48975a1dd8..c9bb2b663d 100644
---
a/example/trigger/src/main/java/org/apache/iotdb/trigger/AlertingExample.java
+++
b/example/trigger/src/main/java/org/apache/iotdb/trigger/AlertingExample.java
@@ -21,10 +21,10 @@ package org.apache.iotdb.trigger;
import org.apache.iotdb.commons.path.PartialPath;
import org.apache.iotdb.db.engine.trigger.api.Trigger;
-import org.apache.iotdb.db.engine.trigger.api.TriggerAttributes;
import
org.apache.iotdb.db.engine.trigger.sink.alertmanager.AlertManagerConfiguration;
import org.apache.iotdb.db.engine.trigger.sink.alertmanager.AlertManagerEvent;
import
org.apache.iotdb.db.engine.trigger.sink.alertmanager.AlertManagerHandler;
+import org.apache.iotdb.trigger.api.TriggerAttributes;
import java.io.IOException;
import java.util.HashMap;
diff --git
a/example/trigger/src/main/java/org/apache/iotdb/trigger/TriggerExample.java
b/example/trigger/src/main/java/org/apache/iotdb/trigger/TriggerExample.java
index 7e1a6155a7..a41346ecc3 100644
--- a/example/trigger/src/main/java/org/apache/iotdb/trigger/TriggerExample.java
+++ b/example/trigger/src/main/java/org/apache/iotdb/trigger/TriggerExample.java
@@ -21,7 +21,6 @@ package org.apache.iotdb.trigger;
import org.apache.iotdb.commons.path.PartialPath;
import org.apache.iotdb.db.engine.trigger.api.Trigger;
-import org.apache.iotdb.db.engine.trigger.api.TriggerAttributes;
import org.apache.iotdb.db.engine.trigger.sink.local.LocalIoTDBConfiguration;
import org.apache.iotdb.db.engine.trigger.sink.local.LocalIoTDBEvent;
import org.apache.iotdb.db.engine.trigger.sink.local.LocalIoTDBHandler;
@@ -30,6 +29,7 @@ import org.apache.iotdb.db.engine.trigger.sink.mqtt.MQTTEvent;
import org.apache.iotdb.db.engine.trigger.sink.mqtt.MQTTHandler;
import
org.apache.iotdb.db.utils.windowing.configuration.SlidingSizeWindowConfiguration;
import
org.apache.iotdb.db.utils.windowing.handler.SlidingSizeWindowEvaluationHandler;
+import org.apache.iotdb.trigger.api.TriggerAttributes;
import org.apache.iotdb.tsfile.file.metadata.enums.TSDataType;
import org.fusesource.mqtt.client.QoS;
diff --git
a/integration/src/main/java/org/apache/iotdb/db/engine/trigger/example/Accumulator.java
b/integration/src/main/java/org/apache/iotdb/db/engine/trigger/example/Accumulator.java
index c2d662c463..d1243aa58a 100644
---
a/integration/src/main/java/org/apache/iotdb/db/engine/trigger/example/Accumulator.java
+++
b/integration/src/main/java/org/apache/iotdb/db/engine/trigger/example/Accumulator.java
@@ -21,7 +21,7 @@ package org.apache.iotdb.db.engine.trigger.example;
import org.apache.iotdb.commons.path.PartialPath;
import org.apache.iotdb.db.engine.trigger.api.Trigger;
-import org.apache.iotdb.db.engine.trigger.api.TriggerAttributes;
+import org.apache.iotdb.trigger.api.TriggerAttributes;
import org.apache.iotdb.tsfile.exception.NotImplementedException;
import org.apache.iotdb.tsfile.utils.Binary;
diff --git
a/integration/src/main/java/org/apache/iotdb/db/engine/trigger/example/Counter.java
b/integration/src/main/java/org/apache/iotdb/db/engine/trigger/example/Counter.java
index 7f52620c20..5d87e8c3f1 100644
---
a/integration/src/main/java/org/apache/iotdb/db/engine/trigger/example/Counter.java
+++
b/integration/src/main/java/org/apache/iotdb/db/engine/trigger/example/Counter.java
@@ -21,7 +21,7 @@ package org.apache.iotdb.db.engine.trigger.example;
import org.apache.iotdb.commons.path.PartialPath;
import org.apache.iotdb.db.engine.trigger.api.Trigger;
-import org.apache.iotdb.db.engine.trigger.api.TriggerAttributes;
+import org.apache.iotdb.trigger.api.TriggerAttributes;
import org.apache.iotdb.tsfile.utils.Binary;
public class Counter implements Trigger {
diff --git a/node-commons/pom.xml b/node-commons/pom.xml
index 2ce550dd25..3b2e80429f 100644
--- a/node-commons/pom.xml
+++ b/node-commons/pom.xml
@@ -56,6 +56,11 @@
<artifactId>udf-api</artifactId>
<version>${project.version}</version>
</dependency>
+ <dependency>
+ <groupId>org.apache.iotdb</groupId>
+ <artifactId>trigger-api</artifactId>
+ <version>${project.version}</version>
+ </dependency>
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
diff --git a/pom.xml b/pom.xml
index f43d7aa313..e89819afc4 100644
--- a/pom.xml
+++ b/pom.xml
@@ -118,6 +118,7 @@
<module>library-udf</module>
<module>schema-engine-rocksdb</module>
<module>udf-api</module>
+ <module>trigger-api</module>
<module>rewrite-tsfile-tool</module>
<module>external-api</module>
</modules>
diff --git
a/server/src/main/java/org/apache/iotdb/db/engine/trigger/api/Trigger.java
b/server/src/main/java/org/apache/iotdb/db/engine/trigger/api/Trigger.java
index 48f9c227f3..6e9b29f150 100644
--- a/server/src/main/java/org/apache/iotdb/db/engine/trigger/api/Trigger.java
+++ b/server/src/main/java/org/apache/iotdb/db/engine/trigger/api/Trigger.java
@@ -20,6 +20,7 @@
package org.apache.iotdb.db.engine.trigger.api;
import org.apache.iotdb.commons.path.PartialPath;
+import org.apache.iotdb.trigger.api.TriggerAttributes;
import org.apache.iotdb.tsfile.utils.Binary;
/** User Guide: docs/UserGuide/Operation Manual/Triggers.md */
diff --git
a/server/src/main/java/org/apache/iotdb/db/engine/trigger/builtin/ForwardTrigger.java
b/server/src/main/java/org/apache/iotdb/db/engine/trigger/builtin/ForwardTrigger.java
index 7aa7523e3e..a6df9132a2 100644
---
a/server/src/main/java/org/apache/iotdb/db/engine/trigger/builtin/ForwardTrigger.java
+++
b/server/src/main/java/org/apache/iotdb/db/engine/trigger/builtin/ForwardTrigger.java
@@ -21,7 +21,6 @@ package org.apache.iotdb.db.engine.trigger.builtin;
import org.apache.iotdb.commons.path.PartialPath;
import org.apache.iotdb.db.engine.trigger.api.Trigger;
-import org.apache.iotdb.db.engine.trigger.api.TriggerAttributes;
import org.apache.iotdb.db.engine.trigger.sink.api.Configuration;
import org.apache.iotdb.db.engine.trigger.sink.api.Event;
import org.apache.iotdb.db.engine.trigger.sink.api.Handler;
@@ -34,6 +33,7 @@ import
org.apache.iotdb.db.engine.trigger.sink.forward.mqtt.MQTTForwardEvent;
import org.apache.iotdb.db.engine.trigger.sink.forward.mqtt.MQTTForwardHandler;
import org.apache.iotdb.db.engine.trigger.utils.BatchHandlerQueue;
import org.apache.iotdb.db.exception.TriggerExecutionException;
+import org.apache.iotdb.trigger.api.TriggerAttributes;
import org.apache.iotdb.tsfile.utils.Binary;
import java.util.HashMap;
diff --git
a/server/src/main/java/org/apache/iotdb/db/engine/trigger/executor/TriggerExecutor.java
b/server/src/main/java/org/apache/iotdb/db/engine/trigger/executor/TriggerExecutor.java
index 732b4c0a62..e5a61d3167 100644
---
a/server/src/main/java/org/apache/iotdb/db/engine/trigger/executor/TriggerExecutor.java
+++
b/server/src/main/java/org/apache/iotdb/db/engine/trigger/executor/TriggerExecutor.java
@@ -22,12 +22,12 @@ package org.apache.iotdb.db.engine.trigger.executor;
import org.apache.iotdb.commons.path.PartialPath;
import org.apache.iotdb.commons.utils.TestOnly;
import org.apache.iotdb.db.engine.trigger.api.Trigger;
-import org.apache.iotdb.db.engine.trigger.api.TriggerAttributes;
import org.apache.iotdb.db.engine.trigger.service.TriggerClassLoader;
import
org.apache.iotdb.db.engine.trigger.service.TriggerRegistrationInformation;
import org.apache.iotdb.db.exception.TriggerExecutionException;
import org.apache.iotdb.db.exception.TriggerManagementException;
import org.apache.iotdb.db.metadata.mnode.IMNode;
+import org.apache.iotdb.trigger.api.TriggerAttributes;
import org.apache.iotdb.tsfile.file.metadata.enums.TSDataType;
import org.apache.iotdb.tsfile.utils.Binary;
diff --git
a/server/src/test/java/org/apache/iotdb/db/metadata/idtable/trigger_example/Counter.java
b/server/src/test/java/org/apache/iotdb/db/metadata/idtable/trigger_example/Counter.java
index 3c86592de5..77145e9077 100644
---
a/server/src/test/java/org/apache/iotdb/db/metadata/idtable/trigger_example/Counter.java
+++
b/server/src/test/java/org/apache/iotdb/db/metadata/idtable/trigger_example/Counter.java
@@ -21,7 +21,7 @@ package org.apache.iotdb.db.metadata.idtable.trigger_example;
import org.apache.iotdb.commons.path.PartialPath;
import org.apache.iotdb.db.engine.trigger.api.Trigger;
-import org.apache.iotdb.db.engine.trigger.api.TriggerAttributes;
+import org.apache.iotdb.trigger.api.TriggerAttributes;
import org.apache.iotdb.tsfile.utils.Binary;
public class Counter implements Trigger {
diff --git a/trigger-api/pom.xml b/trigger-api/pom.xml
new file mode 100644
index 0000000000..4d93a3df91
--- /dev/null
+++ b/trigger-api/pom.xml
@@ -0,0 +1,73 @@
+<?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";>
+ <parent>
+ <artifactId>iotdb-parent</artifactId>
+ <groupId>org.apache.iotdb</groupId>
+ <version>0.14.0-SNAPSHOT</version>
+ <relativePath>../pom.xml</relativePath>
+ </parent>
+ <modelVersion>4.0.0</modelVersion>
+ <artifactId>trigger-api</artifactId>
+ <profiles>
+ <profile>
+ <id>get-jar-with-dependencies</id>
+ <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>
+ <!-- this is used for inheritance merges -->
+ <phase>package</phase>
+ <!-- bind to the packaging phase -->
+ <goals>
+ <goal>single</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+ </profiles>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.iotdb</groupId>
+ <artifactId>tsfile</artifactId>
+ <version>${project.version}</version>
+ <exclusions>
+ <exclusion>
+ <groupId>javax.servlet</groupId>
+ <artifactId>servlet-api</artifactId>
+ </exclusion>
+ </exclusions>
+ </dependency>
+ </dependencies>
+</project>
diff --git
a/trigger-api/src/main/java/org/apache/iotdb/trigger/api/Trigger.java
b/trigger-api/src/main/java/org/apache/iotdb/trigger/api/Trigger.java
new file mode 100644
index 0000000000..7ed99bc6f5
--- /dev/null
+++ b/trigger-api/src/main/java/org/apache/iotdb/trigger/api/Trigger.java
@@ -0,0 +1,68 @@
+/*
+ * 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.
+ */
+
+package org.apache.iotdb.trigger.api;
+
+import org.apache.iotdb.tsfile.write.record.Tablet;
+
+public interface Trigger {
+
+ /**
+ * This method is mainly used to validate {@link TriggerAttributes} before
calling {@link
+ * Trigger#onCreate(TriggerAttributes)}.
+ *
+ * @param attributes TriggerAttributes
+ * @throws Exception e
+ */
+ default void validate(TriggerAttributes attributes) throws Exception {}
+
+ /**
+ * This method will be called when creating a trigger after validation.
+ *
+ * @param attributes TriggerAttributes
+ * @throws Exception e
+ */
+ default void onCreate(TriggerAttributes attributes) throws Exception {}
+
+ /**
+ * This method will be called when dropping a trigger.
+ *
+ * @throws Exception e
+ */
+ default void onDrop() throws Exception {}
+
+ /**
+ * When restarting a DataNode, Triggers that have been registered will be
restored and this method
+ * will be called during the process of restoring.
+ *
+ * @throws Exception e
+ */
+ default void restore() throws Exception {}
+
+ /**
+ * @param tablet see {@link Tablet} for detailed information of data
structure. Data that is
+ * inserted will be constructed as a Tablet and you can define process
logic with {@link
+ * Tablet}.
+ * @return true if successfully fired
+ * @throws Exception e
+ */
+ default boolean fire(Tablet tablet) throws Exception {
+ return true;
+ }
+}
diff --git
a/server/src/main/java/org/apache/iotdb/db/engine/trigger/api/TriggerAttributes.java
b/trigger-api/src/main/java/org/apache/iotdb/trigger/api/TriggerAttributes.java
similarity index 98%
rename from
server/src/main/java/org/apache/iotdb/db/engine/trigger/api/TriggerAttributes.java
rename to
trigger-api/src/main/java/org/apache/iotdb/trigger/api/TriggerAttributes.java
index 2fd69d856f..64da3a97be 100644
---
a/server/src/main/java/org/apache/iotdb/db/engine/trigger/api/TriggerAttributes.java
+++
b/trigger-api/src/main/java/org/apache/iotdb/trigger/api/TriggerAttributes.java
@@ -17,7 +17,7 @@
* under the License.
*/
-package org.apache.iotdb.db.engine.trigger.api;
+package org.apache.iotdb.trigger.api;
import java.util.Map;
