org.shredzone.acme4j.provider

Interface AcmeProvider

All Known Implementing Classes:

AbstractAcmeProvider, GenericAcmeProvider, LetsEncryptAcmeProvider

public interface AcmeProvider

An AcmeProvider provides methods to be used for communicating with the ACME server. Implementations handle individual features of each ACME server.

Provider implementations must be registered with Java's ServiceLoader.

Method Summary

Modifier and Type	Method and Description
boolean	accepts(URI serverUri) Checks if this provider accepts the given server URI.
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.
JSON	directory(Session session, URI serverUri) Returns the provider's directory.
URL	resolve(URI serverUri) Resolves the server URI and returns the matching directory URL.

Method Detail

accepts

boolean accepts(URI serverUri)

Checks if this provider accepts the given server URI.

Parameters:

serverUri - Server URI to test

Returns:

true if this provider accepts the server URI, false otherwise

resolve

URL resolve(URI serverUri)

Resolves the server URI and returns the matching directory URL.

Parameters:

serverUri - Server URI

Returns:

Resolved directory URL

Throws:

IllegalArgumentException - if the server URI is not accepted

connect

Connection connect()

Creates a Connection for communication with the ACME server.

Returns:

Connection that was generated

directory

JSON directory(Session session,
               URI serverUri)
        throws AcmeException

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.

Parameters:

session - Session to be used

serverUri - Server URI

Returns:

Directory data, as JSON object

Throws:

AcmeException

createChallenge

Challenge createChallenge(Session session,
                          String type)

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.

Parameters:

session - Session to bind the challenge to

type - Challenge type

Returns:

Challenge instance