Repaired man broken links. Renamed the coordinates to create a more s…

…ensible hierarchy.
david-waltermire · Aug 2, 2024 · 9e61345 · 9e61345
1 parent 8d0a64e
commit 9e61345
Show file tree

Hide file tree

Showing 17 changed files with 101 additions and 32 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -37,7 +37,7 @@ jobs:
     permissions:
       actions: read
       contents: read
-#      security-events: write
+      security-events: write
 
     steps:
     - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633
@@ -117,7 +117,7 @@ jobs:
       name: Link Checker
       uses: lycheeverse/lychee-action@2b973e86fc7b1f6b36a93795fe2c9c6ae1118621
       with:
-        args: --verbose --no-progress --accept 200,206,429 './target/staging/**/*.html'  --remap "https://github.com/metaschema-framework/oss-maven/tree/main/ file://${GITHUB_WORKSPACE}/" --remap "https://oss-maven.metaschema.dev/ file://${GITHUB_WORKSPACE}/target/staging/" --exclude-mail
+        args: --verbose --no-progress --accept 200,206,429 './target/staging/**/*.html'  --remap "https://github.com/metaschema-framework/metaschema-java/tree/main/ file://${GITHUB_WORKSPACE}/" --remap "https://metaschema-java.metaschema.dev/ file://${GITHUB_WORKSPACE}/target/staging/" --exclude-mail
         format: markdown
         output: html-link-report.md
         debug: true

diff --git a/.lycheeignore b/.lycheeignore
@@ -0,0 +1,33 @@
+# broken plugin and dependency references
+https://bytebuddy.net/byte-buddy
+https://chronicle.software/java-parent-pom/compiler
+https://code.revelc.net/revelc/formatter-maven-plugin
+https://codehaus-plexus.github.io/plexus-cipher/
+https://codehaus-plexus.github.io/plexus-pom/plexus-build-api/
+https://codehaus-plexus.github.io/plexus-pom/plexus-utils/
+https://codehaus-plexus.github.io/plexus-sec-dispatcher/
+https://errorprone.info/error_prone_annotations
+http://forge.sonatype.com/spice-parent/plexus-build-api/
+https://github.com/google/guava/.*
+https://github.com/google/guice/guice
+https://github.com/hamcrest/JavaHamcrest/hamcrest-core
+https://github.com/javaparser/.*
+https://github.com/vsch/flexmark-java/.*
+https://hc.apache.org/httpcomponents-client-5.0.x/5.1.3/httpclient5/
+https://logging.apache.org/log4j/2.x/log4j/.*
+https://pmd.github.io/latest/pmd_userdocs_cpd.html
+https://www.antlr.org/antlr4-maven-plugin/
+https://www.antlr.org/antlr4-runtime/
+http://www.eclipse.org/eclipselink/moxy/org.eclipse.persistence.moxy
+http://www.eclipse.org/sisu/org.eclipse.sisu.plexus/
+http://www.eclipse.org/sisu/org.eclipse.sisu.inject/
+http://www.mojohaus.org/appassembler-maven-plugin/appassembler/appassembler-maven-plugin
+http://www.thymeleaf.org/thymeleaf-lib/thymeleaf
+# broken license references
+https://opensource.org/licenses/Apache-2.0,https://opensource.org/licenses/EPL-2.0
+# prone to long timeouts
+http://nexus.sonatype.org/oss-repository-hosting.html/jmock-parent/.*
+https://glassfish.dev.java.net/.*
+# fix later
+https://github.com/metaschema-framework/liboscal-java/
+
diff --git a/cli-processor/pom.xml b/cli-processor/pom.xml
@@ -1,7 +1,7 @@
 <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>dev.metaschema</groupId>
+		<groupId>dev.metaschema.java</groupId>
 		<artifactId>metaschema-framework</artifactId>
 		<version>1.0.0-M2-SNAPSHOT</version>
 	</parent>
@@ -25,7 +25,7 @@
 
 	<dependencies>
 		<dependency>
-			<groupId>dev.metaschema</groupId>
+			<groupId>${project.groupId}</groupId>
 			<artifactId>metaschema-core</artifactId>
 		</dependency>
 		<dependency>

diff --git a/core/pom.xml b/core/pom.xml
@@ -4,7 +4,7 @@
     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>dev.metaschema</groupId>
+		<groupId>dev.metaschema.java</groupId>
         <artifactId>metaschema-framework</artifactId>
         <version>1.0.0-M2-SNAPSHOT</version>
     </parent>

diff --git a/databind-metaschema/pom.xml b/databind-metaschema/pom.xml
@@ -2,7 +2,7 @@
 <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>dev.metaschema</groupId>
