Module org.shredzone.acme4j

Package org.shredzone.acme4j.provider

Class AbstractAcmeProvider

java.lang.Object

org.shredzone.acme4j.provider.AbstractAcmeProvider

All Implemented Interfaces:

AcmeProvider

Direct Known Subclasses:

GenericAcmeProvider

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	Description
AbstractAcmeProvider()

Method Summary

Modifier and Type	Method	Description
Connection	connect(URI serverUri, NetworkSettings networkSettings)	Creates a Connection for communication with the ACME server.
Challenge	createChallenge(Login login, JSON data)	Creates a Challenge instance for the given challenge data.
protected HttpConnector	createHttpConnector(NetworkSettings settings)	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 Details

AbstractAcmeProvider

public AbstractAcmeProvider()

Method Details

connect

public Connection connect(URI serverUri,
 NetworkSettings networkSettings)

Description copied from interface: AcmeProvider

Creates a Connection for communication with the ACME server.

Specified by:

connect in interface AcmeProvider

Parameters:

serverUri - Server URI

networkSettings - NetworkSettings to be used for the connection

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 URLs, 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, or null if the directory has not been changed since the last request.

Throws:

AcmeException

createChallenge

public Challenge createChallenge(Login login,
 JSON data)

Creates a Challenge instance for the given challenge data.

This implementation handles the standard challenge types. For unknown types, generic Challenge or TokenChallenge instances are created.

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

Specified by:

createChallenge in interface AcmeProvider

Parameters:

login - Login to bind the challenge to

data - Challenge JSON data

Returns:

Challenge instance, or null if this provider is unable to generate a matching Challenge instance.

createHttpConnector

protected HttpConnector createHttpConnector(NetworkSettings settings)

Creates a HttpConnector.

Subclasses may override this method to configure the HttpConnector.