Mark ARI related methods as draft

pull/145/head
Richard Körber 2023-10-11 07:17:59 +02:00
parent 78d73d96aa
commit e041decf48
No known key found for this signature in database
GPG Key ID: AAB9FD19C78AA3E0
3 changed files with 22 additions and 0 deletions

View File

@ -222,6 +222,9 @@ public class Certificate extends AcmeResource {
* Returns the location of the certificate's RenewalInfo. Empty if the CA does not
* provide this information.
*
* @draft This method is currently based on an RFC draft. It may be changed or
* removed without notice to reflect future changes to the draft. SemVer rules
* do not apply here.
* @since 3.0.0
*/
public Optional<URL> getRenewalInfoLocation() {
@ -247,6 +250,9 @@ public class Certificate extends AcmeResource {
/**
* Returns {@code true} if the CA provides renewal information.
*
* @draft This method is currently based on an RFC draft. It may be changed or
* removed without notice to reflect future changes to the draft. SemVer rules
* do not apply here.
* @since 3.0.0
*/
public boolean hasRenewalInfo() {
@ -256,6 +262,9 @@ public class Certificate extends AcmeResource {
/**
* Reads the RenewalInfo for this certificate.
*
* @draft This method is currently based on an RFC draft. It may be changed or
* removed without notice to reflect future changes to the draft. SemVer rules
* do not apply here.
* @return The {@link RenewalInfo} of this certificate.
* @since 3.0.0
*/
@ -276,6 +285,9 @@ public class Certificate extends AcmeResource {
* (see {@link #hasRenewalInfo()}. An {@link AcmeNotSupportedException} is thrown
* otherwise.
*
* @draft This method is currently based on an RFC draft. It may be changed or
* removed without notice to reflect future changes to the draft. SemVer rules
* do not apply here.
* @since 3.1.0
*/
public void markAsReplaced() throws AcmeException {

View File

@ -30,6 +30,9 @@ import org.slf4j.LoggerFactory;
/**
* Renewal Information of a certificate.
*
* @draft This class is currently based on an RFC draft. It may be changed or
* removed without notice to reflect future changes to the draft. SemVer rules
* do not apply here.
* @since 3.0.0
*/
public class RenewalInfo extends AcmeJsonResource {

View File

@ -154,6 +154,13 @@
<doclint>syntax,reference</doclint>
<linksource>true</linksource>
<locale>en</locale>
<tags>
<tag>
<name>draft</name>
<placement>a</placement>
<head>Draft:</head>
</tag>
</tags>
</configuration>
</plugin>
<plugin>