Merge pull request #607 from opengeospatial/issue#576

Closes #576
opengeospatial · Jan 11, 2024 · cfa5a38 · cfa5a38
2 parents d0e7a04 + 0f8da17
commit cfa5a38
Show file tree

Hide file tree

Showing 15 changed files with 63 additions and 60 deletions.
diff --git a/pom.xml b/pom.xml
@@ -441,11 +441,12 @@
         </plugin>
         <plugin>
           <artifactId>maven-javadoc-plugin</artifactId>
-          <version>2.10.4</version>
+          <version>3.6.3</version>
           <configuration>
             <docfilessubdirs>true</docfilessubdirs>
             <show>package</show>
-            <additionalparam>-Xdoclint:none</additionalparam>
+            <additionalJOption>-Xdoclint:none</additionalJOption>
+            <detectOfflineLinks>false</detectOfflineLinks>
           </configuration>
           <executions>
             <execution>

diff --git a/teamengine-core/src/main/java/com/occamlab/te/SwingForm.java b/teamengine-core/src/main/java/com/occamlab/te/SwingForm.java
@@ -30,7 +30,7 @@
 import com.occamlab.te.util.DomUtils;
 
 /**
- * Swing-based form created from the content of a <ctl:form> element. This is
+ * Swing-based form created from the content of a &lt;ctl:form&gt; element. This is
  * produced when not running the test harness in a web application context.
  */
 public class SwingForm extends JFrame implements HyperlinkListener {

diff --git a/teamengine-core/src/main/java/com/occamlab/te/TECore.java b/teamengine-core/src/main/java/com/occamlab/te/TECore.java
@@ -1583,18 +1583,18 @@ public NodeList soap_request(Document ctlRequest, String id)
      * @throws Exception
      *             the exception
    *
-     *             <soap-request version="1.1|1.2" charset="UTF-8">
-     *             <url>http://blah</url> <action>Some-URI</action> <headers>
-     *             <header MutUnderstand="true" rely="true" role="http://etc">
-     *             <t:Transaction xmlns:t="some-URI" >5</t:Transaction>
-     *             </header> </headers> <body> <m:GetLastTradePrice
-     *             xmlns:m="Some-URI"> <symbol>DEF</symbol>
-     *             </m:GetLastTradePrice> </body> <parsers:SOAPParser
-     *             return="content"> <parsers:XMLValidatingParser>
-     *             <parsers:schemas> <parsers:schema
-     *             type="url">http://blah/schema.xsd</parsers:schema>
-     *             </parsers:schemas> </parsers:XMLValidatingParser>
-     *             </parsers:SOAPParser> </soap-request>
+     *             &lt;soap-request version="1.1|1.2" charset="UTF-8"&gt;
+     *             &lt;url&gt;http://blah&lt;/url&gt; &lt;action&gt;Some-URI&lt;/action&gt; &lt;headers&gt;
+     *             &lt;header MutUnderstand="true" rely="true" role="http://etc"&gt;
+     *             &lt;t:Transaction xmlns:t="some-URI" &gt;5&lt;/t:Transaction&gt;
+     *             &lt;/header&gt; &lt;/headers&gt; &lt;body&gt; &lt;m:GetLastTradePrice
+     *             xmlns:m="Some-URI"&gt; &lt;symbol&gt;DEF&lt;/symbol&gt;
+     *             &lt;/m:GetLastTradePrice&gt; &lt;/body&gt; &lt;parsers:SOAPParser
+     *             return="content"&gt; &lt;parsers:XMLValidatingParser&gt;
+     *             &lt;parsers:schemas&gt; &lt;parsers:schema
+     *             type="url"&gt;http://blah/schema.xsd&lt;/parsers:schema&gt;
+     *             &lt;/parsers:schemas&gt; &lt;/parsers:XMLValidatingParser&gt;
+     *             &lt;/parsers:SOAPParser&gt; &lt;/soap-request&gt;
    */
   static public URLConnection build_soap_request(Node xml) throws Exception {
     String sUrl = null;
@@ -2348,7 +2348,7 @@ public Element getLogCache(String id) {
    * Converts CTL input form elements to generate a Swing-based or XHTML form
    * and reports the results of processing the submitted form. The results
    * document is produced in (web context) or
-   * {@link SwingForm.CustomFormView#submitData}.
+   * {@link com.occamlab.te.SwingForm.CustomFormView#submitData(String)}.
    *
      * @param ctlForm
      *            a DOM Document representing a &lt;ctl:form&gt; element.

diff --git a/teamengine-core/src/main/java/com/occamlab/te/config/TEBaseNotFoundException.java b/teamengine-core/src/main/java/com/occamlab/te/config/TEBaseNotFoundException.java
@@ -17,7 +17,7 @@ public class TEBaseNotFoundException extends TEConfigException {
 
 	/**
 	 * The <code>path</code> does not exist.
-	 * @param name
+	 * @param path
 	 */
 	public TEBaseNotFoundException (String path){
 		super (path);

diff --git a/teamengine-core/src/main/java/com/occamlab/te/parsers/ImageParser.java b/teamengine-core/src/main/java/com/occamlab/te/parsers/ImageParser.java
@@ -386,11 +386,11 @@ private static void processBufferedImage(BufferedImage buffimage,
 
     /**
      * Determines the width of the first image in an image file in pixels.
+     * author Paul Daisey added 2011-05-13 to support WMTS ETS
      * 
      * @param imageLoc
      *            the string location of the image (uri syntax expected)
      * @return int the image width in pixels, or -1 if unable.
-     * @author Paul Daisey added 2011-05-13 to support WMTS ETS
      */
     public static int getImageWidth(String imageLoc) {
 
@@ -434,11 +434,11 @@ public static int getImageWidth(String imageLoc) {
 
     /**
      * Determines the height of the first image in an image file in pixels.
+     * author Paul Daisey added 2011-05-13 to support WMTS ETS
      * 
      * @param imageLoc
      *            the string location of the image (uri syntax expected)
      * @return int the image width in pixels, or -1 if unable.
-     * @author Paul Daisey added 2011-05-13 to support WMTS ETS
      */
     public static int getImageHeight(String imageLoc) {
 

diff --git a/teamengine-core/src/main/java/com/occamlab/te/parsers/SchematronValidatingParser.java b/teamengine-core/src/main/java/com/occamlab/te/parsers/SchematronValidatingParser.java
@@ -187,7 +187,7 @@ public boolean checkSchematronRules(Document doc, String schemaFile,
      * validation status (takes schematron file, not string location). New and
      * ADVANCED! (team engine can't work with overloaded methods :P)
      * 
-     * @param doc
+     * @param inputDoc
      *            The XML file to validate (Document)
      * @param schemaFile
      *            The file object of the schematron file to validate with

diff --git a/teamengine-core/src/main/java/com/occamlab/te/parsers/SoapParser.java b/teamengine-core/src/main/java/com/occamlab/te/parsers/SoapParser.java
@@ -40,6 +40,7 @@ public class SoapParser {
 
     /**
      * A method to parse and valdate the response of a SOAP server.
+     * author Simone Gianfranceschi
      * 
      * @param uc
      *            the URL Connection to be used to retrieve the SOAP message.
@@ -51,7 +52,6 @@ public class SoapParser {
      * @return null if there were errors, the parsed document otherwise: it can
      *         be the SOAP message, the SOAP message body content or a SOAP fult
      * 
-     * @author Simone Gianfranceschi
      */
     public Document parse(URLConnection uc, Element instruction,
             PrintWriter logger) throws Exception {
@@ -109,6 +109,7 @@ public Document parse(URLConnection uc, Element instruction,
 
     /**
      * A method to parse and valdate the response of a SOAP server.
+     * author Simone Gianfranceschi
      * 
      * @param xml
      *            the SOAP message to retrieve and validate. May be an
@@ -121,7 +122,6 @@ public Document parse(URLConnection uc, Element instruction,
      * @return null if there were errors, the parsed document otherwise: it can
      *         be the SOAP message, the SOAP message body content or a SOAP fult
      * 
-     * @author Simone Gianfranceschi
      */
     private Document parse(Object xml, Element instruction, PrintWriter logger)
             throws Exception {
@@ -181,13 +181,13 @@ private Document parse(Object xml, Element instruction, PrintWriter logger)
      * A method to validate the SOAP message received. The message is validated
      * against the propoer SOAP Schema (1.1 or 1.2 depending on the namespace of
      * the incoming message)
+     * author Simone Gianfranceschi
      * 
      * @param soapMessage
      *            the SOAP message to validate.
      * @param eh
      *            the error handler.
      * 
-     * @author Simone Gianfranceschi
      */
     private void validateSoapMessage(Document soapMessage, ErrorHandler eh)
             throws Exception {
@@ -219,10 +219,11 @@ private void validateSoapMessage(Document soapMessage, ErrorHandler eh)
     /**
      * A method to check if the message received is a SOAP fault.
      * 
+     * author Simone Gianfranceschi
+     * 
      * @param soapMessage
      *            the SOAP message to check.
      * 
-     * @author Simone Gianfranceschi
      */
     private boolean isSoapFault(Document soapMessage) throws Exception {
         Element faultElement = DomUtils.getElementByTagNameNS(soapMessage,
@@ -243,6 +244,7 @@ private boolean isSoapFault(Document soapMessage) throws Exception {
     /**
      * A method to parse a SOAP fault. It checks the namespace and invoke the
      * correct SOAP 1.1 or 1.2 Fault parser.
+     * author Simone Gianfranceschi
      * 
      * @param soapMessage
      *            the SOAP fault message to parse
@@ -252,7 +254,6 @@ private boolean isSoapFault(Document soapMessage) throws Exception {
      * 
      * @return the parsed document otherwise
      * 
-     * @author Simone Gianfranceschi
      */
     private Document parseSoapFault(Document soapMessage, PrintWriter logger)
             throws Exception {
@@ -268,6 +269,7 @@ private Document parseSoapFault(Document soapMessage, PrintWriter logger)
 
     /**
      * A method to parse a SOAP 1.1 fault message.
+     * author Simone Gianfranceschi
      * 
      * @param soapMessage
      *            the SOAP 1.1 fault message to parse
@@ -277,7 +279,6 @@ private Document parseSoapFault(Document soapMessage, PrintWriter logger)
      * 
      * @return void
      * 
-     * @author Simone Gianfranceschi
      */
     private void parseSoap11Fault(Document soapMessage, PrintWriter logger)
             throws Exception {
@@ -304,7 +305,8 @@ private void parseSoap11Fault(Document soapMessage, PrintWriter logger)
 
     /**
      * A method to parse a SOAP 1.2 fault message.
-     * 
+     * author Simone Gianfranceschi
+     *
      * @param soapMessage
      *            the SOAP 1.2 fault message to parse
      * 
@@ -313,7 +315,6 @@ private void parseSoap11Fault(Document soapMessage, PrintWriter logger)
      * 
      * @return void
      * 
-     * @author Simone Gianfranceschi
      */
     private void parseSoap12Fault(Document soapMessage, PrintWriter logger)
             throws Exception {

diff --git a/teamengine-core/src/main/java/com/occamlab/te/parsers/XMLValidatingParser.java b/teamengine-core/src/main/java/com/occamlab/te/parsers/XMLValidatingParser.java
@@ -318,9 +318,9 @@ Document parse(Object input, Element parserConfig, PrintWriter logger)
 	/**
 	 * A method to validate a pool of schemas outside of the request element.
 	 * 
-	 * @param Document
+	 * @param doc
 	 *            doc The file document to validate
-	 * @param Document
+	 * @param instruction
 	 *            instruction The xml encapsulated schema information (file
 	 *            locations)
 	 * @return false if there were errors, true if none.

diff --git a/teamengine-core/src/main/java/com/occamlab/te/parsers/ZipParser.java b/teamengine-core/src/main/java/com/occamlab/te/parsers/ZipParser.java
@@ -30,11 +30,11 @@
 
 /**
  * Parses a zip file input by extracting the contents into the directory
- * specified by the value of the <code>java.io.tmpdir</code> system property.
+ * specified by the value of the &lt;code&gt;java.io.tmpdir&lt;/code&gt; system property.
  * The resulting manifest is structured as follows:
  * 
- * <ctl:manifest xmlns:ctl="http://www.occamlab.com/ctl"> <ctl:file-entry
- * full-path="${java.io.tmpdir}/dir/doc.kml" size="2048" /> </ctl:manifest>
+ * &lt;ctl:manifest xmlns:ctl="http://www.occamlab.com/ctl"&gt; &lt;ctl:file-entry
+ * full-path="${java.io.tmpdir}/dir/doc.kml" size="2048" /&gt; &lt;/ctl:manifest&gt;
  * 
  * @author jparrpearson
  */
@@ -83,7 +83,7 @@ public static String getMediaType(String ext) {
     /**
      * Parses the entity (a ZIP archive) obtained in response to submitting a
      * request to some URL. The resulting manifest is an XML document with
-     * <ctl:manifest> as the document element.
+     * &lt;ctl:manifest&gt; as the document element.
      * 
      * @param resp
      *            the response to parse
@@ -178,7 +178,7 @@ else if (filename.lastIndexOf("\\") != -1)
 
     /**
      * Extracts the local Zip file and saves to the working directory. The
-     * resulting manifest is an XML document with <ctl:manifest> as the document
+     * resulting manifest is an XML document with &lt;ctl:manifest&gt; as the document
      * element.
      * 
      * @param path

diff --git a/teamengine-core/src/main/java/com/occamlab/te/util/DomUtils.java b/teamengine-core/src/main/java/com/occamlab/te/util/DomUtils.java
@@ -115,14 +115,14 @@ public static Node addDomAttr(Document doc, String tagName,
      * @param str
      *            the string value to match in the comment nodes
      * 
-     *            CTL declaration, if we ever want to use it <!--Sample Usage:
-     *            ctl:checkCommentNodes($xml.resp, 'complexContent')-->
-     *            <ctl:function name="ctl:checkCommentNodes"> <ctl:param
-     *            name="node"/> <ctl:param name="string"/>
-     *            <ctl:description>Checks a Node for comments that contain the
-     *            given string.</ctl:description> <ctl:java
+     *            CTL declaration, if we ever want to use it &lt;!--Sample Usage:
+     *            ctl:checkCommentNodes($xml.resp, 'complexContent')--&gt;
+     *            &lt;ctl:function name="ctl:checkCommentNodes"&gt; &lt;ctl:param
+     *            name="node"/&gt; &lt;ctl:param name="string"/&gt;
+     *            &lt;ctl:description&gt;Checks a Node for comments that contain the
+     *            given string.&lt;/ctl:description&gt; &lt;ctl:java
      *            class="com.occamlab.te.util.DomUtils"
-     *            method="checkCommentNodes"/> </ctl:function>
+     *            method="checkCommentNodes"/&gt; &lt;/ctl:function&gt;
      * 
      * @return the original Document with the update attribute nodes
      */

diff --git a/teamengine-core/src/main/java/com/occamlab/te/util/LogUtils.java b/teamengine-core/src/main/java/com/occamlab/te/util/LogUtils.java
@@ -531,11 +531,11 @@ public static String generateSessionId(File logDir) {
      * Generate a file in logDir refererring all logfiles. Create a file called
      * "report_logs.xml" in the log folder that includes all logs listed inside
      * the directory.
+     * author F.Vitale vitale@imaa.cnr.it
      * 
      * @param sessionLogDir
      *            considered log directory
      * @throws Exception
-     * @author F.Vitale vitale@imaa.cnr.it
      */
     public static void createFullReportLog(String sessionLogDir)
             throws Exception {

diff --git a/teamengine-core/src/main/java/com/occamlab/te/util/Soap11MessageBuilder.java b/teamengine-core/src/main/java/com/occamlab/te/util/Soap11MessageBuilder.java
@@ -62,6 +62,7 @@ public class Soap11MessageBuilder {
     /**
      * A method to get the SOAP 1.1 message. The message is created and returned
      * as DOM Document.
+     * author Simone Gianfranceschi
      * 
      * @param headerBlocks
      *            The list of header blocks to be included in the SOAP message
@@ -72,7 +73,6 @@ public class Soap11MessageBuilder {
      * 
      * @return the DOM document representing the SOAP message
      * 
-     * @author Simone Gianfranceschi
      */
     public static Document getSoapMessage(List headerBlocks, Element i_body)
             throws Exception {

diff --git a/teamengine-core/src/main/java/com/occamlab/te/util/Soap12MessageBuilder.java b/teamengine-core/src/main/java/com/occamlab/te/util/Soap12MessageBuilder.java
@@ -52,6 +52,7 @@ public class Soap12MessageBuilder {
     /**
      * A method to get the SOAP 1.2 message. The message is created and returned
      * as DOM Document.
+     * author Simone Gianfranceschi
      * 
      * @param headerBlocks
      *            The list of header blocks to be included in the SOAP message
@@ -62,7 +63,6 @@ public class Soap12MessageBuilder {
      * 
      * @return the DOM document representing the SOAP message
      * 
-     * @author Simone Gianfranceschi
      */
     public static Document getSoapMessage(List headerBlocks, Element i_body)
             throws Exception {