org.shredzone.acme4j

Class Authorization

java.lang.Object

org.shredzone.acme4j.AcmeResource

org.shredzone.acme4j.Authorization

All Implemented Interfaces:

Serializable

public class Authorization
extends AcmeResource

Represents an authorization request at the ACME server.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Authorization(Session session, URL location)

Method Summary

Modifier and Type	Method and Description
static Authorization	bind(Session session, URL location) Creates a new instance of Authorization and binds it to the Session.
void	deactivate() Permanently deactivates the Authorization.
<T extends Challenge> T	findChallenge(String type) Finds a single Challenge of the given type.
Collection<Challenge>	findCombination(String... types) Finds a combination of Challenge types that the client supports.
List<Challenge>	getChallenges() Gets a list of all challenges offered by the server.
List<List<Challenge>>	getCombinations() Gets all combinations of challenges supported by the server.
String	getDomain() Gets the domain name to be authorized.
Instant	getExpires() Gets the expiry date of the authorization, if set by the server.
Status	getStatus() Gets the authorization status.
protected void	load() Lazily updates the object's state when one of the getters is invoked.
protected void	unmarshalAuthorization(JSON json) Sets the properties according to the given JSON data.
void	update() Updates the Authorization.

Methods inherited from class org.shredzone.acme4j.AcmeResource

getLocation, getSession, rebind, setLocation, setSession

Methods inherited from class java.lang.Object

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

Constructor Detail

Authorization

protected Authorization(Session session,
                        URL location)

Method Detail

bind

public static Authorization bind(Session session,
                                 URL location)

Creates a new instance of Authorization and binds it to the Session.

Parameters:

session - Session to be used

location - Location of the Authorization

Returns:

Authorization bound to the session and location

getDomain

public String getDomain()

Gets the domain name to be authorized.

getStatus

public Status getStatus()

Gets the authorization status.

getExpires

public Instant getExpires()

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

getChallenges

public List<Challenge> getChallenges()

Gets a list of all challenges offered by the server.

getCombinations

public List<List<Challenge>> getCombinations()

Gets all combinations of challenges supported by the server.

findChallenge

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

Finds a single Challenge of the given type. Responding to this Challenge is sufficient for authorization. This is a convenience call to findCombination(String...).

Parameters:

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

Returns:

Challenge matching that name, or null 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

findCombination

public Collection<Challenge> findCombination(String... types)

Finds a combination of Challenge types that the client supports. The client has to respond to all of the Challenges returned. However, this method attempts to find the combination with the smallest number of Challenges.

Parameters:

types - Challenge name or names (e.g. "http-01"), in no particular order. Basically this is a collection of all challenge types supported by your implementation.

Returns:

Matching Challenge combination, or an empty collection if the ACME server does not support any of your challenges. The challenges are returned in no particular order. The result may be a subset of the types you have provided, if fewer challenges are actually required for a successful validation.

update

public void update()
            throws AcmeException

Updates the Authorization. After invocation, the Authorization reflects the current state at the ACME server.

Throws:

AcmeRetryAfterException - the auhtorization is still being validated, and the server returned an estimated date when the validation will be completed. If you are polling for the authorization to complete, you should wait for the date given in AcmeRetryAfterException.getRetryAfter(). Note that the authorization status is updated even if this exception was thrown.

AcmeException

deactivate

public void deactivate()
                throws AcmeException

Permanently deactivates the Authorization.

Throws:

AcmeException

load

protected void load()

Lazily updates the object's state when one of the getters is invoked.

unmarshalAuthorization

protected void unmarshalAuthorization(JSON json)

Sets the properties according to the given JSON data.

Parameters:

json - JSON data