[#1101] Fix JavaDoc Generation Errors/Warnings

.ci/system-tests/sys_test_common.sh

@@ -60,7 +60,7 @@ docker exec -i $aca_container mysql -u root -proot -D hirs_db -e "Update PolicyS
 clearAcaDb() {
 docker exec -i $aca_container mysql -u root -proot -e "use hirs_db; set foreign_key_checks=0; truncate Appraiser;
  truncate Certificate;truncate Issued_Attestation_Platform_Join_Table;truncate CertificatesUsedToValidate;truncate ComponentAttributeResult;
- truncate ComponentInfo;truncate ComponentResult;truncate Device;truncate DeviceInfoReport;truncate PortalInfo;
+ truncate ComponentInfo;truncate ComponentResult;truncate Device;truncate DeviceInfoReport;
  truncate ReferenceDigestValue;truncate ReferenceManifest;truncate Report;truncate SupplyChainValidation;
  truncate SupplyChainValidationSummary;truncate SupplyChainValidationSummary_SupplyChainValidation;
  truncate TPM2ProvisionerState;set foreign_key_checks=1;"

HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/manager/CertificateRepository.java

@@ -13,6 +13,15 @@
 import java.util.List;
 import java.util.UUID;
 
+/**
+ * Repository interface for managing {@link Certificate} entities in the database.
+ *
+ * <p>
+ * The {@link CertificateRepository} interface extends {@link JpaRepository} to provide basic CRUD operations,
+ * including save, find, delete, and query methods. Custom query methods can be defined
+ * using Spring Data JPA's query method naming conventions or with the Query annotation.
+ * </p>
+ */
 @Repository
 public interface CertificateRepository extends JpaRepository<Certificate, UUID> {
 

HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/manager/ComponentAttributeRepository.java

@@ -6,6 +6,15 @@
 import java.util.List;
 import java.util.UUID;
 
+/**
+ * Repository interface for managing {@link ComponentAttributeResult} entities in the database.
+ *
+ * <p>
+ * The {@link ComponentAttributeRepository} interface extends {@link JpaRepository} to provide basic CRUD operations,
+ * including save, find, delete, and query methods. Custom query methods can be defined
+ * using Spring Data JPA's query method naming conventions or with the Query annotation.
+ * </p>
+ */
 public interface ComponentAttributeRepository extends JpaRepository<ComponentAttributeResult, UUID> {
     /**
      * Query to look up Attribute Results based on the PlatformCredential's

HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/manager/ComponentInfoRepository.java

@@ -6,6 +6,15 @@
 import java.util.List;
 import java.util.UUID;
 
+/**
+ * Repository interface for managing {@link ComponentInfo} entities in the database.
+ *
+ * <p>
+ * The {@link ComponentInfoRepository} interface extends {@link JpaRepository} to provide basic CRUD operations,
+ * including save, find, delete, and query methods. Custom query methods can be defined
+ * using Spring Data JPA's query method naming conventions or with the Query annotation.
+ * </p>
+ */
 public interface ComponentInfoRepository extends JpaRepository<ComponentInfo, UUID> {
     /**
      * Query that retrieves device components by device name.

HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/manager/ComponentResultRepository.java

@@ -7,6 +7,15 @@
 import java.util.List;
 import java.util.UUID;
 
+/**
+ * Repository interface for managing {@link ComponentResult} entities in the database.
+ *
+ * <p>
+ * The {@link ComponentResultRepository} interface extends {@link JpaRepository} to provide basic CRUD operations,
+ * including save, find, delete, and query methods. Custom query methods can be defined
+ * using Spring Data JPA's query method naming conventions or with the Query annotation.
+ * </p>
+ */
 @Repository
 public interface ComponentResultRepository extends JpaRepository<ComponentResult, UUID> {
 

HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/manager/DeviceRepository.java

@@ -6,6 +6,15 @@
 
 import java.util.UUID;
 
+/**
+ * Repository interface for managing {@link Device} entities in the database.
+ *
+ * <p>
+ * The {@link DeviceRepository} interface extends {@link JpaRepository} to provide basic CRUD operations,
+ * including save, find, delete, and query methods. Custom query methods can be defined
+ * using Spring Data JPA's query method naming conventions or with the Query annotation.
+ * </p>
+ */
 @Repository
 public interface DeviceRepository extends JpaRepository<Device, UUID> {
     /**

HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/manager/PolicyRepository.java

@@ -6,6 +6,15 @@
 
 import java.util.UUID;
 
+/**
+ * Repository interface for managing the ACA's {@link PolicySettings} in the database.
+ *
+ * <p>
+ * The {@link PolicyRepository} interface extends {@link JpaRepository} to provide basic CRUD operations,
+ * including save, find, delete, and query methods. Custom query methods can be defined
+ * using Spring Data JPA's query method naming conventions or with the Query annotation.
+ * </p>
+ */
 @Repository
 public interface PolicyRepository extends JpaRepository<PolicySettings, UUID> {
 

HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/manager/ReferenceDigestValueRepository.java

@@ -7,6 +7,15 @@
 import java.util.List;
 import java.util.UUID;
 
+/**
+ * Repository interface for managing {@link ReferenceDigestValue} entities in the database.
+ *
+ * <p>
+ * The {@link ReferenceDigestValueRepository} interface extends {@link JpaRepository} to provide basic CRUD operations,
+ * including save, find, delete, and query methods. Custom query methods can be defined
+ * using Spring Data JPA's query method naming conventions or with the Query annotation.
+ * </p>
+ */
 @Repository
 public interface ReferenceDigestValueRepository extends JpaRepository<ReferenceDigestValue, UUID> {
 

HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/manager/SupplyChainValidationRepository.java

@@ -8,6 +8,15 @@
 import java.util.List;
 import java.util.UUID;
 
+/**
+ * Repository interface for managing {@link SupplyChainValidation} entities in the database.
+ *
+ * <p>
+ * The {@link SupplyChainValidationRepository} interface extends {@link JpaRepository} to provide basic CRUD
+ * operations, including save, find, delete, and query methods. Custom query methods can be defined
+ * using Spring Data JPA's query method naming conventions or with the Query annotation.
+ * </p>
+ */
 @Repository
 public interface SupplyChainValidationRepository extends JpaRepository<SupplyChainValidation, UUID> {
     /**

HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/manager/TPM2ProvisionerStateRepository.java

@@ -4,6 +4,15 @@
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.stereotype.Repository;
 
+/**
+ * Repository interface for managing {@link TPM2ProvisionerState} entities in the database.
+ *
+ * <p>
+ * The {@link TPM2ProvisionerStateRepository} interface extends {@link JpaRepository} to provide basic CRUD operations,
+ * including save, find, delete, and query methods. Custom query methods can be defined
+ * using Spring Data JPA's query method naming conventions or with the Query annotation.
+ * </p>
+ */
 @Repository
 public interface TPM2ProvisionerStateRepository extends JpaRepository<TPM2ProvisionerState, Long> {
 

HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/manager/package-info.java

@@ -1 +1,6 @@
+/**
+ * Contains all the HIRS manager classes responsible for interacting with the database.
+ * These managers encapsulate the logic for data retrieval, persistence, and manipulation,
+ * providing a higher-level interface for accessing and modifying the underlying data models.
+ */
 package hirs.attestationca.persist.entity.manager;

HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/package-info.java

@@ -1,4 +1,5 @@
 /**
- * This package has objects for hibernate entity.
+ * Contains Hibernate entity classes that define the data model and map to database tables,
+ * providing the necessary structure for data persistence and retrieval.
  */
 package hirs.attestationca.persist.entity;

HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/tpm/package-info.java

@@ -1 +1,4 @@
+/**
+ * Contains files for capturing information about the TPM Provisioning state.
+ */
 package hirs.attestationca.persist.entity.tpm;

HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/userdefined/Certificate.java

@@ -489,7 +489,8 @@ public static byte[] readBytes(final Path certificatePath) throws IOException {
      * found in various RFCs.
      *
      * @param certificate the certificate holding subject DNs
-     * @return IOException if there is an issue decoding the subject DNs
+     * @return subject distinguished name
+     * @throws IOException if there is an issue decoding the subject DNs
      */
     public static String getSubjectDNString(final X509Certificate certificate)
             throws IOException {
@@ -509,7 +510,8 @@ public static String getSubjectDNString(final X509Certificate certificate)
      * in various RFCs.
      *
      * @param certificate the certificate holding issuer DNs
-     * @return IOException if there is an issue decoding the issuer DNs
+     * @return issuer distinguished name
+     * @throws IOException if there is an issue decoding the issuer distinguished names
      */
     public static String getIssuerDNString(final X509Certificate certificate)
             throws IOException {

HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/service/util/DataTablesColumn.java → HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/userdefined/DataTablesColumn.java

@@ -1,4 +1,4 @@
-package hirs.attestationca.persist.service.util;
+package hirs.attestationca.persist.entity.userdefined;
 
 import lombok.AllArgsConstructor;
 import lombok.Builder;

HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/userdefined/Device.java

@@ -22,6 +22,9 @@
 import java.sql.Timestamp;
 import java.time.LocalDateTime;
 
+/**
+ * User-defined, Java representation of a physical Device.
+ */
 @Entity
 @Table(name = "Device")
 @Setter

HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/util/DownloadFile.java → HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/userdefined/DownloadFile.java

@@ -1,4 +1,4 @@
-package hirs.attestationca.persist.util;
+package hirs.attestationca.persist.entity.userdefined;
 
 import lombok.AllArgsConstructor;
 import lombok.Getter;

HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/FilteredRecordsList.java → HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/userdefined/FilteredRecordsList.java

@@ -1,4 +1,4 @@
-package hirs.attestationca.persist;
+package hirs.attestationca.persist.entity.userdefined;
 
 import lombok.Data;
 import lombok.EqualsAndHashCode;