Module org.shredzone.acme4j

Package org.shredzone.acme4j

Class Order

java.lang.Object

org.shredzone.acme4j.AcmeResource

org.shredzone.acme4j.AcmeJsonResource

org.shredzone.acme4j.Order

All Implemented Interfaces:

Serializable

public class Order
extends AcmeJsonResource

Represents a certificate order.

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Order(Login login, URL location)

Method Summary

Modifier and Type	Method	Description
void	cancelAutoRenewal()	Cancels an auto-renewing order.
void	execute(byte[] csr)	Finalizes the order, by providing a CSR.
List<Authorization>	getAuthorizations()	Gets the Authorization required for this order, in no specific order.
Certificate	getAutoRenewalCertificate()	Gets the STAR extension's Certificate if it is available.
Instant	getAutoRenewalEndDate()	Returns the latest date of validity of the last certificate issued, or null.
Duration	getAutoRenewalLifetime()	Returns the maximum lifetime of each certificate, or null.
Duration	getAutoRenewalLifetimeAdjust()	Returns the predate period of each certificate, or null.
Instant	getAutoRenewalStartDate()	Returns the earliest date of validity of the first certificate issued, or null.
Certificate	getCertificate()	Gets the Certificate if it is available.
Problem	getError()	Returns a Problem document if the order failed.
Instant	getExpires()	Gets the expiry date of the authorization, if set by the server.
URL	getFinalizeLocation()	Gets the location URL of where to send the finalization call to.
List<Identifier>	getIdentifiers()	Gets the list of Identifier to be ordered.
Instant	getNotAfter()	Gets the "not after" date that was used for the order, or null.
Instant	getNotBefore()	Gets the "not before" date that was used for the order, or null.
Status	getStatus()	Returns the current status of the order.
boolean	isAutoRenewalGetEnabled()	Returns true if STAR certificates from this order can also be fetched via GET requests.
boolean	isAutoRenewing()	Checks if this order is auto-renewing, according to the ACME STAR specifications.

Methods inherited from class org.shredzone.acme4j.AcmeJsonResource

getJSON, invalidate, isValid, setJSON, update

Methods inherited from class org.shredzone.acme4j.AcmeResource

getLocation, getLogin, getSession, rebind

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Order

protected Order(Login login,
 URL location)

Method Details

getStatus

public Status getStatus()

Returns the current status of the order.

Possible values are: Status.PENDING, Status.READY, Status.PROCESSING, Status.VALID, Status.INVALID.

getError

@Nullable
public Problem getError()

Returns a Problem document if the order failed.

getExpires

@Nullable
public Instant getExpires()

Gets the expiry date of the authorization, if set by the server.

getIdentifiers

public List<Identifier> getIdentifiers()

Gets the list of Identifier to be ordered.

Since:

2.3

getNotBefore

@Nullable
public Instant getNotBefore()

Gets the "not before" date that was used for the order, or null.

getNotAfter

@Nullable
public Instant getNotAfter()

Gets the "not after" date that was used for the order, or null.

getAuthorizations

public List<Authorization> getAuthorizations()

Gets the Authorization required for this order, in no specific order.

getFinalizeLocation

public URL getFinalizeLocation()

Gets the location URL of where to send the finalization call to.

For internal purposes. Use execute(byte[]) to finalize an order.

getCertificate

@Nullable
public Certificate getCertificate()

Gets the Certificate if it is available. null otherwise.

getAutoRenewalCertificate

@Nullable
public Certificate getAutoRenewalCertificate()

Gets the STAR extension's Certificate if it is available. null otherwise.

Since:

2.6

execute

public void execute(byte[] csr)
             throws AcmeException

Finalizes the order, by providing a CSR.

After a successful finalization, the certificate is available at getCertificate().

Even though the ACME protocol uses the term "finalize an order", this method is called execute(byte[]) to avoid confusion with the general Object.finalize() method.

Parameters:

csr - CSR containing the parameters for the certificate being requested, in DER format

Throws:

AcmeException

isAutoRenewing

public boolean isAutoRenewing()

Checks if this order is auto-renewing, according to the ACME STAR specifications.

Since:

2.3

getAutoRenewalStartDate

@Nullable
public Instant getAutoRenewalStartDate()

Returns the earliest date of validity of the first certificate issued, or null.

Since:

2.3

getAutoRenewalEndDate

@Nullable
public Instant getAutoRenewalEndDate()

Returns the latest date of validity of the last certificate issued, or null.

Since:

2.3

getAutoRenewalLifetime

@Nullable
public Duration getAutoRenewalLifetime()

Returns the maximum lifetime of each certificate, or null.

Since:

2.3

getAutoRenewalLifetimeAdjust

@Nullable
public Duration getAutoRenewalLifetimeAdjust()

Returns the predate period of each certificate, or null.

Since:

2.7

isAutoRenewalGetEnabled

public boolean isAutoRenewalGetEnabled()

Returns true if STAR certificates from this order can also be fetched via GET requests.

Since:

2.6

cancelAutoRenewal

public void cancelAutoRenewal()
                       throws AcmeException

Cancels an auto-renewing order.

Throws:

AcmeException

Since:

2.3