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

public class Authorization
extends AcmeJsonResource

Represents an authorization request at the ACME server.

See Also:

• Serialized Form

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	isWildcard()	Returns true if this Authorization is related to a wildcard domain, false otherwise.

Methods inherited from class org.shredzone.acme4j.AcmeJsonResource

fetch, getJSON, getRetryAfter, invalidate, isValid, setJSON, setRetryAfter, 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

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.

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.

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

deactivate

public void deactivate()
                throws AcmeException

Permanently deactivates the Authorization.

Throws:

AcmeException