Thk v1.15.6

.github/workflows/compile-test.yml → .github/workflows/build-test.yml

@@ -1,12 +1,12 @@
 # HMS Networks Solution Center
-# Compile Test Action for Maven-based Ewon ETK Projects
+# Build Test Action for Maven-based Ewon ETK Projects
 # Version: 2.1
 #
 # This action is configured to automatically run when a push
 # is made or pull request is merged to the `main` or `master`
 # branch.
 
-name: Compile Test
+name: Build Test
 
 on:
   pull_request:
@@ -38,5 +38,5 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-maven-
 
-      - name: Compile Java Files With Maven
-        run: mvn compile -f pom.xml
+      - name: Package Java Files With Maven
+        run: mvn package -f pom.xml

pom.xml

@@ -8,7 +8,7 @@
   <!-- PROJECT NAME -->
   <name>Ewon Flexy Extensions Library</name>
   <!-- PROJECT VERSION -->
-  <version>1.15.5</version>
+  <version>1.15.6</version>
   <!-- PROJECT GROUP ID (PARENT PACKAGE) -->
   <groupId>com.hms_networks.americas.sc</groupId>
   <!-- PROJECT ARTIFACT ID (ROOT PACKAGE NAME) -->
@@ -171,6 +171,7 @@
           <dependencySourceExcludes>
             <dependencySourceExclude>com.hms_networks.americas.sc.mvnlibs:ewon-etk:*</dependencySourceExclude>
           </dependencySourceExcludes>
+          <failOnWarnings>true</failOnWarnings>
         </configuration>
         <executions>
           <execution>

src/main/java/com/hms_networks/americas/sc/extensions/api/ApplicationControlApiListener.java