+		<groupId>dev.metaschema.java</groupId>
 		<artifactId>metaschema-framework</artifactId>
 		<version>1.0.0-M2-SNAPSHOT</version>
 	</parent>
@@ -86,7 +86,7 @@
 		</pluginManagement>
 		<plugins>
 			<plugin>
-				<groupId>dev.metaschema</groupId>
+				<groupId>${project.groupId}</groupId>
 				<artifactId>metaschema-maven-plugin</artifactId>
 				<version>${project.version}</version>
 				<executions>

diff --git a/databind/pom.xml b/databind/pom.xml
@@ -2,7 +2,7 @@
 <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>dev.metaschema</groupId>
+		<groupId>dev.metaschema.java</groupId>
 		<artifactId>metaschema-framework</artifactId>
 		<version>1.0.0-M2-SNAPSHOT</version>
 	</parent>
@@ -24,7 +24,7 @@
 
 	<dependencies>
 		<dependency>
-			<groupId>${project.parent.groupId}</groupId>
+			<groupId>${project.groupId}</groupId>
 			<artifactId>metaschema-core</artifactId>
 		</dependency>
 

diff --git a/databind/src/site/markdown/index.md.vm b/databind/src/site/markdown/index.md.vm
@@ -1,8 +1,8 @@
 # ${project.name}
 
 This module provides:
-- A Java parser library, that can read and write XML, JSON, and YAML content that is valid to the associated Metaschema model from and to bound Java objects. This library is a dependency for Java code generated from a Metaschema using the Metaschema Java [code generator plugin](../metaschema-maven-plugin) or this library.
-- A Java code generator [Java API](apidocs/index.html) that generates Java classes for a Metaschema definition. These generated classes can be used to read and write XML, JSON, and YAML content that is valid to the associated Metaschema model using the parser in this library.
+- A Java parser library, that can read and write XML, JSON, and YAML content from and to bound Java objectst hat is valid to a model described by a Metaschema module. This library is a dependency for Java code generated from a Metaschema using the Metaschema Java [code generator plugin](../metaschema-maven-plugin) or this library.
+- A Java code generator [Java API](apidocs/index.html) that generates Java classes for a Metaschema module. These generated classes can be used to read and write XML, JSON, and YAML content that is valid to the associated Metaschema model using the parser in this library.
 
 This parser uses a set of annotations, that allow Metaschema constructs to be annotated on a Java class, to drive parsing behavior. These annotations provide the information needed by (META-B) to read and write XML, JSON, and YAML content that is valid to the associated Metaschema model.
 

diff --git a/metaschema-cli/pom.xml b/metaschema-cli/pom.xml
@@ -2,7 +2,7 @@
 <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>dev.metaschema</groupId>
+		<groupId>dev.metaschema.java</groupId>
 		<artifactId>metaschema-framework</artifactId>
 		<version>1.0.0-M2-SNAPSHOT</version>
 	</parent>
@@ -39,16 +39,25 @@
 			<groupId>${project.groupId}</groupId>
 			<artifactId>metaschema-databind-modules</artifactId>
 		</dependency>
-
+<!--
 		<dependency>
 			<groupId>com.google.auto.service</groupId>
 			<artifactId>auto-service-annotations</artifactId>
 		</dependency>
-
+-->
 		<dependency>
 			<groupId>com.github.spotbugs</groupId>
 			<artifactId>spotbugs-annotations</artifactId>
 		</dependency>
+
+		<dependency>
+			<groupId>org.apache.logging.log4j</groupId>
+			<artifactId>log4j-core</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.apache.logging.log4j</groupId>
+			<artifactId>log4j-api</artifactId>
+		</dependency>
 	</dependencies>
 
 	<build>

diff --git a/metaschema-documentation-generator/pom.xml b/metaschema-documentation-generator/pom.xml
@@ -1,7 +1,7 @@
 <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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 	<parent>
-		<groupId>dev.metaschema</groupId>
+		<groupId>dev.metaschema.java</groupId>
 		<artifactId>metaschema-framework</artifactId>
 		<version>1.0.0-M2-SNAPSHOT</version>
 	</parent>

diff --git a/metaschema-freemarker-support/pom.xml b/metaschema-freemarker-support/pom.xml
@@ -2,7 +2,7 @@
 <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>dev.metaschema</groupId>
+		<groupId>dev.metaschema.java</groupId>
 		<artifactId>metaschema-framework</artifactId>
 		<version>1.0.0-M2-SNAPSHOT</version>
 	</parent>

diff --git a/metaschema-maven-plugin/pom.xml b/metaschema-maven-plugin/pom.xml
@@ -4,7 +4,7 @@
     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>dev.metaschema</groupId>
