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/08/04 18:47:18 UTC
[sling-org-apache-sling-commons-crypto] 01/05: add javadoc for
implementations
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 63c8b8c354db848024b9f9260e841243a406da75
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Wed Aug 4 20:30:06 2021 +0200
add javadoc for implementations
---
checkstyle-suppressions.xml | 1 -
.../commons/crypto/internal/EnvironmentVariablePasswordProvider.java | 5 +++++
.../apache/sling/commons/crypto/internal/FilePasswordProvider.java | 5 +++++
.../apache/sling/commons/crypto/internal/PbeSecretKeyProvider.java | 5 +++++
.../sling/commons/crypto/internal/SecureRandomSaltProvider.java | 5 +++++
.../crypto/jasypt/internal/JasyptRandomIvGeneratorRegistrar.java | 5 +++++
.../crypto/jasypt/internal/JasyptRandomSaltGeneratorRegistrar.java | 5 +++++
.../crypto/jasypt/internal/JasyptStandardPbeStringCryptoService.java | 5 +++++
.../commons/crypto/webconsole/internal/EncryptWebConsolePlugin.java | 3 +++
9 files changed, 38 insertions(+), 1 deletion(-)
diff --git a/checkstyle-suppressions.xml b/checkstyle-suppressions.xml
index e509a28..a54bb7a 100644
--- a/checkstyle-suppressions.xml
+++ b/checkstyle-suppressions.xml
@@ -19,7 +19,6 @@
-->
<!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"/>
<suppress checks="MissingJavadocMethod" files=".*\/internal\/.*\.java"/>
<suppress checks="MultipleStringLiterals" files=".*\/EncryptWebConsolePlugin\.java"/>
<suppress checks="ReturnCount" files=".*\/EncryptWebConsolePlugin\.java"/>
diff --git a/src/main/java/org/apache/sling/commons/crypto/internal/EnvironmentVariablePasswordProvider.java b/src/main/java/org/apache/sling/commons/crypto/internal/EnvironmentVariablePasswordProvider.java
index 38bb213..92e830f 100644
--- a/src/main/java/org/apache/sling/commons/crypto/internal/EnvironmentVariablePasswordProvider.java
+++ b/src/main/java/org/apache/sling/commons/crypto/internal/EnvironmentVariablePasswordProvider.java
@@ -31,6 +31,11 @@ import org.osgi.service.metatype.annotations.Designate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * Provider of passwords from environment variables.
+ *
+ * @see System#getenv(String)
+ */
@Component(
property = {
Constants.SERVICE_DESCRIPTION + "=Apache Sling Commons Crypto – Environment Variable Password Provider",
diff --git a/src/main/java/org/apache/sling/commons/crypto/internal/FilePasswordProvider.java b/src/main/java/org/apache/sling/commons/crypto/internal/FilePasswordProvider.java
index 24ccc3b..78c5074 100644
--- a/src/main/java/org/apache/sling/commons/crypto/internal/FilePasswordProvider.java
+++ b/src/main/java/org/apache/sling/commons/crypto/internal/FilePasswordProvider.java
@@ -37,6 +37,11 @@ import org.osgi.service.metatype.annotations.Designate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * Provider of passwords from files.
+ *
+ * @see File
+ */
@Component(
property = {
Constants.SERVICE_DESCRIPTION + "=Apache Sling Commons Crypto – File Password Provider",
diff --git a/src/main/java/org/apache/sling/commons/crypto/internal/PbeSecretKeyProvider.java b/src/main/java/org/apache/sling/commons/crypto/internal/PbeSecretKeyProvider.java
index e1f62da..226b750 100644
--- a/src/main/java/org/apache/sling/commons/crypto/internal/PbeSecretKeyProvider.java
+++ b/src/main/java/org/apache/sling/commons/crypto/internal/PbeSecretKeyProvider.java
@@ -41,6 +41,11 @@ import org.osgi.service.metatype.annotations.Designate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * Provider of secret keys to use with password-based encryption (PBE).
+ *
+ * @see PBEKeySpec
+ */
@Component(
property = {
Constants.SERVICE_DESCRIPTION + "=Apache Sling Commons Crypto – PBE SecretKey Provider",
diff --git a/src/main/java/org/apache/sling/commons/crypto/internal/SecureRandomSaltProvider.java b/src/main/java/org/apache/sling/commons/crypto/internal/SecureRandomSaltProvider.java
index 9f2a206..a8ad8a9 100644
--- a/src/main/java/org/apache/sling/commons/crypto/internal/SecureRandomSaltProvider.java
+++ b/src/main/java/org/apache/sling/commons/crypto/internal/SecureRandomSaltProvider.java
@@ -33,6 +33,11 @@ import org.osgi.service.metatype.annotations.Designate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * Provider of salts created from <code>SecureRandom</code>.
+ *
+ * @see SecureRandom
+ */
@Component(
property = {
Constants.SERVICE_DESCRIPTION + "=Apache Sling Commons Crypto – SecureRandom Salt Provider",
diff --git a/src/main/java/org/apache/sling/commons/crypto/jasypt/internal/JasyptRandomIvGeneratorRegistrar.java b/src/main/java/org/apache/sling/commons/crypto/jasypt/internal/JasyptRandomIvGeneratorRegistrar.java
index 8c0c771..7cc1b9b 100644
--- a/src/main/java/org/apache/sling/commons/crypto/jasypt/internal/JasyptRandomIvGeneratorRegistrar.java
+++ b/src/main/java/org/apache/sling/commons/crypto/jasypt/internal/JasyptRandomIvGeneratorRegistrar.java
@@ -34,6 +34,11 @@ import org.osgi.service.metatype.annotations.Designate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * Registrar for Jasypt Random IV Generator.<br>Registers a <code>RandomIvGenerator</code> as OSGi Service.
+ *
+ * @see RandomIvGenerator
+ */
@Component(
property = {
Constants.SERVICE_DESCRIPTION + "=Apache Sling Commons Crypto – Jasypt Random IV Generator Registrar",
diff --git a/src/main/java/org/apache/sling/commons/crypto/jasypt/internal/JasyptRandomSaltGeneratorRegistrar.java b/src/main/java/org/apache/sling/commons/crypto/jasypt/internal/JasyptRandomSaltGeneratorRegistrar.java
index ad5b14d..87cb1c3 100644
--- a/src/main/java/org/apache/sling/commons/crypto/jasypt/internal/JasyptRandomSaltGeneratorRegistrar.java
+++ b/src/main/java/org/apache/sling/commons/crypto/jasypt/internal/JasyptRandomSaltGeneratorRegistrar.java
@@ -34,6 +34,11 @@ import org.osgi.service.metatype.annotations.Designate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * Registrar for Jasypt Random Salt Generator.<br>Registers a <code>RandomSaltGenerator</code> as OSGi Service.
+ *
+ * @see RandomSaltGenerator
+ */
@Component(
property = {
Constants.SERVICE_DESCRIPTION + "=Apache Sling Commons Crypto – Jasypt Random Salt Generator Registrar",
diff --git a/src/main/java/org/apache/sling/commons/crypto/jasypt/internal/JasyptStandardPbeStringCryptoService.java b/src/main/java/org/apache/sling/commons/crypto/jasypt/internal/JasyptStandardPbeStringCryptoService.java
index e021bfd..bb2a714 100644
--- a/src/main/java/org/apache/sling/commons/crypto/jasypt/internal/JasyptStandardPbeStringCryptoService.java
+++ b/src/main/java/org/apache/sling/commons/crypto/jasypt/internal/JasyptStandardPbeStringCryptoService.java
@@ -41,6 +41,11 @@ import org.osgi.service.metatype.annotations.Designate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * Service for encrypting messages and decrypting ciphertexts using Jasypt's <code>StandardPBEStringEncryptor</code>.
+ *
+ * @see StandardPBEStringEncryptor
+ */
@Component(
property = {
Constants.SERVICE_DESCRIPTION + "=Apache Sling Commons Crypto – Jasypt Standard PBE String Crypto Service",
diff --git a/src/main/java/org/apache/sling/commons/crypto/webconsole/internal/EncryptWebConsolePlugin.java b/src/main/java/org/apache/sling/commons/crypto/webconsole/internal/EncryptWebConsolePlugin.java
index fe97773..801c79f 100644
--- a/src/main/java/org/apache/sling/commons/crypto/webconsole/internal/EncryptWebConsolePlugin.java
+++ b/src/main/java/org/apache/sling/commons/crypto/webconsole/internal/EncryptWebConsolePlugin.java
@@ -42,6 +42,9 @@ import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Deactivate;
import org.osgi.util.tracker.ServiceTracker;
+/**
+ * Web Console plugin to encrypt messages.
+ */
@Component(
service = Servlet.class,
property = {