chore: new pom & README for module
diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
index 5829cb6..93e1bd1 100644
--- a/.github/workflows/stale.yml
+++ b/.github/workflows/stale.yml
@@ -35,4 +35,4 @@
remove-stale-when-updated: true
exempt-all-pr-milestones: true
delete-branch: false
- enable-statistics: true
\ No newline at end of file
+ enable-statistics: true
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3d669eb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# hugegraph-commons
+
+[](https://www.apache.org/licenses/LICENSE-2.0.html)
+[](https://codecov.io/gh/hugegraph/hugegraph-common)
+[](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-common)
+
+hugegraph-commons is a common module for [HugeGraph](https://github.com/hugegraph/hugegraph) and its peripheral components.
+hugegraph-commons encapsulates locks, configurations, events, iterators, rest and some
+numeric or collection util classes to simplify the development of HugeGraph and
+its components.
+
+## Components
+
+- Lock: atomic lock, key lock, lock group and lock manger
+- Config: register and load config option with security check
+- Event: listening and notification, do something asynchronously
+- Iterator: some iterators with extra functions, map, filter, extend etc.
+- Rest: RESTful client implemented on Jersey, POST, PUT, GET and DELETE
+- Util: performance analyzer, version checker, numeric and Collection utils, log and exception utils etc.
+- Rpc: rpc component for inner module communication, currently it's based on [Sofa-RPC](https://github.com/sofastack/sofa-rpc)
+
+## Licence
+The same as HugeGraph, hugegraph-commons is also licensed under Apache 2.0 License.
diff --git a/hugegraph-common/pom.xml b/hugegraph-common/pom.xml
index 7b9e61c..4b35592 100644
--- a/hugegraph-common/pom.xml
+++ b/hugegraph-common/pom.xml
@@ -3,11 +3,14 @@
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>com.baidu.hugegraph</groupId>
+ <artifactId>hugegraph-commons</artifactId>
+ <version>1.8.10</version>
+ <relativePath>../pom.xml</relativePath>
+ </parent>
- <groupId>com.baidu.hugegraph</groupId>
<artifactId>hugegraph-common</artifactId>
- <version>1.8.10</version>
-
<name>hugegraph-common</name>
<url>https://github.com/hugegraph/hugegraph-common</url>
<description>
@@ -16,61 +19,8 @@
numeric or collection util classes to simplify the development of HugeGraph and its components.
</description>
- <parent>
- <groupId>org.sonatype.oss</groupId>
- <artifactId>oss-parent</artifactId>
- <version>7</version>
- </parent>
-
- <licenses>
- <license>
- <name>The Apache Software License, Version 2.0</name>
- <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
- <distribution>repo</distribution>
- </license>
- </licenses>
-
- <scm>
- <url>https://github.com/hugegraph/hugegraph-common</url>
- <connection>https://github.com/hugegraph/hugegraph-common</connection>
- <developerConnection>https://github.com/hugegraph/hugegraph-common</developerConnection>
- </scm>
-
- <developers>
- <developer>
- <name>lizhangmei</name>
- <email>javaloveme@gmail.com</email>
- </developer>
- <developer>
- <name>zhoney</name>
- <email>zhangyi89817@126.com</email>
- </developer>
- <developer>
- <name>liningrui</name>
- <email>liningrui@vip.qq.com</email>
- </developer>
- </developers>
-
<properties>
- <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
- <top.level.dir>${project.basedir}/..</top.level.dir>
- <compiler.source>1.8</compiler.source>
- <compiler.target>1.8</compiler.target>
- <log4j2.version>2.13.3</log4j2.version>
- <commons.configuration.version>1.10</commons.configuration.version>
- <commons.configuration2.version>2.1.1</commons.configuration2.version>
- <commons.collections.version>3.2.2</commons.collections.version>
- <commons.io.version>2.7</commons.io.version>
- <commons.codec.version>1.11</commons.codec.version>
- <guava.version>25.1-jre</guava.version>
- <javax.json.version>1.0</javax.json.version>
- <jsr305.version>3.0.1</jsr305.version>
- <javassist.version>3.21.0-GA</javassist.version>
- <jersey.version>2.22</jersey.version>
- <jersey.hk2.version>2.27</jersey.hk2.version>
- <jackson.version>2.12.1</jackson.version>
- <junit.version>4.12</junit.version>
- <mockito.version>2.25.1</mockito.version>
+ <!-- Use parent params -->
</properties>
<dependencies>
@@ -311,7 +261,7 @@
<goal>report</goal>
</goals>
<configuration>
- <outputDirectory>${project.build.directory}</outputDirectory>
+ <outputDirectory>${project.parent.build.directory}</outputDirectory>
</configuration>
</execution>
</executions>
diff --git a/hugegraph-rpc/pom.xml b/hugegraph-rpc/pom.xml
index f650d64..b06fc89 100644
--- a/hugegraph-rpc/pom.xml
+++ b/hugegraph-rpc/pom.xml
@@ -3,42 +3,21 @@
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>com.baidu.hugegraph</groupId>
+ <artifactId>hugegraph-commons</artifactId>
+ <version>1.8.10</version>
+ <relativePath>../pom.xml</relativePath>
+ </parent>
- <groupId>com.baidu.hugegraph</groupId>
<artifactId>hugegraph-rpc</artifactId>
<version>1.0.1</version>
<name>hugegraph-rpc</name>
- <url>https://github.com/hugegraph/hugegraph-rpc</url>
- <description>
- HugeGraph Database RPC component
- </description>
-
- <parent>
- <groupId>org.sonatype.oss</groupId>
- <artifactId>oss-parent</artifactId>
- <version>7</version>
- </parent>
-
- <licenses>
- <license>
- <name>The Apache Software License, Version 2.0</name>
- <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
- <distribution>repo</distribution>
- </license>
- </licenses>
-
- <scm>
- <url>https://github.com/hugegraph/hugegraph-rpc</url>
- <connection>https://github.com/hugegraph/hugegraph-rpc</connection>
- <developerConnection>https://github.com/hugegraph/hugegraph-rpc</developerConnection>
- </scm>
+ <description>HugeGraph Database RPC component</description>
<properties>
- <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
- <top.level.dir>${project.basedir}/..</top.level.dir>
- <compiler.source>1.8</compiler.source>
- <compiler.target>1.8</compiler.target>
+ <!-- Use parent params -->
</properties>
<dependencies>
@@ -46,6 +25,7 @@
<dependency>
<groupId>com.baidu.hugegraph</groupId>
<artifactId>hugegraph-common</artifactId>
+ <!-- TODO: use commons latest version ${project.version}?-->
<version>1.8.5</version>
</dependency>
@@ -189,7 +169,7 @@
<goal>report</goal>
</goals>
<configuration>
- <outputDirectory>${project.build.directory}</outputDirectory>
+ <outputDirectory>${project.parent.build.directory}</outputDirectory>
</configuration>
</execution>
</executions>
diff --git a/pom.xml b/pom.xml
new file mode 100644
index 0000000..771e807
--- /dev/null
+++ b/pom.xml
@@ -0,0 +1,219 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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>
+
+ <groupId>com.baidu.hugegraph</groupId>
+ <artifactId>hugegraph-commons</artifactId>
+ <version>1.8.10</version>
+ <packaging>pom</packaging>
+
+ <name>hugegraph-commons</name>
+ <url>https://github.com/hugegraph/hugegraph-commons</url>
+ <description>
+ hugegraph-commons is a common module for HugeGraph-Common and HugeGraph-Rpc with their peripheral components.
+ It includes rpc frame, locks, configurations, events, iterators, rest and some
+ numeric or collection util classes to simplify the development of HugeGraph and its components.
+ </description>
+
+ <parent>
+ <groupId>org.sonatype.oss</groupId>
+ <artifactId>oss-parent</artifactId>
+ <version>7</version>
+ </parent>
+
+ <licenses>
+ <license>
+ <name>The Apache Software License, Version 2.0</name>
+ <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
+ <distribution>repo</distribution>
+ </license>
+ </licenses>
+
+ <scm>
+ <url>https://github.com/hugegraph/hugegraph-commons</url>
+ <connection>https://github.com/hugegraph/hugegraph-commons</connection>
+ <developerConnection>https://github.com/hugegraph/hugegraph-commons</developerConnection>
+ </scm>
+
+ <developers>
+ <developer>
+ <name>lizhangmei</name>
+ <email>javaloveme@gmail.com</email>
+ </developer>
+ <developer>
+ <name>zhoney</name>
+ <email>zhangyi89817@126.com</email>
+ </developer>
+ <developer>
+ <name>liningrui</name>
+ <email>liningrui@vip.qq.com</email>
+ </developer>
+ </developers>
+
+ <properties>
+ <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+ <top.level.dir>${project.basedir}/..</top.level.dir>
+ <compiler.source>1.8</compiler.source>
+ <compiler.target>1.8</compiler.target>
+ <log4j2.version>2.13.3</log4j2.version>
+ <commons.configuration.version>1.10</commons.configuration.version>
+ <commons.configuration2.version>2.1.1</commons.configuration2.version>
+ <commons.collections.version>3.2.2</commons.collections.version>
+ <commons.io.version>2.7</commons.io.version>
+ <commons.codec.version>1.11</commons.codec.version>
+ <guava.version>25.1-jre</guava.version>
+ <javax.json.version>1.0</javax.json.version>
+ <jsr305.version>3.0.1</jsr305.version>
+ <javassist.version>3.21.0-GA</javassist.version>
+ <jersey.version>2.22</jersey.version>
+ <jersey.hk2.version>2.27</jersey.hk2.version>
+ <jackson.version>2.12.1</jackson.version>
+ <junit.version>4.12</junit.version>
+ <mockito.version>2.25.1</mockito.version>
+ </properties>
+
+ <modules>
+ <module>hugegraph-common</module>
+ <module>hugegraph-rpc</module>
+ </modules>
+
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-compiler-plugin</artifactId>
+ <version>3.1</version>
+ <configuration>
+ <source>${compiler.source}</source>
+ <target>${compiler.target}</target>
+ <compilerArguments>
+ <Xmaxerrs>500</Xmaxerrs>
+ </compilerArguments>
+ <compilerArgs>
+ <arg>-Xlint:unchecked</arg>
+ </compilerArgs>
+ </configuration>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <version>3.1.0</version>
+ <configuration>
+ <configLocation>checkstyle.xml</configLocation>
+ <encoding>UTF-8</encoding>
+ <consoleOutput>true</consoleOutput>
+ <failsOnError>true</failsOnError>
+ <linkXRef>false</linkXRef>
+ <includeTestSourceDirectory>false</includeTestSourceDirectory>
+ </configuration>
+ <executions>
+ <execution>
+ <id>validate</id>
+ <phase>validate</phase>
+ <goals>
+ <goal>check</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jar-plugin</artifactId>
+ <version>2.6</version>
+ <configuration>
+ <archive>
+ <index>true</index>
+ <manifest>
+ <addDefaultImplementationEntries>
+ false
+ </addDefaultImplementationEntries>
+ <addDefaultSpecificationEntries>
+ true
+ </addDefaultSpecificationEntries>
+ </manifest>
+ <manifestEntries>
+ <!-- Must be on one line, otherwise the automatic
+ upgrade script cannot replace the version number -->
+ <Implementation-Version>1.8.9.0</Implementation-Version>
+ </manifestEntries>
+ </archive>
+ </configuration>
+ </plugin>
+
+ <plugin>
+ <groupId>org.jacoco</groupId>
+ <artifactId>jacoco-maven-plugin</artifactId>
+ <version>0.8.2</version>
+ <executions>
+ <execution>
+ <id>pre-unit-test</id>
+ <goals>
+ <goal>prepare-agent</goal>
+ </goals>
+ </execution>
+ <execution>
+ <id>post-unit-test</id>
+ <phase>test</phase>
+ <goals>
+ <goal>report</goal>
+ </goals>
+ <configuration>
+ <outputDirectory>${project.build.directory}</outputDirectory>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+
+ <profiles>
+ <profile>
+ <id>release</id>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-source-plugin</artifactId>
+ <version>2.2.1</version>
+ <executions>
+ <execution>
+ <id>attach-sources</id>
+ <goals>
+ <goal>jar-no-fork</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.9.1</version>
+ <executions>
+ <execution>
+ <id>attach-javadocs</id>
+ <goals>
+ <goal>jar</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-gpg-plugin</artifactId>
+ <version>1.5</version>
+ <executions>
+ <execution>
+ <id>sign-artifacts</id>
+ <phase>verify</phase>
+ <goals>
+ <goal>sign</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+ </profiles>
+</project>
