[saaj] Update TCK user guide for SAAJ 3.0

Signed-off-by: Lukas Jungmann <lukas.jungmann@oracle.com>
jakartaee · Feb 10, 2022 · 5ccbbd5 · 5ccbbd5
1 parent a194eff
commit 5ccbbd5
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 27 deletions.
diff --git a/user_guides/saaj/pom.xml b/user_guides/saaj/pom.xml
@@ -22,22 +22,22 @@
     <parent>
         <groupId>org.eclipse.ee4j</groupId>
         <artifactId>project</artifactId>
-        <version>1.0.5</version>
+        <version>1.0.7</version>
     </parent>
     <groupId>org.glassfish</groupId>
     <artifactId>tck_saaj</artifactId>
     <packaging>pom</packaging>
-    <version>2.0.1</version>
-    <name>Eclipse Foundation Technology Compatibility Kit User's Guide for SOAP with Attachments API for Jakarta EE, Release 2.0</name>
+    <version>3.0.0</version>
+    <name>Eclipse Foundation Technology Compatibility Kit User's Guide for SOAP with Attachments API for Jakarta EE, Release 3.0</name>
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <site.output.dir>${project.build.directory}/staging</site.output.dir>
         <maven.site.skip>true</maven.site.skip>
-        <asciidoctorj.version>2.4.2</asciidoctorj.version>
-        <asciidoctorj.diagram.version>2.1.0</asciidoctorj.diagram.version>
-        <asciidoctorj.maven.plugin.version>2.1.0</asciidoctorj.maven.plugin.version>
-        <asciidoctorj.pdf.version>1.5.3</asciidoctorj.pdf.version>
+        <asciidoctorj.version>2.5.3</asciidoctorj.version>
+        <asciidoctorj.diagram.version>2.2.1</asciidoctorj.diagram.version>
+        <asciidoctorj.maven.plugin.version>2.2.0</asciidoctorj.maven.plugin.version>
+        <asciidoctorj.pdf.version>1.6.2</asciidoctorj.pdf.version>
         <jbake.maven.plugin.version>0.3.3</jbake.maven.plugin.version>
         <freemarker.version>2.3.30</freemarker.version>
         <!-- status: DRAFT, BETA, etc., or blank for final -->
@@ -81,8 +81,8 @@
                         <configuration>
                             <rules>
                                 <requireJavaVersion>
-                                    <version>[1.8.0,)</version>
-                                    <message>You need JDK8 or newer</message>
+                                    <version>[11,)</version>
+                                    <message>You need Java SE 11 or newer</message>
                                 </requireJavaVersion>
                             </rules>
                         </configuration>
@@ -101,7 +101,7 @@
                         </goals>
                         <configuration>
                             <chapterPatterns>
-                                [0-9]+\s.*,Preface.*,Part\s.*
+                                [A-C0-9]+\s.*,Preface.*,Part\s.*
                             </chapterPatterns>
                         </configuration>
                     </execution>
@@ -206,7 +206,7 @@
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-enforcer-plugin</artifactId>
-                    <version>3.0.0-M3</version>
+                    <version>3.0.0</version>
                 </plugin>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>

diff --git a/user_guides/saaj/src/main/jbake/content/attributes.conf b/user_guides/saaj/src/main/jbake/content/attributes.conf
@@ -1,12 +1,12 @@
 :TechnologyFullName: Jakarta SOAP Attachments
 :TechnologyShortName: SOAP Attachments
 :LegacyAcronym: SAAJ
-:TechnologyVersion: 2.0
-:ReleaseDate: May 2021
-:CopyrightDates: 2017, 2021
-:TechnologyRI: Jakarta SOAP with Attachments Implementation 2.0.0
+:TechnologyVersion: 3.0
+:ReleaseDate: March 2022
+:CopyrightDates: 2017, 2022
+:TechnologyRI: Jakarta SOAP with Attachments Implementation 3.0.0
 :TechnologyRIURL: https://eclipse-ee4j.github.io/metro-saaj/
-:SpecificationURL: https://jakarta.ee/specifications/soap-attachments/2.0/
+:SpecificationURL: https://jakarta.ee/specifications/soap-attachments/3.0/
 :TCKInquiryList: mailto:jakartaee-tck-dev@eclipse.org[jakartaee-tck-dev@eclipse.org]
 :SpecificationInquiryList: mailto:jaxws-dev@eclipse.org[jaxws-dev@eclipse.org]
 :techID: SOAP
@@ -22,13 +22,13 @@
 // for the technology.  Used in config.inc.
 :TechnologyHomeEnv: TS_HOME
 // Java SE version required.
-:SEversion: 8 (1.8) or 11
+:SEversion: 11+
 :AntVersion: 1.10.0+
-:JakartaEEVersion: 9.1
+:JakartaEEVersion: 10
 :JavaTestVersion: 5.0
 :jteFileName: <TS_HOME>/bin/ts.jte
 :jtxFileName: <TS_HOME>/bin/ts.jtx
-:TCKPackageName: jakarta-soap-tck-2.0.1.zip
+:TCKPackageName: jakarta-soap-tck-3.0.0.zip
 // Directory names used in examples in using.adoc.
 :sigTestDirectoryExample: <TS_HOME>/src/com/sun/ts/tests/signaturetest/saaj
 :singleTestDirectoryExample: <TS_HOME>/src/com/sun/ts/tests/saaj/api/client