+		<groupId>dev.metaschema.java</groupId>
         <artifactId>metaschema-framework</artifactId>
         <version>1.0.0-M2-SNAPSHOT</version>
     </parent>
@@ -28,15 +28,15 @@
     </prerequisites>
     <dependencies>
         <dependency>
-            <groupId>${project.parent.groupId}</groupId>
+			<groupId>${project.groupId}</groupId>
             <artifactId>metaschema-core</artifactId>
         </dependency>
         <dependency>
-            <groupId>${project.parent.groupId}</groupId>
+			<groupId>${project.groupId}</groupId>
             <artifactId>metaschema-databind</artifactId>
         </dependency>
         <dependency>
-            <groupId>${project.parent.groupId}</groupId>
+			<groupId>${project.groupId}</groupId>
             <artifactId>metaschema-schema-generator</artifactId>
         </dependency>
         <dependency>

diff --git a/metaschema-maven-plugin/src/it/generate-sources/pom.xml b/metaschema-maven-plugin/src/it/generate-sources/pom.xml
@@ -4,7 +4,7 @@
     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>dev.metaschema.it</groupId>
+    <groupId>dev.metaschema.java.it</groupId>
     <artifactId>generate-sources-test</artifactId>
     <version>@project.version@</version>
 

diff --git a/metaschema-testing/pom.xml b/metaschema-testing/pom.xml
@@ -1,7 +1,7 @@
 <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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 	<parent>
-		<groupId>dev.metaschema</groupId>
+		<groupId>dev.metaschema.java</groupId>
 		<artifactId>metaschema-framework</artifactId>
 		<version>1.0.0-M2-SNAPSHOT</version>
 	</parent>

diff --git a/pom.xml b/pom.xml
@@ -8,9 +8,11 @@
 		<artifactId>oss-parent</artifactId>
 		<version>2</version>
 	</parent>
-	<groupId>dev.metaschema</groupId>
+
+	<groupId>dev.metaschema.java</groupId>
 	<artifactId>metaschema-framework</artifactId>
 	<version>1.0.0-M2-SNAPSHOT</version>
+
 	<packaging>pom</packaging>
 	<name>Metaschema Framework Parent</name>
 	<description>A common build root for all Java projects related to the
@@ -581,6 +583,16 @@
 						<topSiteURL>${site.url}</topSiteURL>
 					</configuration>
 				</plugin>
+				<plugin>
+					<groupId>org.apache.maven.plugins</groupId>
+					<artifactId>maven-jxr-plugin</artifactId>
+					<version>3.4.0</version>
+					<configuration>
+						<excludes>
+							<exclude>**/module-info.java</exclude>
+						</excludes>
+					</configuration>
+				</plugin>
 				<plugin>
 					<groupId>org.apache.maven.plugins</groupId>
 					<artifactId>maven-javadoc-plugin</artifactId>
@@ -741,6 +753,22 @@
 			</plugin>
 		</plugins>
 	</build>
+	<reporting>
+		<plugins>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-jxr-plugin</artifactId>
+				<reportSets>
+					<reportSet>
+                      	<id>default</id>
+						<configuration>
+							<linkJavadoc>false</linkJavadoc>
+						</configuration>
+					</reportSet>
+				</reportSets>
+			</plugin>
+		</plugins>
+	</reporting>
 	<modules>
 		<module>core</module>
 		<module>databind</module>

diff --git a/schemagen/pom.xml b/schemagen/pom.xml
@@ -2,7 +2,7 @@
 <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>dev.metaschema</groupId>
+		<groupId>dev.metaschema.java</groupId>
 		<artifactId>metaschema-framework</artifactId>
 		<version>1.0.0-M2-SNAPSHOT</version>
 	</parent>

diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
@@ -4,18 +4,17 @@ This project provides a Java implementation of the [Metaschema](https://metasche
 
 This project supports the following features:
 
-- **Allows developers to generate Java classes from Metaschema definitions.** Using a given Metaschema definition, a developer can quickly [generate Java classes](metaschema-java-binding/) for a Metaschema-based model, which can be used to create, parse, modify, and write XML, JSON, and YAML representations of that model using bound Java objects. This allows a developer to quickly start programming business logic instead of spending hours writing parsing code. This approach is similar to the binding frameworks provided by [Jakarta XML Binding (JAXB)](https://eclipse-ee4j.github.io/jaxb-ri/), [XMLBeans](https://xmlbeans.apache.org/), [Java API for JSON Binding (JSON-B)](https://javaee.github.io/jsonb-spec/), and other class-to-object binding approaches. The [OSCAL Java Library](https://github.com/metaschema-framework/liboscal-java/) is an example of applying this approach to generate Java programming APIs for a set of Metaschema-defined models.
+- **Allows developers to generate Java classes from Metaschema definitions.** Using a given Metaschema module, a developer can quickly [generate Java classes](metaschema-databind/) for a Metaschema-based model, which can be used to create, parse, modify, and write XML, JSON, and YAML representations of that model using the generated bound Java objects. This allows a developer to quickly start programming business logic instead of spending hours writing parsing code. This approach is similar to the binding frameworks provided by [Jakarta XML Binding (JAXB)](https://eclipse-ee4j.github.io/jaxb-ri/), [XMLBeans](https://xmlbeans.apache.org/), [Java API for JSON Binding (JSON-B)](https://javaee.github.io/jsonb-spec/), and other class-to-object binding approaches. The [OSCAL Java Library](https://github.com/metaschema-framework/liboscal-java/) is an example of applying this approach to generate Java programming APIs for a set of Metaschema-defined models.
 - **Supports generating Metaschema-based Java code during Maven builds.** An [Apache Maven](https://maven.apache.org/) [Metaschema code generation plugin](metaschema-maven-plugin/) is provided that supports Java class generation for a Metaschema definition during Maven builds.
 - **Enables validation of data aligned with a set of Metaschema definitions using constraints defined within the Metaschema definitions.** Using this framework, format-agnostic validation rules, defined in a Metaschema, can be enforced over data loaded into bound objects.
 - **Allows execution of Metapath queries against data aligned with a Metaschema-based model.** Metapath is an XPath-like expression language that can be used to query XML, JSON, or YAML data aligned with a Metaschema definition. This allows data to be queried irrespective of the format it is stored in.
 
 This project contains the following sub-modules:
 
-- [Metaschema Java Code Generator](metaschema-java-codegen/): A Java code generator [Java API](metaschema-java-codege/apidocs/) that generates Java classes for a Metaschema definition. These generated classes can be used to read and write XML, JSON, and YAML content that is valid to the associated Metaschema model. 
-- [Metaschema Java API](metaschema-common-model/): Provides a [Java API](metaschema-common-model/apidocs/index.html) for interacting with Metaschema definitions and executing Metapath expressions in Java programs.
-- [Metaschema Java Binding (META-B)](metaschema-java-binding/): A [Java API](metaschema-java-binding/apidocs/) that uses Java code generated by the [Metaschema Java Code Generator](metaschema-java-codegen/) to read and write XML, JSON, and YAML content that is valid to the associated Metaschema model. This library is a dependency for all generated Java code.
-- [Metaschema Maven Plugin](metaschema-maven-plugin/): A Maven build plugin that automates generation on Java classes for a set of Metaschema definitions as part of a Maven build.
-- [Metaschema Java Binding Annotations](metaschema-java-binding-annotations/): 
-- [Metaschema XML Model](metaschema-model/): Supports loading Metaschema definitions expressed in XML files.
+- [Metaschema Java API](metaschema-core/): Provides a [Java API](metaschema-core/apidocs/index.html) for interacting with Metaschema modules and executing Metapath expressions in Java programs. Supports loading XML-based Metaschema modules.
+- [Metaschema Java Binding](metaschema-databind/): Supports the generation and use of annotated plain old Java objects (POJOs) to create and store Metaschema module-based data. Supports code generation of POJO classes based on a Metaschema module and reading and writing Metaschema module-based data. Can read and write XML, JSON, and YAML content that is valid to the associated Metaschema model.
+- [Metaschema Data Bindings](metaschema-databind-modules/): Provides a variety of different Metaschema modules for different types of data, including support for the Static Analysis Results Interchange Format (SARIF).
+- [Metaschema Maven Plugin](metaschema-maven-plugin/): A Maven build plugin that automates generation on Java classes and XML and JSON schemas based on a Metaschema module as part of a Maven build.
+- [Metaschema Schema Generator](metaschema-schema-generator): An API for generating XML and JSON schemas based on a Metaschema module.
 
 Please refer to each sub-module for usage instructions.
diff --git a/src/site/site.xml b/src/site/site.xml
@@ -101,7 +101,7 @@
 			<item name="Fork on GitHub"
 				href="http://github.com/metaschema-framework/metaschema-java/" />
 			<item name="License"
-				href="http://github.com/metaschema-framework/metaschema-java/blob/master/LICENSE.md" />
+				href="http://github.com/metaschema-framework/metaschema-java/blob/main/LICENSE.md" />
 		</menu>
 		<menu name="Modules" ref="modules" />
 		<menu name="Maven Documentation" ref="reports" inherit="bottom" />