[#1101] Fix JavaDoc Generation Errors/Warnings

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

@@ -13,53 +13,62 @@
 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> {
 
     /**
-     * Query that retrieves a certificate using the provided uuid.
+     * Query that retrieves a {@link Certificate} object using the provided uuid.
      *
      * @param uuid uuid
-     * @return a certificate
+     * @return a {@link Certificate} object
      */
     @Query(value = "SELECT * FROM Certificate where id = ?1", nativeQuery = true)
     Certificate getCertificate(UUID uuid);
 
     /**
-     * Query that retrieves a list of certificates using the provided subject and dtype.
+     * Query that retrieves a list of {@link Certificate} objects using the provided subject and dtype.
      *
      * @param subject subject
      * @param dType   dtype
-     * @return a list of certificates
+     * @return a list of {@link Certificate} objects
      */
     @Query(value = "SELECT * FROM Certificate where subject = ?1 AND DTYPE = ?2", nativeQuery = true)
     List<Certificate> findBySubject(String subject, String dType);
 
     /**
-     * Query that retrieves a sorted list of certificates using the provided subject and dtype.
+     * Query that retrieves a sorted list of {@link Certificate} objects using the provided subject and dtype.
      *
      * @param subjectSorted subject
      * @param dType         dtype
-     * @return a list of sorted certificates
+     * @return a list of sorted {@link Certificate} objects
      */
     @Query(value = "SELECT * FROM Certificate where subjectSorted = ?1 AND  DTYPE = ?2", nativeQuery = true)
     List<Certificate> findBySubjectSorted(String subjectSorted, String dType);
 
     /**
-     * Query that retrieves a list of certificates using the provided dtype.
+     * Query that retrieves a list of {@link Certificate} objects using the provided dtype.
      *
      * @param dType dtype
-     * @return a list of certificates
+     * @return a list of {@link Certificate} objects
      */
     @Query(value = "SELECT * FROM Certificate where DTYPE = ?1", nativeQuery = true)
     List<Certificate> findByType(String dType);
 
     /**
-     * Query that retrieves a list of certificates using the provided serial number and dtype.
+     * Query that retrieves a list of {@link Certificate} objects using the provided serial number and dtype.
      *
      * @param serialNumber serial number
      * @param dType        dtype
-     * @return a certificate
+     * @return a {@link Certificate} object
      */
     @Query(value = "SELECT * FROM Certificate where serialNumber = ?1 AND DTYPE = ?2", nativeQuery = true)
     Certificate findBySerialNumber(BigInteger serialNumber, String dType);
@@ -98,11 +107,11 @@ public interface CertificateRepository extends JpaRepository<Certificate, UUID>
     List<PlatformCredential> getByHolderSerialNumber(BigInteger holderSerialNumber);
 
     /**
-     * Query that retrieves a certificate using the provided certificate hash and dtype.
+     * Query that retrieves a {@link Certificate} object using the provided certificate hash and dtype.
      *
      * @param certificateHash integer certificate hash
      * @param dType           dtype
-     * @return a certificate
+     * @return a {@link Certificate} object
      */
     @Query(value = "SELECT * FROM Certificate where certificateHash = ?1 AND DTYPE = ?2", nativeQuery = true)
     Certificate findByCertificateHashAndDType(int certificateHash, String dType);
@@ -116,29 +125,21 @@ public interface CertificateRepository extends JpaRepository<Certificate, UUID>
     EndorsementCredential findByPublicKeyModulusHexValue(String publicKeyModulusHexValue);
 
     /**
-     * Query that retrieves an issued attestation certificate using the provided device id.
-     *
-     * @param deviceId uuid representation of the device id
-     * @return an issued attestation certificate
-     */
-    IssuedAttestationCertificate findByDeviceId(UUID deviceId);
-
-    /**
-     * Query that retrieves a list of issued attestation certificates using the provided device id,
+     * Query that retrieves a list of  {@link IssuedAttestationCertificate} objects using the provided device id,
      * ldevID value and sort value.
      *
      * @param deviceId device id
      * @param ldevID   is it a LDevId
      * @param sort     sort
-     * @return a list of issued attestation certificates
+     * @return a list of {@link IssuedAttestationCertificate} objects
      */
     List<IssuedAttestationCertificate> findByDeviceIdAndLdevID(UUID deviceId, boolean ldevID, Sort sort);
 
     /**
-     * Query that retrieves a certificates using the provided certificate hash.
+     * Query that retrieves a {@link Certificate} object using the provided certificate hash.
      *
      * @param certificateHash integer certificate hash
-     * @return a certificate
+     * @return a {@link Certificate} object
      */
     Certificate findByCertificateHash(int certificateHash);
 }

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

@@ -6,31 +6,30 @@
 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
+     * Query to retrieves a list of {@link ComponentAttributeResult} objects based on the PlatformCredential's
      * db component id.
      *
      * @param componentId the unique id for the component identifier
-     * @return a list of attribute results
+     * @return a list of {@link ComponentAttributeResult} objects
      */
     List<ComponentAttributeResult> findByComponentId(UUID componentId);
 
     /**
-     * Query to look up Attribute Results based on the validation id.
+     * Query that retrieves a list of {@link ComponentAttributeResult} objects based on the validation id.
      *
      * @param provisionSessionId unique id generated to link supply chain summary
-     * @return a list of attribute results
+     * @return a list of {@link ComponentAttributeResult} objects
      */
     List<ComponentAttributeResult> findByProvisionSessionId(UUID provisionSessionId);
-
-    /**
-     * Query to look up Attribute Results based on the component id and the session id.
-     *
-     * @param componentId        the unique id for the component identifier
-     * @param provisionSessionId unique id generated to link supply chain summary
-     * @return a list of attribute results
-     */
-    List<ComponentAttributeResult> findByComponentIdAndProvisionSessionId(UUID componentId,
-                                                                          UUID provisionSessionId);
 }

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

