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/07/13 20:29:14 UTC
[sling-org-apache-sling-commons-crypto] 03/13: [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-crypto.git
commit 8d2faf20b9e5ea3334c96ecdf6c8409a778573d0
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Tue Jul 13 21:30:50 2021 +0200
[checkstyle] (javadoc) MissingJavadocType
---
checkstyle-suppressions.xml | 1 +
src/main/java/org/apache/sling/commons/crypto/CryptoService.java | 3 +++
src/main/java/org/apache/sling/commons/crypto/PasswordProvider.java | 5 +++++
src/main/java/org/apache/sling/commons/crypto/SaltProvider.java | 5 +++++
src/main/java/org/apache/sling/commons/crypto/SecretKeyProvider.java | 5 +++++
5 files changed, 19 insertions(+)
diff --git a/checkstyle-suppressions.xml b/checkstyle-suppressions.xml
index d6277ee..df53a17 100644
--- a/checkstyle-suppressions.xml
+++ b/checkstyle-suppressions.xml
@@ -19,4 +19,5 @@
-->
<!DOCTYPE suppressions PUBLIC "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN" "https://checkstyle.org/dtds/suppressions_1_2.dtd">
<suppressions>
+ <suppress checks="MissingJavadocType" files=".*\/internal\/.*\.java"/>
</suppressions>
diff --git a/src/main/java/org/apache/sling/commons/crypto/CryptoService.java b/src/main/java/org/apache/sling/commons/crypto/CryptoService.java
index aa4b424..e16ebe7 100644
--- a/src/main/java/org/apache/sling/commons/crypto/CryptoService.java
+++ b/src/main/java/org/apache/sling/commons/crypto/CryptoService.java
@@ -21,6 +21,9 @@ package org.apache.sling.commons.crypto;
import org.jetbrains.annotations.NotNull;
import org.osgi.annotation.versioning.ProviderType;
+/**
+ * Service for encrypting messages and decrypting ciphertexts.
+ */
@ProviderType
public interface CryptoService {
diff --git a/src/main/java/org/apache/sling/commons/crypto/PasswordProvider.java b/src/main/java/org/apache/sling/commons/crypto/PasswordProvider.java
index 095ce31..999aaf0 100644
--- a/src/main/java/org/apache/sling/commons/crypto/PasswordProvider.java
+++ b/src/main/java/org/apache/sling/commons/crypto/PasswordProvider.java
@@ -21,6 +21,11 @@ package org.apache.sling.commons.crypto;
import org.jetbrains.annotations.NotNull;
import org.osgi.annotation.versioning.ProviderType;
+/**
+ * Provider of passwords to use for example with password-based encryption (PBE).
+ *
+ * @see javax.crypto.spec.PBEKeySpec
+ */
@ProviderType
public interface PasswordProvider {
diff --git a/src/main/java/org/apache/sling/commons/crypto/SaltProvider.java b/src/main/java/org/apache/sling/commons/crypto/SaltProvider.java
index 5b63b8e..835cdbc 100644
--- a/src/main/java/org/apache/sling/commons/crypto/SaltProvider.java
+++ b/src/main/java/org/apache/sling/commons/crypto/SaltProvider.java
@@ -21,6 +21,11 @@ package org.apache.sling.commons.crypto;
import org.jetbrains.annotations.NotNull;
import org.osgi.annotation.versioning.ProviderType;
+/**
+ * Provider of salts to use for example with password-based encryption (PBE).
+ *
+ * @see javax.crypto.spec.PBEKeySpec
+ */
@ProviderType
public interface SaltProvider {
diff --git a/src/main/java/org/apache/sling/commons/crypto/SecretKeyProvider.java b/src/main/java/org/apache/sling/commons/crypto/SecretKeyProvider.java
index e8f6a02..b6acba0 100644
--- a/src/main/java/org/apache/sling/commons/crypto/SecretKeyProvider.java
+++ b/src/main/java/org/apache/sling/commons/crypto/SecretKeyProvider.java
@@ -23,6 +23,11 @@ import javax.crypto.SecretKey;
import org.jetbrains.annotations.NotNull;
import org.osgi.annotation.versioning.ProviderType;
+/**
+ * Provider of secret keys for encryption and decryption.
+ *
+ * @see javax.crypto.SecretKey
+ */
@ProviderType
public interface SecretKeyProvider {