@@ -274,6 +274,7 @@ public void callForm(String formName) {
    * <p>If the implementation determines that the given parameter(s) are invalid or not supported, a
    * null value may be returned, which will trigger a {@link #RESPONSE_UNKNOWN_PARAM} response.
    *
+   * @param form the custom form
    * @return the response to the request, or null to trigger a {@link #RESPONSE_UNKNOWN_PARAM}
    *     response. Responses must be in the form of a JSON string.
    */

src/main/java/com/hms_networks/americas/sc/extensions/config/ConfigFileUpdateStep.java

@@ -73,7 +73,7 @@ public ConfigFileVersion getStepVersion() {
    * Compare this {@link ConfigFileUpdateStep} version to another {@link ConfigFileUpdateStep}
    * version.
    *
-   * @param compConfigFileVersion the {@link ConfigFileUpdateStep} to compare to
+   * @param o the {@link ConfigFileUpdateStep} to compare to
    * @return a negative integer, zero, or a positive integer as the specified version is greater
    *     than, equal to, or less than this version.
    * @since 1.15.4

src/main/java/com/hms_networks/americas/sc/extensions/config/ConfigFileUpdater.java

@@ -50,7 +50,7 @@ public class ConfigFileUpdater {
   static final String DEFAULT_VERSION_NOT_SPECIFIED = "0.0.0";
 
   /**
-   * Constructor for {@link ConfigUpdater}.
+   * Constructor for {@link ConfigFileUpdater}.
    *
    * @param config configuration file
    * @param applicationJsonKey application JSON key

src/main/java/com/hms_networks/americas/sc/extensions/connectors/framework/AbstractConnectorMain.java

@@ -393,6 +393,7 @@ public void requestShutdownConnector() {
    * Method for performing connector application initialization steps.
    *
    * @param args program arguments
+   * @return true if successful, false otherwise
    * @since 1.15.2
    */
   private boolean initialize(String[] args) {
@@ -611,6 +612,7 @@ private boolean initialize(String[] args) {
   /**
    * Method for performing connector application start up steps.
    *
+   * @return true if successful, false otherwise
    * @since 1.15.2
    */
   private boolean startUp() {

src/main/java/com/hms_networks/americas/sc/extensions/logging/Logger.java

@@ -352,6 +352,7 @@ public static void LOG_INFO(String logString) {
    * Log a string and exception with the info log level.
    *
    * @param logString string to log
+   * @param logException exception to log
    * @since 1.15.0
    */
   public static void LOG_INFO(String logString, Exception logException) {
@@ -387,6 +388,7 @@ public static void LOG_WARN(String logString) {
    * Log a string and exception with the warning log level.
    *
    * @param logString string to log
+   * @param logException exception to log
    * @since 1.15.0
    */
   public static void LOG_WARN(String logString, Exception logException) {
@@ -422,6 +424,7 @@ public static void LOG_SERIOUS(String logString) {
    * Log a string and exception with the serious log level.
    *
    * @param logString string to log
+   * @param logException exception to log
    * @since 1.15.0
    */
   public static void LOG_SERIOUS(String logString, Exception logException) {
@@ -458,6 +461,7 @@ public static void LOG_CRITICAL(String logString) {
    * Log a string and exception with the critical log level.
    *
    * @param logString string to log
+   * @param logException exception to log
    * @since 1.15.0
    */
   public static void LOG_CRITICAL(String logString, Exception logException) {

src/main/java/com/hms_networks/americas/sc/extensions/package.html

@@ -5,7 +5,7 @@
 extension classes include many supplemental features, and the addition
 of new functionality which may not be present in the supported Java version.
 
-@version 1.15.5
+@version 1.15.6
 @author HMS Networks, MU Americas Solution Center
 </BODY>
 </HTML>

src/main/java/com/hms_networks/americas/sc/extensions/system/application/SCAppManagement.java

@@ -25,6 +25,7 @@ public class SCAppManagement {
    * established.
    *
    * @param waitSeconds number of seconds to pause the current thread
+   * @throws InterruptedException if the thread is interrupted while waiting
    */
   private static void waitForWanHelper(int waitSeconds) throws InterruptedException {
     long sleepTimeMillis = SCTimeUnit.SECONDS.toMillis(waitSeconds);
@@ -145,6 +146,7 @@ public static boolean deviceHasWanIP() {
    *
    * @param timeout the timeout value in the specified time unit
    * @param timeUnit the time unit of the timeout value
+   * @throws InterruptedException if the thread is interrupted while waiting
    * @return true if an initialized WAN IP is detected, false otherwise
    */
   public static boolean waitForWanIp(int timeout, SCTimeUnit timeUnit) throws InterruptedException {
@@ -181,6 +183,8 @@ public static boolean waitForWanIp(int timeout, SCTimeUnit timeUnit) throws Inte
   /**
    * Pause current thread indefinitely if an initialized WAN IP has not been established. When a WAN
    * IP is detected, resume application.
+   *
+   * @throws InterruptedException if the thread is interrupted while waiting
    */
   public static void waitForWanIp() throws InterruptedException {
     // Ensure there is a valid WAN IP address

src/main/java/com/hms_networks/americas/sc/extensions/system/http/requests/SCHttpRequestInfo.java

@@ -77,6 +77,7 @@ public String getUrl() {
   /**
    * Set the URL of the request object.
    *
+   * @param url the request URL
    * @since 1.15.2
    */
   public void setUrl(String url) {
@@ -96,6 +97,7 @@ public String getHeaders() {
   /**
    * Set the headers of the request object.
    *
+   * @param headers the request headers
    * @since 1.15.2
    */
   public void setHeaders(String headers) {
@@ -115,6 +117,7 @@ public String getBody() {
   /**
    * Set the body of the request object.
    *
+   * @param body the request body
    * @since 1.15.2
    */
   public void setBody(String body) {
@@ -153,6 +156,7 @@ public boolean getIsCompleted() {
   /**
    * Sets the boolean value of whether a request has been completed successfully.
    *
+   * @param isCompleted the boolean value of whether a request has been completed successfully
    * @since 1.15.2
    */
   public void setIsCompleted(boolean isCompleted) {

src/main/java/com/hms_networks/americas/sc/extensions/util/Base64.java

@@ -1030,6 +1030,9 @@ public class Base64 {
    * Returns one of the _SOMETHING_ALPHABET byte arrays depending on the options specified. It's
    * possible, though silly, to specify ORDERED <b>and</b> URLSAFE in which case one of them will be
    * picked, though there is no guarantee as to which one will be picked.
+   *
+   * @param options options for selecting which byte array to return
+   * @return a _SOMETHING_ALPHABET byte arrays
    */
   private static final byte[] getAlphabet(int options) {
     if ((options & URL_SAFE) == URL_SAFE) {
@@ -1045,6 +1048,9 @@ private static final byte[] getAlphabet(int options) {
    * Returns one of the _SOMETHING_DECODABET byte arrays depending on the options specified. It's
    * possible, though silly, to specify ORDERED and URL_SAFE in which case one of them will be
    * picked, though there is no guarantee as to which one will be picked.
+   *
+   * @param options options for selecting which byte array to return
+   * @return a _SOMETHING_DECODABET byte arrays
    */
   private static final byte[] getDecodabet(int options) {
     if ((options & URL_SAFE) == URL_SAFE) {
@@ -1071,6 +1077,7 @@ private Base64() {}
    * @param b4 A reusable byte array to reduce array instantiation
    * @param threeBytes the array to convert
    * @param numSigBytes the number of significant bytes in your array
+   * @param options options for getAlphabet()
    * @return four byte array in Base64 notation.
    * @since 1.5.1
    */
@@ -1094,6 +1101,7 @@ private static byte[] encode3to4(byte[] b4, byte[] threeBytes, int numSigBytes,
    * @param numSigBytes the number of significant bytes in your array
    * @param destination the array to hold the conversion
    * @param destOffset the index where output will be put
+   * @param options options for getAlphabet call
    * @return the <var>destination</var> array
    * @since 1.3
    */
@@ -1650,6 +1658,7 @@ else if (source[srcOffset + 3] == EQUALS_SIGN) {
    * consider this method.
    *
    * @param source The Base64 encoded data
+   * @throws java.io.IOException If bogus characters exist in source data
    * @return decoded data
    * @since 2.3.1
    */

starting-files/jvmrun

@@ -1 +1 @@
--heapsize 25M -classpath /usr/extensions-1.15.5-full.jar -emain com.hms_networks.americas.sc.extensions.ExtensionsMain
+-heapsize 25M -classpath /usr/extensions-1.15.6-full.jar -emain com.hms_networks.americas.sc.extensions.ExtensionsMain

web-docs/docs/02-CHANGELOG.mdx

@@ -5,6 +5,11 @@ sidebar_label: Change Log
 toc_max_heading_level: 2
 ---
 
+## Version 1.15.6
+### Features
+- Added missing Javadocs
+- Builds now fail if Javadoc warnings exist
+
 ## Version 1.15.5
 ### Features
 - Added method to check if the configuration file needs to be updated.

web-docs/docs/_partial/_pom_library.mdx

@@ -7,7 +7,7 @@ import ScDocusaurusConfig from "@site/ScDocusaurusConfig.js";
   <dependency>
     <groupId>com.hms_networks.americas.sc</groupId>
     <artifactId>extensions</artifactId>
-    <version>1.15.5</version>
+    <version>1.15.6</version>
   </dependency>
   ...
 </dependencies>