updated API description

This commit is contained in:
2019-09-14 17:54:26 +02:00
parent 13d16a1309
commit 6348f81bed
53 changed files with 487 additions and 670 deletions

193
pom.xml
View File

@ -22,6 +22,7 @@ limitations under the License.
<version>1.2-SNAPSHOT</version>
<packaging>pom</packaging>
<name>shared</name>
<modules>
<module>configuration</module>
<module>network</module>
@ -34,10 +35,43 @@ limitations under the License.
</modules>
<scm>
<connection>scm:git:https://jomu.timelord.de/git/jomu/shared/</connection>
<developerConnection>scm:git:https://jomu.timelord.de/git/jomu/shared/</developerConnection>
<url>https://jomu.timelord.de/git/jomu/shared/</url>
<tag>HEAD</tag>
</scm>
<issueManagement>
<system>Gitea</system>
<url>https://jomu.timelord.de/git/jomu/shared/issues</url>
</issueManagement>
<licenses>
<license>
<name>Apache License, Version 2.0</name>
<url>http://www.apache.org/licenses/LICENSE-2.0</url>
<distribution>repo</distribution>
</license>
</licenses>
<developers>
<developer>
<name>Joern Muehlencord</name>
<email>joern@muehlencord.de</email>
</developer>
</developers>
<distributionManagement>
<snapshotRepository>
<id>ossrh</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
</snapshotRepository>
<repository>
<id>ossrh</id>
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
</repository>
</distributionManagement>
<properties>
<!-- project setup -->
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@ -67,12 +101,7 @@ limitations under the License.
<groupId>de.muehlencord.shared</groupId>
<artifactId>shared-jeeutil</artifactId>
<version>1.2-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>de.muehlencord.sf</groupId>
<artifactId>filter</artifactId>
<version>1.1-SNAPSHOT</version>
</dependency>
</dependency>
<dependency>
<groupId>commons-codec</groupId>
<artifactId>commons-codec</artifactId>
@ -157,13 +186,6 @@ limitations under the License.
<version>7.0</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.enterprisedt</groupId>
<artifactId>edtFTPj</artifactId>
<version>1.5.3</version> <!--FIXME - requires update -->
</dependency>
<dependency>
<groupId>com.lambdaworks</groupId>
<artifactId>scrypt</artifactId>
@ -207,18 +229,6 @@ limitations under the License.
<artifactId>omnifaces</artifactId>
<version>3.3</version>
</dependency>
<dependency>
<groupId>com.sun.faces</groupId>
<artifactId>jsf-api</artifactId>
<version>2.2.20</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>javax.el</groupId>
<artifactId>javax.el-api</artifactId>
<version>3.0.0</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml</artifactId>
@ -228,7 +238,7 @@ limitations under the License.
<groupId>com.inversoft</groupId>
<artifactId>prime-jwt</artifactId>
<version>2.0.0</version>
</dependency>
</dependency>
<!-- Testing -->
<dependency>
@ -237,25 +247,106 @@ limitations under the License.
<version>5.5.1</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
<version>2.28.2</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-junit-jupiter</artifactId>
<version>2.28.2</version>
<scope>test</scope>
</dependency>
</dependencies>
</dependencies>
</dependencyManagement>
<profiles>
<profile>
<id>release</id>
<build>
<plugins>
<!-- deploy artifacts to maven repository -->
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<version>1.6.8</version>
<extensions>true</extensions>
<configuration>
<serverId>ossrh</serverId>
<nexusUrl>https://oss.sonatype.org/</nexusUrl>
<autoReleaseAfterClose>true</autoReleaseAfterClose>
</configuration>
</plugin>
<!-- ensure sources are build so they are also uploaded -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>3.1.0</version>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar-no-fork</goal>
</goals>
</execution>
</executions>
</plugin>
<!-- ensure java doc is built -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.1.1</version>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<!-- create license file -->
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>license-maven-plugin</artifactId>
<version>1.14</version>
<executions>
<execution>
<id>download-licenses</id>
<phase>generate-resources</phase>
<goals>
<goal>download-licenses</goal>
<goal>add-third-party</goal>
</goals>
<configuration>
<licensesOutputDirectory>${licenses.dir}</licensesOutputDirectory>
<outputDirectory>${licenses.dir}</outputDirectory>
<licenseMerges>
<licenseMerge>The Apache Software License, Version 2.0|Apache 2|Apache License, Version 2.0|Apache Public License 2.0</licenseMerge>
</licenseMerges>
</configuration>
</execution>
</executions>
</plugin>
<!-- sign jar archives -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>1.6</version>
<executions>
<execution>
<id>sign-artifacts</id>
<phase>verify</phase>
<goals>
<goal>sign</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
</profiles>
<build>
<pluginManagement>
<plugins>
<plugins>
<!-- build archive -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
@ -266,27 +357,21 @@ limitations under the License.
<showDeprecation>true</showDeprecation>
</configuration>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>jaxb2-maven-plugin</artifactId>
<version>2.5.0</version>
</plugin>
<!-- build maven ejb artifacts -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-ejb-plugin</artifactId>
<version>3.0.1</version>
</plugin>
<plugin>
<!-- switched to com.helger.maven - need to revert back to org.codehaus.mojo when jaxws-maven-plugin with JDK11 support has been released -->
<groupId>com.helger.maven</groupId>
<artifactId>jaxws-maven-plugin</artifactId>
<version>2.6.2</version>
</plugin>
</plugin>
<!-- create new releases -->
<plugin>
<artifactId>maven-release-plugin</artifactId>
<version>2.5.3</version>
</plugin>
<!-- control junit tests from maven build -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
@ -294,6 +379,8 @@ limitations under the License.
</plugin>
</plugins>
</pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>