You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ol...@apache.org on 2021/09/09 15:22:46 UTC
[sling-org-apache-sling-commons-clam] 06/25: [checkstyle] (javadoc)
MissingJavadocType
This is an automated email from the ASF dual-hosted git repository.
olli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-commons-clam.git
commit c45fdee18f49eb729c059a8cb9adb580d01133f3
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Tue Aug 17 22:39:17 2021 +0200
[checkstyle] (javadoc) MissingJavadocType
---
src/main/java/org/apache/sling/commons/clam/ClamService.java | 3 +++
src/main/java/org/apache/sling/commons/clam/ScanResult.java | 6 ++++++
.../java/org/apache/sling/commons/clam/internal/ClamdService.java | 3 +++
3 files changed, 12 insertions(+)
diff --git a/src/main/java/org/apache/sling/commons/clam/ClamService.java b/src/main/java/org/apache/sling/commons/clam/ClamService.java
index 99f9680..eae268f 100644
--- a/src/main/java/org/apache/sling/commons/clam/ClamService.java
+++ b/src/main/java/org/apache/sling/commons/clam/ClamService.java
@@ -24,6 +24,9 @@ import java.io.InputStream;
import org.jetbrains.annotations.NotNull;
import org.osgi.annotation.versioning.ProviderType;
+/**
+ * Service to scan data for malware with ClamAV.
+ */
@ProviderType
public interface ClamService {
diff --git a/src/main/java/org/apache/sling/commons/clam/ScanResult.java b/src/main/java/org/apache/sling/commons/clam/ScanResult.java
index 27c9cad..4e57080 100644
--- a/src/main/java/org/apache/sling/commons/clam/ScanResult.java
+++ b/src/main/java/org/apache/sling/commons/clam/ScanResult.java
@@ -21,6 +21,9 @@ package org.apache.sling.commons.clam;
import org.jetbrains.annotations.NotNull;
import org.osgi.annotation.versioning.ProviderType;
+/**
+ * Scan result contains the message from Clam, the parsed status and additional metadata.
+ */
@ProviderType
public class ScanResult {
@@ -67,6 +70,9 @@ public class ScanResult {
return Status.OK.equals(status);
}
+ /**
+ * Status based on reply message from Clam (<code>OK</code>, <code>FOUND</code>, <code>ERROR</code>) or <code>UNKNOWN</code> if parsing reply message failed.
+ */
public enum Status {
OK,
FOUND,
diff --git a/src/main/java/org/apache/sling/commons/clam/internal/ClamdService.java b/src/main/java/org/apache/sling/commons/clam/internal/ClamdService.java
index 9753126..e03293f 100644
--- a/src/main/java/org/apache/sling/commons/clam/internal/ClamdService.java
+++ b/src/main/java/org/apache/sling/commons/clam/internal/ClamdService.java
@@ -46,6 +46,9 @@ import org.osgi.service.metatype.annotations.Designate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * Service for scanning data with Clam daemon.<br>Connections are established via TCP/IP.
+ */
@Component(
property = {
Constants.SERVICE_DESCRIPTION + "=Sling Commons Clamd Service",