Fix more checkstyle warnings

uyuni-project · Sep 1, 2023 · 136d710 · 136d710
1 parent 991e590
commit 136d710
Show file tree

Hide file tree

Showing 33 changed files with 237 additions and 218 deletions.
diff --git a/java/code/src/com/redhat/rhn/frontend/xmlrpc/audit/CVEAuditHandler.java b/java/code/src/com/redhat/rhn/frontend/xmlrpc/audit/CVEAuditHandler.java
@@ -110,12 +110,17 @@ public List<CVEAuditServer> listSystemsByPatchStatus(User loggedInUser,
             }
         }
 
-        List<CVEAuditServer> result = CVEAuditManagerOVAL.listSystemsByPatchStatus(
-                loggedInUser, cveIdentifier, patchStatuses);
+        try {
+            List<CVEAuditServer> result = CVEAuditManagerOVAL.listSystemsByPatchStatus(
+                    loggedInUser, cveIdentifier, patchStatuses);
 
-        result.sort(Comparator.comparingInt(s -> s.getPatchStatus().getRank()));
+            result.sort(Comparator.comparingInt(s -> s.getPatchStatus().getRank()));
 
-        return result;
+            return result;
+        }
+        catch (UnknownCVEIdentifierException e) {
+            throw new UnknownCVEIdentifierFaultException();
+        }
     }
 
     /**

diff --git a/java/code/src/com/redhat/rhn/manager/audit/CVEAuditManagerOVAL.java b/java/code/src/com/redhat/rhn/manager/audit/CVEAuditManagerOVAL.java
@@ -46,13 +46,28 @@
  *
  */
 public class CVEAuditManagerOVAL {
-    private static Logger LOG = LogManager.getLogger(CVEAuditManagerOVAL.class);
+
+    private static final Logger LOG = LogManager.getLogger(CVEAuditManagerOVAL.class);
+
+    private CVEAuditManagerOVAL() {
+
+    }
 
     /**
+     * List visible systems with their patch status regarding a given CVE identifier.
      *
-     * */
+     * @param user the calling user
+     * @param cveIdentifier the CVE identifier to lookup
+     * @param patchStatuses the patch statuses
+     * @return list of system records with patch status
+     * @throws UnknownCVEIdentifierException if the CVE number is not known
+     */
     public static List<CVEAuditServer> listSystemsByPatchStatus(User user, String cveIdentifier,
-                                                                EnumSet<PatchStatus> patchStatuses) {
+                                                                EnumSet<PatchStatus> patchStatuses)
+            throws UnknownCVEIdentifierException {
+        if (CVEAuditManager.isCVEIdentifierUnknown(cveIdentifier)) {
+            throw new UnknownCVEIdentifierException();
+        }
 
         List<CVEAuditServer> result = new ArrayList<>();
 
@@ -75,7 +90,8 @@ public static List<CVEAuditServer> listSystemsByPatchStatus(User user, String cv
                     CVEAuditManager.doAuditSystem(clientServer.getId(), resultsBySystem.get(clientServer.getId()));
 
             if (doesSupportOVALAuditing(clientServer)) {
-                systemAuditResult = doAuditSystem(cveIdentifier, resultsBySystem.get(clientServer.getId()), clientServer);
+                systemAuditResult = doAuditSystem(cveIdentifier, resultsBySystem.get(clientServer.getId()),
+                        clientServer);
                 systemAuditResult.setChannels(auditWithChannelsResult.getChannels());
                 systemAuditResult.setErratas(auditWithChannelsResult.getErratas());
             }

diff --git a/java/code/src/com/redhat/rhn/manager/audit/test/CVEAuditManagerTest.java b/java/code/src/com/redhat/rhn/manager/audit/test/CVEAuditManagerTest.java
@@ -333,11 +333,13 @@ public void testFindAllTargetProducts() throws Exception {
     public void testSetPatchStatus() {
         assertEquals(PatchStatus.PATCHED, CVEAuditManager.getPatchStatus(true, true, true, false));
         assertEquals(PatchStatus.PATCHED, CVEAuditManager.getPatchStatus(true, false, true, false));
-        assertEquals(PatchStatus.AFFECTED_FULL_PATCH_APPLICABLE, CVEAuditManager.getPatchStatus(false, true, true, false));
+        assertEquals(PatchStatus.AFFECTED_FULL_PATCH_APPLICABLE,
+                CVEAuditManager.getPatchStatus(false, true, true, false));
         assertEquals(PatchStatus.AFFECTED_PATCH_INAPPLICABLE,
                 CVEAuditManager.getPatchStatus(false, false, true, false));
         assertEquals(PatchStatus.NOT_AFFECTED, CVEAuditManager.getPatchStatus(false, false, false, false));
-        assertEquals(PatchStatus.AFFECTED_FULL_PATCH_APPLICABLE, CVEAuditManager.getPatchStatus(false, true, true, true));
+        assertEquals(PatchStatus.AFFECTED_FULL_PATCH_APPLICABLE,
+                CVEAuditManager.getPatchStatus(false, true, true, true));
         assertEquals(PatchStatus.AFFECTED_PATCH_INAPPLICABLE_SUCCESSOR_PRODUCT,
                 CVEAuditManager.getPatchStatus(false, false, true, true));
     }

diff --git a/java/code/src/com/suse/manager/webui/controllers/CVEAuditController.java b/java/code/src/com/suse/manager/webui/controllers/CVEAuditController.java
@@ -48,6 +48,7 @@
 import java.util.Set;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
+
 import spark.ModelAndView;
 import spark.Request;
 import spark.Response;

diff --git a/java/code/src/com/suse/oval/OsFamily.java b/java/code/src/com/suse/oval/OsFamily.java
@@ -36,16 +36,4 @@ public enum OsFamily {
     OsFamily(String fullnameIn, String vendorIn) {
         this(fullnameIn, fullnameIn.toLowerCase(), vendorIn);
     }
-
-    public String fullname() {
-        return fullname;
-    }
-
-    public String shortname() {
-        return shortname;
-    }
-
-    public String vendor() {
-        return vendor;
-    }
 }
diff --git a/java/code/src/com/suse/oval/ShallowSystemPackage.java b/java/code/src/com/suse/oval/ShallowSystemPackage.java
@@ -75,16 +75,16 @@ public String getName() {
         return name;
     }
 
-    public void setName(String name) {
-        this.name = name;
+    public void setName(String nameIn) {
+        this.name = nameIn;
     }
 
     public String getEvr() {
         return evr;
     }
 
-    public void setEvr(String evr) {
-        this.evr = evr;
+    public void setEvr(String evrIn) {
+        this.evr = evrIn;
     }
 
     /**

diff --git a/java/code/src/com/suse/oval/cpe/Cpe.java b/java/code/src/com/suse/oval/cpe/Cpe.java
@@ -37,6 +37,11 @@ public Cpe() {
         update = "";
     }
 
+    /**
+     * Gets the vendor value or empty if not set
+     *
+     * @return the vendor value or an empty string if not set
+     * */
     public String getVendor() {
         return vendor;
     }
@@ -47,6 +52,11 @@ void setVendor(String vendorIn) {
         }
     }
 
+    /**
+     * Gets the product value or empty if not set
+     *
+     * @return the product value or an empty string if not set
+     * */
     public String getProduct() {
         return product;
     }
@@ -57,6 +67,11 @@ void setProduct(String productIn) {
         }
     }
 
+    /**
+     * Gets the version value or empty if not set
+     *
+     * @return the version value or an empty string if not set
+     * */
     public String getVersion() {
         return version;
     }
@@ -67,6 +82,11 @@ void setVersion(String versionIn) {
         }
     }
 
+    /**
+     * Gets the update value or empty if not set
+     *
+     * @return the update value or an empty string if not set
+     * */
     public String getUpdate() {
         return update;
     }
@@ -77,10 +97,20 @@ void setUpdate(String updateIn) {
         }
     }
 
+    /**
+     * Parse the given Cpe URI string and returns a {@link Cpe} object
+     *
+     * @return a cpe object with all the Cpe information
+     * */
     public static Cpe parse(String cpe) {
         return CPE_PARSER.parse(cpe);
     }
 
+    /**
+     * Converts and returns the Cpe as plain text URI
+     *
+     * @return the cpe as URI
+     * */
     public String asString() {
         String cpe = "cpe:/o:" + vendor + ":" + product + ":" + version + ":" + update;
 

diff --git a/java/code/src/com/suse/oval/cpe/CpeBuilder.java b/java/code/src/com/suse/oval/cpe/CpeBuilder.java
@@ -18,26 +18,55 @@
 public final class CpeBuilder {
     private final Cpe cpe = new Cpe();
 
+    /**
+     * Sets the vendor and returns {@code CpeBuilder} to continue building the {@link Cpe} object
+     *
+     * @param vendor the vendor to set
+     * @return the CpeBuilder to continue building the Cpe object
+     * */
     public CpeBuilder withVendor(String vendor) {
         cpe.setVendor(vendor);
         return this;
     }
 
+    /**
+     * Sets the product and returns {@code CpeBuilder} to continue building the {@link Cpe} object
+     *
+     * @param product the product to set
+     * @return the CpeBuilder to continue building the Cpe object
+     * */
     public CpeBuilder withProduct(String product) {
         cpe.setProduct(product);
         return this;
     }
 
+    /**
+     * Sets the version and returns {@code CpeBuilder} to continue building the {@link Cpe} object
+     *
+     * @param version the version to set
+     * @return the CpeBuilder to continue building the Cpe object
+     * */
     public CpeBuilder withVersion(String version) {
         cpe.setVersion(version);
         return this;
     }
 
+    /**
+     * Sets the update and returns {@code CpeBuilder} to continue building the {@link Cpe} object
+     *
+     * @param update the update value to set
+     * @return the CpeBuilder to continue building the Cpe object
+     * */
     public CpeBuilder withUpdate(String update) {
         cpe.setUpdate(update);
         return this;
     }
 
+    /**
+     * Builds the {@link Cpe} object
+     *
+     * @return the built cpe
+     * */
     public Cpe build() {
         return cpe;
     }

diff --git a/java/code/src/com/suse/oval/cpe/SimpleCpeParser.java b/java/code/src/com/suse/oval/cpe/SimpleCpeParser.java
@@ -27,7 +27,7 @@ public class SimpleCpeParser {
      * CPE: <b>cpe:/o:opensuse:leap:15.4</b>
      * <br>
      * PART: <b>o</b> <i>(it's an operating system's CPE)</i><br>
-     * VENDOR: <b>opensuse</b> <i>(CPE describes a product manufactured by openSUSE)<i/><br>
+     * VENDOR: <b>opensuse</b> <i>(CPE describes a product manufactured by openSUSE)</i><br>
      * PRODUCT: <b>leap</b> <i>(The product name is leap)</i><br>
      * VERSION: <b>15.4</b> <i>(The product version is 15.4)</i><br>
      * <br><br>

diff --git a/java/code/src/com/suse/oval/db/OVALPlatformVulnerablePackageKey.java b/java/code/src/com/suse/oval/db/OVALPlatformVulnerablePackageKey.java
@@ -16,6 +16,7 @@
 package com.suse.oval.db;
 
 import com.redhat.rhn.domain.errata.Cve;
+
 import org.apache.commons.lang3.builder.EqualsBuilder;
 import org.apache.commons.lang3.builder.HashCodeBuilder;
 

diff --git a/java/code/src/com/suse/oval/exceptions/OvalParserException.java b/java/code/src/com/suse/oval/exceptions/OvalParserException.java
@@ -15,19 +15,44 @@
 
 package com.suse.oval.exceptions;
 
+/**
+ * A runtime exception throne by {@link com.suse.oval.OvalParser} when it encounters errors while parsing an OVAL file
+ * */
 public class OvalParserException extends RuntimeException {
+
+    /**
+     * Constructs a new parser exception with null as its detail message. The cause is not initialized, and may
+     * subsequently be initialized by a call to initCause.
+     * */
     public OvalParserException() {
         super();
     }
 
+    /**
+     * Constructs a new parser exception with the specified detail message.
+     *
+     * @param message the detail message. The detail message is saved for later retrieval by the getMessage() method.
+     * */
+
     public OvalParserException(String message) {
         super(message);
     }
 
+    /**
+     * Constructs a new parser exception with the specified cause.
+     *
+     * @param cause the cause (which is saved for later retrieval by the getCause() method).
+     * */
     public OvalParserException(Throwable cause) {
         super(cause);
     }
 
+    /**
+     * Constructs a new parser exception with the specified detail message and cause.
+     *
+     * @param cause the cause (which is saved for later retrieval by the getCause() method).
+     * @param message the detail message. The detail message is saved for later retrieval by the getMessage() method.
+     * */
     public OvalParserException(String message, Throwable cause) {
         super(message, cause);
     }

diff --git a/java/code/src/com/suse/oval/manager/OvalObjectManager.java b/java/code/src/com/suse/oval/manager/OvalObjectManager.java
@@ -35,6 +35,9 @@ public OvalObjectManager(List<ObjectType> objects) {
 
     /**
      * Looks up an OVAL object with an id of {@code objectId}
+     *
+     * @param objectId the object id to look up
+     * @return the cached {@link ObjectType} object that correspond to the object id
      * */
     public ObjectType get(String objectId) {
         ObjectType object = objectsMap.get(objectId);
@@ -46,11 +49,7 @@ public ObjectType get(String objectId) {
     /**
      * Check if an OVAL object with an id of {@code objectId} exists
      * */
-    public boolean exists(String objectId) {
+    protected boolean exists(String objectId) {
         return objectsMap.containsKey(objectId);
     }
-
-    public void add(ObjectType objectType) {
-        objectsMap.put(objectType.getId(), objectType);
-    }
 }
diff --git a/java/code/src/com/suse/oval/ovaltypes/AdvisoryCveType.java b/java/code/src/com/suse/oval/ovaltypes/AdvisoryCveType.java
@@ -30,7 +30,7 @@ public String getCve() {
         return cve;
     }
 
-    public void setCve(String cve) {
-        this.cve = cve;
+    public void setCve(String cveIn) {
+        this.cve = cveIn;
     }
 }