diff --git a/user_guides/saaj/src/main/jbake/content/config.adoc b/user_guides/saaj/src/main/jbake/content/config.adoc
@@ -279,7 +279,7 @@ the file under the `<TS_HOME>/bin/xml/impl/<your_impl>` directory.
 For more information, you may wish to view `<TS_HOME>/bin/xml/impl/glassfish/config.vi.xml`,
 the configuration file for Jakarta EE {JakartaEEVersion} Compatible Implementation, Eclipse GlassFish.
 
-[[GBFWG]][[custom-deployment-handlers]]
+[[GBFWE]][[custom-deployment-handlers]]
 
 4.5 Custom Deployment Handlers
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -303,7 +303,7 @@ resides. The primary `build.xml` file in the `<TS_HOME>/bin` directory
 has a target to invoke any of the required targets (`-deploy`, `-undeploy`,
 `-deploy.all`, `-undeploy.all`).
 
-[[GBFVA]][[create-custom-deployment-handler]]
+[[GBFWF]][[create-custom-deployment-handler]]
 
 4.5.1 To Create a Custom Deployment Handler
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

diff --git a/user_guides/saaj/src/main/jbake/content/intro.adoc b/user_guides/saaj/src/main/jbake/content/intro.adoc
@@ -328,13 +328,16 @@ guide.
 
 1.  Make sure that the following software has been correctly installed
 on the system hosting the JavaTest harness:
++
+--
 include::req-software.inc[]
 * Java SE {SEversion}
 * Apache Ant {AntVersion}
 * A CI for {TechnologyShortName} {TechnologyVersion}. One example is {TechnologyRI}.
 * {TechnologyShortName} TCK version {TechnologyVersion}, which includes:
 include::tck-packages.inc[]
-* The {TechnologyShortName} {TechnologyVersion} Vendor Implementation (VI) +
+* The {TechnologyShortName} {TechnologyVersion} Vendor Implementation (VI)
+--
 See the documentation for each of these software applications for
 installation instructions. See link:install.html#GBFTP[Chapter 3,
 "Installation,"] for instructions on installing the {TechnologyShortName} TCK.

diff --git a/user_guides/saaj/src/main/jbake/content/req-software.inc b/user_guides/saaj/src/main/jbake/content/req-software.inc
@@ -8,4 +8,4 @@ below line can be removed.
 This is used in intro.adoc in section 1.3 and install.adoc in section 3.2.
 ///////////////////////////////////////////////////////////////////////
 
-* Eclipse GlassFish 6.0 Compatible Implementation or, at a minimum, a Web server with a Servlet container
+* Eclipse GlassFish 7.0 Compatible Implementation or, at a minimum, a Web server with a Servlet container
diff --git a/user_guides/saaj/src/main/jbake/content/toc.adoc b/user_guides/saaj/src/main/jbake/content/toc.adoc
@@ -67,8 +67,8 @@ link:config.html#GBFVV[4 Setup and Configuration]
 ** link:config.html#GCLHU[4.2 Configuring Your Environment to Run the TCK With Your Concurreny Implementation]
 ** link:config.html#GHGDG[4.3 Publishing the Test Applications]
 ** link:config.html#GHGDH[4.4 Custom Configuration Handlers]
-** link:config.html#GBFWG[4.5 Custom Deployment Handlers]
-*** link:config.html#GBFVA[4.5.1 To Create a Custom Deployment Handler]
+** link:config.html#GBFWE[4.5 Custom Deployment Handlers]
+*** link:config.html#GBFWF[4.5.1 To Create a Custom Deployment Handler]
 ** link:config.html#GBFUY[4.6 Using the JavaTest Harness Software]
 ** link:config.html#GBFWG[4.7 Using the JavaTest Harness Configuration GUI]
 *** link:config.html#GBFVA[4.7.1 Configuration GUI Overview]
@@ -103,7 +103,11 @@ link:debug.html#GBFUV[6 Debugging Test Problems]
 ** link:debug.html#GBFVP[6.4 Test Information]
 ** link:debug.html#GBFVZ[6.5 Report Files]
 ** link:debug.html#GBFYF[6.6 Configuration Failures]
-* link:faq.html#GBFYD[A Frequently Asked Questions]
+
+[[a-frequently-asked-questions]]
+link:faq.html#GBFYD[A Frequently Asked Questions]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 ** link:faq.html#GBFYQ[A.1 Where do I start to debug a test failure?]
 ** link:faq.html#GBFYR[A.2 How do I restart a crashed test run?]
 ** link:faq.html#GBFWU[A.3 What would cause tests be added to the exclude list?]
diff --git a/user_guides/saaj/src/main/jbake/templates/footer.ftl b/user_guides/saaj/src/main/jbake/templates/footer.ftl
@@ -37,7 +37,7 @@
 
 <span id="copyright">
 		<img src="img/eclipse_foundation_logo_tiny.png" height="20px" alt="Eclipse Foundation Logo" align="top"/>&nbsp;
-		<span >Copyright&nbsp;&copy;&nbsp;2017,&nbsp;2021&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span>
+		<span >Copyright&nbsp;&copy;&nbsp;2017,&nbsp;2022&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span>
 </span>
 
 </body>