Module org.shredzone.acme4j

Package org.shredzone.acme4j

Class Authorization

java.lang.Object

org.shredzone.acme4j.AcmeResource

org.shredzone.acme4j.AcmeJsonResource

org.shredzone.acme4j.Authorization

All Implemented Interfaces:

Serializable, PollableResource

public class Authorization
extends AcmeJsonResource
implements PollableResource

Represents an authorization request at the ACME server.

See Also:

• Serialized Form

Field Summary

Fields inherited from interface org.shredzone.acme4j.PollableResource

DEFAULT_RETRY_AFTER

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	deactivate()	Permanently deactivates the Authorization.
<T extends Challenge> Optional<T>	findChallenge(Class<T> type)	Finds a Challenge of the given class type.
<T extends Challenge> Optional<T>	findChallenge(String type)	Finds a Challenge of the given type.
List<Challenge>	getChallenges()	Gets a list of all challenges offered by the server, in no specific order.
Optional<Instant>	getExpires()	Gets the expiry date of the authorization, if set by the server.
Identifier	getIdentifier()	Gets the Identifier to be authorized.
Status	getStatus()	Gets the authorization status.
boolean	isSubdomainAuthAllowed()	Returns true if certificates for subdomains can be issued according to RFC9444.
boolean	isWildcard()	Returns true if this Authorization is related to a wildcard domain, false otherwise.
Status	waitForCompletion(Duration timeout)	Waits until the authorization is completed.

Methods inherited from class org.shredzone.acme4j.AcmeJsonResource

fetch, getJSON, getRetryAfter, invalidate, isValid, setJSON, setRetryAfter, update

Methods inherited from class org.shredzone.acme4j.AcmeResource

finalize, getLocation, getLogin, getSession, rebind

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.shredzone.acme4j.PollableResource

fetch, waitForStatus

Constructor Details

Authorization

protected Authorization(Login login,
 URL location)

Method Details

getIdentifier

public Identifier getIdentifier()

Gets the Identifier to be authorized.

For wildcard domain orders, the domain itself (without wildcard prefix) is returned here. To find out if this Authorization is related to a wildcard domain order, check the isWildcard() method.

Since:

2.3

getStatus

public Status getStatus()

Gets the authorization status.

Possible values are: Status.PENDING, Status.VALID, Status.INVALID, Status.DEACTIVATED, Status.EXPIRED, Status.REVOKED.

Specified by:

getStatus in interface PollableResource

getExpires

public Optional<Instant> getExpires()

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

isWildcard

public boolean isWildcard()

Returns true if this Authorization is related to a wildcard domain, false otherwise.

isSubdomainAuthAllowed

public boolean isSubdomainAuthAllowed()

Returns true if certificates for subdomains can be issued according to RFC9444.

Since:

3.3.0

getChallenges

public List<Challenge> getChallenges()

Gets a list of all challenges offered by the server, in no specific order.

findChallenge

public <T extends Challenge> Optional<T> findChallenge(String type)

Finds a Challenge of the given type. Responding to this Challenge is sufficient for authorization.

findChallenge(Class) should be preferred, as this variant is not type safe.

Parameters:

type - Challenge name (e.g. "http-01")

Returns:

Challenge matching that name, or empty if there is no such challenge, or if the challenge alone is not sufficient for authorization.

Throws:

ClassCastException - if the type does not match the expected Challenge class type

findChallenge

public <T extends Challenge> Optional<T> findChallenge(Class<T> type)

Finds a Challenge of the given class type. Responding to this Challenge is sufficient for authorization.

Parameters:

type - Challenge type (e.g. "Http01Challenge.class")

Returns:

Challenge of that type, or empty if there is no such challenge, or if the challenge alone is not sufficient for authorization.

Since:

2.8

waitForCompletion

public Status waitForCompletion(Duration timeout)
                         throws AcmeException,
InterruptedException

Waits until the authorization is completed.

Is is completed if it reaches either Status.VALID or Status.INVALID.

This method is synchronous and blocks the current thread.

Parameters:

timeout - Timeout until a terminal status must have been reached

Returns:

Status that was reached

Throws:

AcmeException

InterruptedException

Since:

3.4.0

deactivate

public void deactivate()
                throws AcmeException

Permanently deactivates the Authorization.

Throws:

AcmeException