Module org.shredzone.acme4j

Package org.shredzone.acme4j

Class Metadata

java.lang.Object

org.shredzone.acme4j.Metadata

public class Metadata
extends Object

A collection of metadata related to the CA provider.

Constructor Summary

Constructors

Constructor	Description
Metadata(JSON meta)	Creates a new Metadata instance.

Method Summary

Modifier and Type	Method	Description
Duration	getAutoRenewalMaxDuration()	Returns the maximum delta between auto-renewal end date and auto-renewal start date.
Duration	getAutoRenewalMinLifetime()	Returns the minimum acceptable value for the maximum validity of a certificate before auto-renewal.
Collection<String>	getCaaIdentities()	Returns a collection of hostnames, which the ACME server recognises as referring to itself for the purposes of CAA record validation.
JSON	getJSON()	Returns the JSON representation of the metadata.
Optional<URI>	getTermsOfService()	Returns an URI of the current terms of service, or empty if not available.
Optional<URL>	getWebsite()	Returns an URL of a website providing more information about the ACME server.
boolean	isAutoRenewalEnabled()	Returns whether the CA supports short-term auto-renewal of certificates.
boolean	isAutoRenewalGetAllowed()	Returns whether the CA also allows to fetch STAR certificates via GET request.
boolean	isExternalAccountRequired()	Returns whether an external account is required by this CA.
boolean	isSubdomainAuthAllowed()	Returns whether the CA supports subdomain auth according to RFC9444.

Methods inherited from class java.lang.Object

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

Constructor Detail

Metadata

public Metadata(JSON meta)

Creates a new Metadata instance.

Parameters:

meta - JSON map of metadata

Method Detail

getTermsOfService

public Optional<URI> getTermsOfService()

Returns an URI of the current terms of service, or empty if not available.

getWebsite

public Optional<URL> getWebsite()

Returns an URL of a website providing more information about the ACME server. Empty if not available.

getCaaIdentities

public Collection<String> getCaaIdentities()

Returns a collection of hostnames, which the ACME server recognises as referring to itself for the purposes of CAA record validation. Empty if not available.

isExternalAccountRequired

public boolean isExternalAccountRequired()

Returns whether an external account is required by this CA.

isAutoRenewalEnabled

public boolean isAutoRenewalEnabled()

Returns whether the CA supports short-term auto-renewal of certificates.

Since:

2.3

getAutoRenewalMinLifetime

public Duration getAutoRenewalMinLifetime()

Returns the minimum acceptable value for the maximum validity of a certificate before auto-renewal.

Throws:

AcmeNotSupportedException - if the server does not support auto-renewal.

Since:

2.3

getAutoRenewalMaxDuration

public Duration getAutoRenewalMaxDuration()

Returns the maximum delta between auto-renewal end date and auto-renewal start date.

Throws:

AcmeNotSupportedException - if the server does not support auto-renewal.

Since:

2.3

isAutoRenewalGetAllowed

public boolean isAutoRenewalGetAllowed()

Returns whether the CA also allows to fetch STAR certificates via GET request.

Throws:

AcmeNotSupportedException - if the server does not support auto-renewal.

Since:

2.6

isSubdomainAuthAllowed

public boolean isSubdomainAuthAllowed()

Returns whether the CA supports subdomain auth according to RFC9444.

Since:

3.3.0

getJSON

public JSON getJSON()

Returns the JSON representation of the metadata. This is useful for reading proprietary metadata properties.