org.shredzone.acme4j.provider

Class AbstractAcmeProvider

java.lang.Object

org.shredzone.acme4j.provider.AbstractAcmeProvider

All Implemented Interfaces:

AcmeProvider

Direct Known Subclasses:

GenericAcmeProvider, LetsEncryptAcmeProvider

public abstract class AbstractAcmeProvider
extends Object
implements AcmeProvider

Abstract implementation of AcmeProvider. It consists of a challenge registry and a standard HttpConnector.

Implementing classes must implement at least AcmeProvider.accepts(URI) and AcmeProvider.resolve(URI).

Constructor Summary

Constructors

Constructor and Description
AbstractAcmeProvider()

Method Summary

Modifier and Type	Method and Description
Connection	connect() Creates a Connection for communication with the ACME server.
Challenge	createChallenge(Session session, String type) Creates a Challenge instance for the given challenge type.
protected HttpConnector	createHttpConnector() Creates a HttpConnector.
JSON	directory(Session session, URI serverUri) Returns the provider's directory.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.shredzone.acme4j.provider.AcmeProvider

accepts, resolve

Constructor Detail

AbstractAcmeProvider

public AbstractAcmeProvider()

Method Detail

connect

public Connection connect()

Description copied from interface: AcmeProvider

Creates a Connection for communication with the ACME server.

Specified by:

connect in interface AcmeProvider

Returns:

Connection that was generated

directory

public JSON directory(Session session,
                      URI serverUri)
               throws AcmeException

Description copied from interface: AcmeProvider

Returns the provider's directory. The structure must contain resource URIs, and may optionally contain metadata.

The default implementation resolves the server URI and fetches the directory via HTTP request. Subclasses may override this method, e.g. if the directory is static.

Specified by:

directory in interface AcmeProvider

Parameters:

session - Session to be used

serverUri - Server URI

Returns:

Directory data, as JSON object

Throws:

AcmeException

createChallenge

public Challenge createChallenge(Session session,
                                 String type)

Description copied from interface: AcmeProvider

Creates a Challenge instance for the given challenge type.

Custom provider implementations may override this method to provide challenges that are unique to the provider.

Specified by:

createChallenge in interface AcmeProvider

Parameters:

session - Session to bind the challenge to

type - Challenge type

Returns:

Challenge instance

createHttpConnector

protected HttpConnector createHttpConnector()

Creates a HttpConnector.

Subclasses may override this method to configure the HttpConnector.