diff --git a/acme4j-client/src/main/java/org/shredzone/acme4j/Account.java b/acme4j-client/src/main/java/org/shredzone/acme4j/Account.java index 53ffe9a2..5df7326d 100644 --- a/acme4j-client/src/main/java/org/shredzone/acme4j/Account.java +++ b/acme4j-client/src/main/java/org/shredzone/acme4j/Account.java @@ -80,6 +80,9 @@ public class Account extends AcmeJsonResource { /** * Returns the current status of the account. + *
+ * Possible values are: {@link Status#VALID}, {@link Status#DEACTIVATED}, + * {@link Status#REVOKED}. */ public Status getStatus() { return getJSON().get(KEY_STATUS).asStatusOrElse(Status.UNKNOWN); diff --git a/acme4j-client/src/main/java/org/shredzone/acme4j/Authorization.java b/acme4j-client/src/main/java/org/shredzone/acme4j/Authorization.java index 1a31b6d5..c19c2f47 100644 --- a/acme4j-client/src/main/java/org/shredzone/acme4j/Authorization.java +++ b/acme4j-client/src/main/java/org/shredzone/acme4j/Authorization.java @@ -60,9 +60,12 @@ public class Authorization extends AcmeJsonResource { /** * Gets the authorization status. + *
+ * Possible values are: {@link Status#PENDING}, {@link Status#VALID}, + * {@link Status#INVALID}, {@link Status#DEACTIVATED}, {@link Status#REVOKED}. */ public Status getStatus() { - return getJSON().get("status").asStatusOrElse(Status.PENDING); + return getJSON().get("status").asStatusOrElse(Status.UNKNOWN); } /** diff --git a/acme4j-client/src/main/java/org/shredzone/acme4j/Order.java b/acme4j-client/src/main/java/org/shredzone/acme4j/Order.java index fb648ed8..9583ae8e 100644 --- a/acme4j-client/src/main/java/org/shredzone/acme4j/Order.java +++ b/acme4j-client/src/main/java/org/shredzone/acme4j/Order.java @@ -40,6 +40,9 @@ public class Order extends AcmeJsonResource { /** * Returns the current status of the order. + *
+ * Possible values are: {@link Status#PENDING}, {@link Status#READY}, + * {@link Status#PROCESSING}, {@link Status#VALID}, {@link Status#INVALID}. */ public Status getStatus() { return getJSON().get("status").asStatusOrElse(Status.UNKNOWN); diff --git a/acme4j-client/src/main/java/org/shredzone/acme4j/Status.java b/acme4j-client/src/main/java/org/shredzone/acme4j/Status.java index a87ff9f0..d6bee2ae 100644 --- a/acme4j-client/src/main/java/org/shredzone/acme4j/Status.java +++ b/acme4j-client/src/main/java/org/shredzone/acme4j/Status.java @@ -20,7 +20,53 @@ import java.util.Arrays; */ public enum Status { - PENDING, PROCESSING, VALID, INVALID, REVOKED, DEACTIVATED, UNKNOWN; + /** + * The server has created the resource, and is waiting for the client to process it. + */ + PENDING, + + /** + * The {@link Order} is ready to be finalized. Invoke {@link Order#execute(byte[])}. + */ + READY, + + /** + * The server is processing the resource. The client should invoke + * {@link AcmeJsonResource#update()} and re-check the status. + */ + PROCESSING, + + /** + * The resource is valid and can be used as intended. + */ + VALID, + + /** + * An error or authorization/validation failure has occured. The client should check + * for error messages. + */ + INVALID, + + /** + * The {@link Authorization} has been revoked by the server. + */ + REVOKED, + + /** + * The {@link Account} or {@link Authorization} has been deactivated by the client. + */ + DEACTIVATED, + + /** + * The {@link Authorization} is expired. + */ + EXPIRED, + + /** + * The server did not provide a status, or the provided status is not a specified ACME + * status. + */ + UNKNOWN; /** * Parses the string and returns a corresponding Status object. diff --git a/acme4j-client/src/main/java/org/shredzone/acme4j/challenge/Challenge.java b/acme4j-client/src/main/java/org/shredzone/acme4j/challenge/Challenge.java index 31c63f91..b59ddc36 100644 --- a/acme4j-client/src/main/java/org/shredzone/acme4j/challenge/Challenge.java +++ b/acme4j-client/src/main/java/org/shredzone/acme4j/challenge/Challenge.java @@ -68,6 +68,9 @@ public class Challenge extends AcmeJsonResource { /** * Returns the current status of the challenge. + *
+ * Possible values are: {@link Status#PENDING}, {@link Status#PROCESSING}, + * {@link Status#VALID}, {@link Status#INVALID}. */ public Status getStatus() { return getJSON().get(KEY_STATUS).asStatusOrElse(Status.UNKNOWN);