@@ -6,22 +6,21 @@
 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.
+     * Query that retrieves a list of {@link ComponentInfo} objects (device components) by device name.
      *
      * @param deviceName string for the host name
-     * @return a list of device components
+     * @return a list of {@link ComponentInfo} objects (device components)
      */
     List<ComponentInfo> findByDeviceName(String deviceName);
-
-    /**
-     * Query that retrieves device components by device name and
-     * the component serial number.
-     *
-     * @param deviceName      string for the host name
-     * @param componentSerial string for the component serial
-     * @return a list of device components
-     */
-    List<ComponentInfo> findByDeviceNameAndComponentSerial(String deviceName, String componentSerial);
 }

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

@@ -7,32 +7,43 @@
 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> {
 
     /**
-     * Query based on the device serial number.
+     * Query that retrieves a list of {@link ComponentResult} objects based on the device serial number.
      *
      * @param boardSerialNumber variable holding the device serial number
-     * @return a list of component result.
+     * @return a list of {@link ComponentResult} objects
      */
     List<ComponentResult> findByBoardSerialNumber(String boardSerialNumber);
 
     /**
-     * Query based on the device serial number.
+     * Query that retrieves a list of {@link ComponentResult} objects based on the device serial number and a boolean
+     * value.
      *
      * @param boardSerialNumber variable holding the device serial number
      * @param delta             flag indicating if the component is associated with a delta certificate
-     * @return a list of component result.
+     * @return a list of {@link ComponentResult} objects
      */
     List<ComponentResult> findByBoardSerialNumberAndDelta(String boardSerialNumber, boolean delta);
 
     /**
-     * Query based on certificate serial number and device serial number.
+     * Query that retrieves a list of {@link ComponentResult} objects based on certificate serial number
+     * and device serial number.
      *
      * @param certificateSerialNumber certificate specific serial number
      * @param boardSerialNumber       variable holding the device serial number
-     * @return a list of component result.
+     * @return a list of {@link ComponentResult} objects
      */
     List<ComponentResult> findByCertificateSerialNumberAndBoardSerialNumber(
             String certificateSerialNumber, String boardSerialNumber);

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

@@ -6,13 +6,22 @@
 
 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> {
     /**
-     * Query that retrieves a device using the provided device name.
+     * Query that retrieves a {@link Device} object using the provided device name.
      *
      * @param deviceName device name
-     * @return a device
+     * @return a {@link Device} object
      */
     Device findByName(String deviceName);
 }

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

@@ -6,14 +6,23 @@
 
 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> {
 
     /**
-     * Query that retrieves policy settings using the provided name.
+     * Query that retrieves a {@link PolicySettings} object using the provided name.
      *
      * @param name name
-     * @return policy settings
+     * @return a {@link PolicySettings} object
      */
     PolicySettings findByName(String name);
 }

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

@@ -7,55 +7,48 @@
 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> {
 
     /**
-     * Query that retrieves a list of reference digest values using the provided model.
-     *
-     * @param model string representation of the model
-     * @return a list of reference digest values
-     */
-    List<ReferenceDigestValue> findByModel(String model);
-
-    /**
-     * Query that retrieves a list of reference digest values using the provided manufacturer.
-     *
-     * @param manufacturer string representation of the manufacturer
-     * @return a list of reference digest values
-     */
-    List<ReferenceDigestValue> findByManufacturer(String manufacturer);
-
-    /**
-     * Query that retrieves a list of reference digest values using the provided associated rim id.
+     * Query that retrieves a list of {@link ReferenceDigestValue} objects using the provided associated rim id.
      *
      * @param associatedRimId uuid representation of the associated rim ID
-     * @return a list of reference digest values
+     * @return a list of {@link ReferenceDigestValue} objects
      */
     List<ReferenceDigestValue> findValuesByBaseRimId(UUID associatedRimId);
 
     /**
-     * Query that retrieves a list of reference digest values using the provided support rim id.
+     * Query that retrieves a list of {@link ReferenceDigestValue} objects using the provided support rim id.
      *
      * @param supportRimId uuid representation of the support rim ID
-     * @return a list of reference digest values
+     * @return a list of {@link ReferenceDigestValue} objects
      */
     List<ReferenceDigestValue> findBySupportRimId(UUID supportRimId);
 
     /**
-     * Query that retrieves a list of reference digest values using the provided support rim hash.
+     * Query that retrieves a list of {@link ReferenceDigestValue} objects using the provided support rim hash.
      *
      * @param supportRimHash a string representation of the support rim hash
-     * @return a list of reference digest values
+     * @return a list of {@link ReferenceDigestValue} objects
      */
     List<ReferenceDigestValue> findBySupportRimHash(String supportRimHash);
 
     /**
-     * Query that retrieves a list of reference digest values using the provided manufacturer and model.
+     * Query that retrieves a list of {@link ReferenceDigestValue} objects using the provided manufacturer and model.
      *
      * @param manufacturer string representation of the manufacturer
      * @param model        string representation of the model
-     * @return a list of reference digest values
+     * @return a list of {@link ReferenceDigestValue} objects
      */
     List<ReferenceDigestValue> findByManufacturerAndModel(String manufacturer, String model);
 }