org.shredzone.acme4j.challenge

Class Challenge

java.lang.Object

org.shredzone.acme4j.AcmeResource

org.shredzone.acme4j.challenge.Challenge

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

TokenChallenge

public class Challenge
extends AcmeResource

A generic challenge. It can be used as a base class for actual challenge implementations, but it is also used if the ACME server offers a proprietary challenge that is unknown to acme4j.

Subclasses must override acceptable(String) so it only accepts the own type. respond(JSONBuilder) should be overridden to put all required data to the response.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	KEY_ERROR
protected static String	KEY_STATUS
protected static String	KEY_TYPE
protected static String	KEY_URI
protected static String	KEY_VALIDATED

Constructor Summary

Constructors

Constructor and Description
Challenge(Session session) Creates a new generic Challenge object.

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptable(String type) Checks if the type is acceptable to this challenge.
protected void	authorize() Callback that is invoked when the challenge is supposed to compute its authorization data.
static <T extends Challenge> T	bind(Session session, URL location) Returns a Challenge object of an existing challenge.
Problem	getError() Returns the reason why the challenge failed, if returned by the server.
protected JSON	getJSON() Returns the JSON representation of the challenge data.
URL	getLocation() Returns the location URL of the challenge.
Status	getStatus() Returns the current status of the challenge.
String	getType() Returns the challenge type by name (e.g.
Instant	getValidated() Returns the validation date, if returned by the server.
protected void	respond(JSONBuilder cb) Exports the response state, as preparation for triggering the challenge.
void	trigger() Triggers this Challenge.
void	unmarshall(JSON json) Sets the challenge state to the given JSON map.
void	update() Updates the state of this challenge.

Methods inherited from class org.shredzone.acme4j.AcmeResource

getSession, rebind, setLocation, setSession

Methods inherited from class java.lang.Object

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

Field Detail

KEY_TYPE

protected static final String KEY_TYPE

See Also:

Constant Field Values

KEY_STATUS

protected static final String KEY_STATUS

See Also:

Constant Field Values

KEY_URI

protected static final String KEY_URI

See Also:

Constant Field Values

KEY_VALIDATED

protected static final String KEY_VALIDATED

See Also:

Constant Field Values

KEY_ERROR

protected static final String KEY_ERROR

See Also:

Constant Field Values

Constructor Detail

Challenge

public Challenge(Session session)

Creates a new generic Challenge object.

Parameters:

session - Session to bind to.

Method Detail

bind

public static <T extends Challenge> T bind(Session session,
                                           URL location)
                                    throws AcmeException

Returns a Challenge object of an existing challenge.

Parameters:

session - Session to be used

location - Challenge location

Returns:

Challenge bound to this session and location

Throws:

AcmeException

getType

public String getType()

Returns the challenge type by name (e.g. "http-01").

getStatus

public Status getStatus()

Returns the current status of the challenge.

getLocation

public URL getLocation()

Returns the location URL of the challenge.

Overrides:

getLocation in class AcmeResource

getValidated

public Instant getValidated()

Returns the validation date, if returned by the server.

getError

public Problem getError()

Returns the reason why the challenge failed, if returned by the server.

getJSON

protected JSON getJSON()

Returns the JSON representation of the challenge data.

respond

protected void respond(JSONBuilder cb)

Exports the response state, as preparation for triggering the challenge.

Parameters:

cb - JSONBuilder to copy the response to

acceptable

protected boolean acceptable(String type)

Checks if the type is acceptable to this challenge.

Parameters:

type - Type to check

Returns:

true if acceptable, false if not

unmarshall

public void unmarshall(JSON json)

Sets the challenge state to the given JSON map.

Parameters:

json - JSON containing the challenge data

authorize

protected void authorize()

Callback that is invoked when the challenge is supposed to compute its authorization data.

trigger

public void trigger()
             throws AcmeException

Triggers this Challenge. The ACME server is requested to validate the response. Note that the validation is performed asynchronously by the ACME server.

Throws:

AcmeException

update

public void update()
            throws AcmeException

Updates the state of this challenge.

Throws:

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

AcmeException