mirrors/acme4j
1
0
Fork 0
mirror of https://github.com/shred/acme4j.git synced 2025-12-13 11:14:02 +08:00
Code Issues Packages Projects Releases Wiki Activity

Review and extend JavaDocs

Browse Source
This commit is contained in:
Richard Körber
2023-04-29 14:48:56 +02:00
parent 41bc574f75
commit 09a72d606b
56 changed files with 429 additions and 182 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
acme4j-smime/src/main/java/module-info.java
View File

@@ -12,6 +12,9 @@
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/
/**
* This module is an add-on that provides S/MIME certificate features.
*/
module org.shredzone.acme4j.smime {
requires org.shredzone.acme4j;
requires org.shredzone.acme4j.utils;

3
acme4j-smime/src/main/java/org/shredzone/acme4j/smime/challenge/EmailReply00ChallengeProvider.java
View File

@@ -20,7 +20,8 @@ import org.shredzone.acme4j.provider.ChallengeType;
import org.shredzone.acme4j.toolbox.JSON;
/**
* Generates {@link EmailReply00Challenge}.
* A provider that generates {@link EmailReply00Challenge}. It is registered as Java
* service.
*
* @since 2.12
*/

9
acme4j-smime/src/main/java/org/shredzone/acme4j/smime/challenge/package-info.java
View File

@@ -12,6 +12,15 @@
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/
/**
* This package contains the
* {@link org.shredzone.acme4j.smime.challenge.EmailReply00Challenge#TYPE} related acme4j
* {@link org.shredzone.acme4j.challenge.Challenge} implementation.
* <p>
* The {@link org.shredzone.acme4j.smime.challenge.EmailReply00ChallengeProvider} is
* registered as Java service, so acme4j is able to automatically generate
* {@link org.shredzone.acme4j.smime.challenge.EmailReply00Challenge} instances.
*/
@ReturnValuesAreNonnullByDefault
@DefaultAnnotationForParameters(NonNull.class)
@DefaultAnnotationForFields(NonNull.class)

3
acme4j-smime/src/main/java/org/shredzone/acme4j/smime/csr/package-info.java
View File

@@ -12,6 +12,9 @@
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/
/**
* This package contains S/MIME CSR related utility classes.
*/
@ReturnValuesAreNonnullByDefault
@DefaultAnnotationForParameters(NonNull.class)
@DefaultAnnotationForFields(NonNull.class)

4
acme4j-smime/src/main/java/org/shredzone/acme4j/smime/email/package-info.java
View File

@@ -12,6 +12,10 @@
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/
/**
* This package contains classes for processing incoming validation emails, and for
* generating outgoing response emails.
*/
@ReturnValuesAreNonnullByDefault
@DefaultAnnotationForParameters(NonNull.class)
@DefaultAnnotationForFields(NonNull.class)

8
acme4j-smime/src/main/java/org/shredzone/acme4j/smime/exception/AcmeInvalidMessageException.java
View File

@@ -25,12 +25,12 @@ import org.bouncycastle.i18n.LocalizedException;
import org.shredzone.acme4j.exception.AcmeException;
/**
* This exception is thrown when the challenge message is invalid.
* This exception is thrown when the challenge email message is invalid.
* <p>
* If this exception is thrown, the challenge message does not match the actual challenge,
* and <em>must</em> be rejected.
* If this exception is thrown, the challenge message does not match the actual challenge
* or has other issues. It <em>must</em> be rejected.
* <p>
* Reasons may be:
* Reasons may be (for example):
* <ul>
* <li>Unexpected sender address</li>
* <li>Bad S/MIME signature</li>

3
acme4j-smime/src/main/java/org/shredzone/acme4j/smime/exception/package-info.java
View File

@@ -12,6 +12,9 @@
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/
/**
* Exceptions that are related to S/MIME signatures.
*/
@ReturnValuesAreNonnullByDefault
@DefaultAnnotationForParameters(NonNull.class)
@DefaultAnnotationForFields(NonNull.class)

3
acme4j-smime/src/main/java/org/shredzone/acme4j/smime/package-info.java
View File

@@ -12,6 +12,9 @@
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/
/**
* An acme4j extension that provides S/MIME certificate features.
*/
@ReturnValuesAreNonnullByDefault
@DefaultAnnotationForParameters(NonNull.class)
@DefaultAnnotationForFields(NonNull.class)

8
acme4j-smime/src/main/java/org/shredzone/acme4j/smime/wrapper/package-info.java
View File

@@ -12,6 +12,14 @@
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/
/**
* {@link org.shredzone.acme4j.smime.wrapper.Mail} is a wrapper interface which provides
* access to all relevant headers of the validation email. Usually
* {@link org.shredzone.acme4j.smime.wrapper.SignedMailBuilder} is used for parsing the
* email and validating the signature.
* {@link org.shredzone.acme4j.smime.wrapper.SimpleMail} is a simple implementation that
* should only be used for testing purposes or after an external validation.
*/
@ReturnValuesAreNonnullByDefault
@DefaultAnnotationForParameters(NonNull.class)
@DefaultAnnotationForFields(NonNull.class)