Modul org.shredzone.acme4j

Package org.shredzone.acme4j

Klasse Authorization

java.lang.Object

org.shredzone.acme4j.AcmeResource

org.shredzone.acme4j.AcmeJsonResource

org.shredzone.acme4j.Authorization

Alle implementierten Schnittstellen:

Serializable, PollableResource

public class Authorization
extends AcmeJsonResource
implements PollableResource

Represents an authorization request at the ACME server.

Siehe auch:

• Serialisierte Form

Feldübersicht

Von Schnittstelle geerbte Felder org.shredzone.acme4j.PollableResource

DEFAULT_RETRY_AFTER

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
protected	Authorization(Login login, URL location)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
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.

Von Klasse geerbte Methoden org.shredzone.acme4j.AcmeJsonResource

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

Von Klasse geerbte Methoden org.shredzone.acme4j.AcmeResource

finalize, getLocation, getLogin, getSession, rebind

Von Klasse geerbte Methoden java.lang.Object

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

Von Schnittstelle geerbte Methoden org.shredzone.acme4j.PollableResource

fetch, waitForStatus

Konstruktordetails

Authorization

protected Authorization(Login login,
 URL location)

Methodendetails

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.

Seit:

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.

Angegeben von:

getStatus in Schnittstelle 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.

Seit:

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.

Parameter:

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

Gibt zurück:

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

Löst aus:

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.

Parameter:

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

Gibt zurück:

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

Seit:

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.

Parameter:

timeout - Timeout until a terminal status must have been reached

Gibt zurück:

Status that was reached

Löst aus:

AcmeException

InterruptedException

Seit:

3.4.0

deactivate

public void deactivate()
                throws AcmeException

Permanently deactivates the Authorization.

Löst aus:

AcmeException