Index

A B C D E F G H I J K L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AA_COMPROMISE - Enum constant in enum class org.shredzone.acme4j.RevocationReason
 
AbstractAcmeProvider - Class in org.shredzone.acme4j.provider
Abstract implementation of AcmeProvider.
AbstractAcmeProvider() - Constructor for class org.shredzone.acme4j.provider.AbstractAcmeProvider
 
acceptable(String) - Method in class org.shredzone.acme4j.challenge.Challenge
Checks if the type is acceptable to this challenge.
acceptable(String) - Method in class org.shredzone.acme4j.challenge.Dns01Challenge
 
acceptable(String) - Method in class org.shredzone.acme4j.challenge.Http01Challenge
 
acceptable(String) - Method in class org.shredzone.acme4j.challenge.TlsAlpn01Challenge
 
accepts(URI) - Method in interface org.shredzone.acme4j.provider.AcmeProvider
Checks if this provider accepts the given server URI.
accepts(URI) - Method in class org.shredzone.acme4j.provider.GenericAcmeProvider
 
Account - Class in org.shredzone.acme4j
A representation of an account at the ACME server.
Account(Login) - Constructor for class org.shredzone.acme4j.Account
 
Account.EditableAccount - Class in org.shredzone.acme4j
Provides editable properties of an Account.
AccountBuilder - Class in org.shredzone.acme4j
A builder for registering a new account with the CA.
AccountBuilder() - Constructor for class org.shredzone.acme4j.AccountBuilder
 
ACME_TLS_1_PROTOCOL - Static variable in class org.shredzone.acme4j.challenge.TlsAlpn01Challenge
acme-tls/1 protocol.
ACME_VALIDATION - Static variable in class org.shredzone.acme4j.util.CertificateUtils
The acmeValidation object identifier.
ACME_VALIDATION_OID - Static variable in class org.shredzone.acme4j.challenge.TlsAlpn01Challenge
OID of the acmeValidation extension.
AcmeException - Exception in org.shredzone.acme4j.exception
The root class of all checked acme4j exceptions.
AcmeException() - Constructor for exception org.shredzone.acme4j.exception.AcmeException
Creates a generic AcmeException.
AcmeException(String) - Constructor for exception org.shredzone.acme4j.exception.AcmeException
Creates a generic AcmeException.
AcmeException(String, Throwable) - Constructor for exception org.shredzone.acme4j.exception.AcmeException
Creates a generic AcmeException.
AcmeJsonResource - Class in org.shredzone.acme4j
An extension of AcmeResource that also contains the current state of a resource as JSON document.
AcmeJsonResource(Login, URL) - Constructor for class org.shredzone.acme4j.AcmeJsonResource
Create a new AcmeJsonResource.
AcmeLazyLoadingException - Exception in org.shredzone.acme4j.exception
A runtime exception that is thrown when an AcmeException occured while trying to lazy-load a resource from the ACME server.
AcmeLazyLoadingException(Class<? extends AcmeResource>, URL, AcmeException) - Constructor for exception org.shredzone.acme4j.exception.AcmeLazyLoadingException
AcmeLazyLoadingException(AcmeResource, AcmeException) - Constructor for exception org.shredzone.acme4j.exception.AcmeLazyLoadingException
AcmeNetworkException - Exception in org.shredzone.acme4j.exception
A general network error has occured while communicating with the server (e.g.
AcmeNetworkException(IOException) - Constructor for exception org.shredzone.acme4j.exception.AcmeNetworkException
Create a new AcmeNetworkException.
AcmeNotSupportedException - Exception in org.shredzone.acme4j.exception
A runtime exception that is thrown if the ACME server does not support a certain feature.
AcmeNotSupportedException(String) - Constructor for exception org.shredzone.acme4j.exception.AcmeNotSupportedException
AcmeProtocolException - Exception in org.shredzone.acme4j.exception
A runtime exception that is thrown when the response of the server is violating the RFC, and could not be handled or parsed for that reason.
AcmeProtocolException(String) - Constructor for exception org.shredzone.acme4j.exception.AcmeProtocolException
Creates a new AcmeProtocolException.
AcmeProtocolException(String, Throwable) - Constructor for exception org.shredzone.acme4j.exception.AcmeProtocolException
Creates a new AcmeProtocolException.
AcmeProvider - Interface in org.shredzone.acme4j.provider
An AcmeProvider provides methods to be used for communicating with the ACME server.
AcmeRateLimitedException - Exception in org.shredzone.acme4j.exception
A rate limit was exceeded.
AcmeRateLimitedException(Problem, Instant, Collection<URL>) - Constructor for exception org.shredzone.acme4j.exception.AcmeRateLimitedException
AcmeResource - Class in org.shredzone.acme4j
This is the root class of all ACME resources (like accounts, orders, certificates).
AcmeResource(Login, URL) - Constructor for class org.shredzone.acme4j.AcmeResource
Create a new AcmeResource.
AcmeRetryAfterException - Exception in org.shredzone.acme4j.exception
Deprecated.
Will be removed in a future version.
AcmeRetryAfterException(String, Instant) - Constructor for exception org.shredzone.acme4j.exception.AcmeRetryAfterException
Deprecated.
AcmeServerException - Exception in org.shredzone.acme4j.exception
The ACME server returned an error.
AcmeServerException(Problem) - Constructor for exception org.shredzone.acme4j.exception.AcmeServerException
Creates a new AcmeServerException.
AcmeUnauthorizedException - Exception in org.shredzone.acme4j.exception
The client is not authorized to perform the operation.
AcmeUnauthorizedException(Problem) - Constructor for exception org.shredzone.acme4j.exception.AcmeUnauthorizedException
AcmeUserActionRequiredException - Exception in org.shredzone.acme4j.exception
The user is required to take manual action as indicated.
AcmeUserActionRequiredException(Problem, URI) - Constructor for exception org.shredzone.acme4j.exception.AcmeUserActionRequiredException
AcmeUtils - Class in org.shredzone.acme4j.toolbox
Contains utility methods that are frequently used for the ACME protocol.
AcmeUtils.PemLabel - Enum Class in org.shredzone.acme4j.toolbox
Enumeration of PEM labels.
addContact(String) - Method in class org.shredzone.acme4j.Account.EditableAccount
Adds a new Contact to the account.
addContact(String) - Method in class org.shredzone.acme4j.AccountBuilder
Add a contact address to the list of contacts.
addContact(URI) - Method in class org.shredzone.acme4j.Account.EditableAccount
Adds a new Contact to the account.
addContact(URI) - Method in class org.shredzone.acme4j.AccountBuilder
Add a contact URI to the list of contacts.
addDomain(String) - Method in class org.shredzone.acme4j.util.CSRBuilder
Adds a domain name to the CSR.
addDomains(String...) - Method in class org.shredzone.acme4j.util.CSRBuilder
Adds multiple domain names.
addDomains(Collection<String>) - Method in class org.shredzone.acme4j.util.CSRBuilder
Adds a Collection of domains.
addEmail(String) - Method in class org.shredzone.acme4j.Account.EditableAccount
Adds a new Contact email to the account.
addEmail(String) - Method in class org.shredzone.acme4j.AccountBuilder
Add an email address to the list of contacts.
addIdentifier(Identifier) - Method in class org.shredzone.acme4j.util.CSRBuilder
Adds an Identifier.
addIdentifiers(Collection<Identifier>) - Method in class org.shredzone.acme4j.util.CSRBuilder
addIdentifiers(Identifier...) - Method in class org.shredzone.acme4j.util.CSRBuilder
Adds multiple Identifier.
addIP(InetAddress) - Method in class org.shredzone.acme4j.util.CSRBuilder
Adds an InetAddress.
addIPs(InetAddress...) - Method in class org.shredzone.acme4j.util.CSRBuilder
Adds multiple IP addresses.
addIPs(Collection<InetAddress>) - Method in class org.shredzone.acme4j.util.CSRBuilder
Adds a Collection of IP addresses.
addValue(String, String) - Method in class org.shredzone.acme4j.util.CSRBuilder
Sets an entry of the subject used for the CSR.
addValue(ASN1ObjectIdentifier, String) - Method in class org.shredzone.acme4j.util.CSRBuilder
Sets an entry of the subject used for the CSR.
AFFILIATION_CHANGED - Enum constant in enum class org.shredzone.acme4j.RevocationReason
 
agreeToTermsOfService() - Method in class org.shredzone.acme4j.AccountBuilder
Documents that the user has agreed to the terms of service.
allowSubdomainAuth() - Method in class org.shredzone.acme4j.Identifier
Gives the permission to authorize subdomains of this domain, as required in RFC-9444.
array(String, Collection<?>) - Method in class org.shredzone.acme4j.toolbox.JSONBuilder
Puts an array.
asArray() - Method in class org.shredzone.acme4j.toolbox.JSON.Value
Returns the value as JSON.Array.
asBinary() - Method in class org.shredzone.acme4j.toolbox.JSON.Value
Returns the value as base64 decoded byte array.
asBoolean() - Method in class org.shredzone.acme4j.toolbox.JSON.Value
Returns the value as boolean.
asDuration() - Method in class org.shredzone.acme4j.toolbox.JSON.Value
Returns the value as Duration.
asEncodedObject() - Method in class org.shredzone.acme4j.toolbox.JSON.Value
Returns the value as JSON object that was Base64 URL encoded.
asIdentifier() - Method in class org.shredzone.acme4j.toolbox.JSON.Value
Returns the value as Identifier.
asInstant() - Method in class org.shredzone.acme4j.toolbox.JSON.Value
Returns the value as Instant.
asInt() - Method in class org.shredzone.acme4j.toolbox.JSON.Value
Returns the value as int.
asJSON() - Method in class org.shredzone.acme4j.Problem
Returns the problem as JSON object, to access other, non-standard fields.
asObject() - Method in class org.shredzone.acme4j.toolbox.JSON.Value
Returns the value as JSON object.
asProblem(URL) - Method in class org.shredzone.acme4j.toolbox.JSON.Value
Returns the value as Problem.
asStatus() - Method in class org.shredzone.acme4j.toolbox.JSON.Value
Returns the parsed Status.
asString() - Method in class org.shredzone.acme4j.toolbox.JSON.Value
Returns the value as String.
asURI() - Method in class org.shredzone.acme4j.toolbox.JSON.Value
Returns the value as URI.
asURL() - Method in class org.shredzone.acme4j.toolbox.JSON.Value
Returns the value as URL.
Authorization - Class in org.shredzone.acme4j
Represents an authorization request at the ACME server.
Authorization(Login, URL) - Constructor for class org.shredzone.acme4j.Authorization
 
autoRenewal() - Method in class org.shredzone.acme4j.OrderBuilder
Enables short-term automatic renewal of the certificate, if supported by the CA.
autoRenewalEnableGet() - Method in class org.shredzone.acme4j.OrderBuilder
Announces that the client wishes to fetch the auto-renewed certificate via GET request.
autoRenewalEnd(Instant) - Method in class org.shredzone.acme4j.OrderBuilder
Sets the latest date of validity of the last issued certificate.
autoRenewalLifetime(Duration) - Method in class org.shredzone.acme4j.OrderBuilder
Sets the maximum validity period of each certificate.
autoRenewalLifetimeAdjust(Duration) - Method in class org.shredzone.acme4j.OrderBuilder
Sets the amount of pre-dating each certificate.
autoRenewalStart(Instant) - Method in class org.shredzone.acme4j.OrderBuilder
Sets the earliest date of validity of the first issued certificate.
available() - Method in class org.shredzone.acme4j.connector.TrimmingInputStream
 

B

base64UrlDecode(String) - Static method in class org.shredzone.acme4j.toolbox.AcmeUtils
Base64 decodes to a byte array, using URL style encoding.
base64UrlEncode(byte[]) - Static method in class org.shredzone.acme4j.toolbox.AcmeUtils
Base64 encodes the given byte array, using URL style encoding.
bindAuthorization(URL) - Method in class org.shredzone.acme4j.Login
Creates a new instance of an existing Authorization and binds it to this login.
bindCertificate(URL) - Method in class org.shredzone.acme4j.Login
Creates a new instance of an existing Certificate and binds it to this login.
bindChallenge(URL) - Method in class org.shredzone.acme4j.Login
Creates a new instance of an existing Challenge and binds it to this login.
bindChallenge(URL, Class<C>) - Method in class org.shredzone.acme4j.Login
Creates a new instance of an existing Challenge and binds it to this login.
bindOrder(URL) - Method in class org.shredzone.acme4j.Login
Creates a new instance of an existing Order and binds it to this login.
bindRenewalInfo(URL) - Method in class org.shredzone.acme4j.Login
Creates a new instance of an existing RenewalInfo and binds it to this login.
bindRenewalInfo(X509Certificate) - Method in class org.shredzone.acme4j.Login
Creates a new instance of an existing RenewalInfo and binds it to this login.

C

CA_COMPROMISE - Enum constant in enum class org.shredzone.acme4j.RevocationReason
 
cancelAutoRenewal() - Method in class org.shredzone.acme4j.Order
Cancels an auto-renewing order.
CANCELED - Enum constant in enum class org.shredzone.acme4j.Status
An auto-renewing Order is canceled.
Certificate - Class in org.shredzone.acme4j
Represents an issued certificate and its certificate chain.
Certificate(Login, URL) - Constructor for class org.shredzone.acme4j.Certificate
 
CERTIFICATE - Enum constant in enum class org.shredzone.acme4j.toolbox.AcmeUtils.PemLabel
 
CERTIFICATE_HOLD - Enum constant in enum class org.shredzone.acme4j.RevocationReason
 
CERTIFICATE_REQUEST - Enum constant in enum class org.shredzone.acme4j.toolbox.AcmeUtils.PemLabel
 
CertificateUtils - Class in org.shredzone.acme4j.util
Utility class offering convenience methods for certificates.
CESSATION_OF_OPERATION - Enum constant in enum class org.shredzone.acme4j.RevocationReason
 
Challenge - Class in org.shredzone.acme4j.challenge
A generic challenge.
Challenge(Login, JSON) - Constructor for class org.shredzone.acme4j.challenge.Challenge
Creates a new generic Challenge object.
ChallengeProvider - Interface in org.shredzone.acme4j.provider
A provider that creates a Challenge from a matching JSON.
ChallengeType - Annotation Interface in org.shredzone.acme4j.provider
Annotates the challenge type that is generated by the ChallengeProvider.
changeKey(KeyPair) - Method in class org.shredzone.acme4j.Account
Changes the KeyPair associated with the account.
close() - Method in interface org.shredzone.acme4j.connector.Connection
Closes the Connection, releasing all resources.
close() - Method in class org.shredzone.acme4j.connector.DefaultConnection
 
close() - Method in class org.shredzone.acme4j.connector.TrimmingInputStream
 
code(int) - Static method in enum class org.shredzone.acme4j.RevocationReason
Returns the RevocationReason that matches the reason code.
commit() - Method in class org.shredzone.acme4j.Account.EditableAccount
Commits the changes and updates the account.
connect() - Method in class org.shredzone.acme4j.Session
Returns a new Connection to the ACME server.
connect(URI, NetworkSettings) - Method in class org.shredzone.acme4j.provider.AbstractAcmeProvider
 
connect(URI, NetworkSettings) - Method in interface org.shredzone.acme4j.provider.AcmeProvider
Creates a Connection for communication with the ACME server.
Connection - Interface in org.shredzone.acme4j.connector
Connects to the ACME server and offers different methods for invoking the API.
contains(String) - Method in class org.shredzone.acme4j.toolbox.JSON
Checks if this object contains the given key.
create() - Method in class org.shredzone.acme4j.OrderBuilder
Sends a new order to the server, and returns an Order object.
create(Login, JSON) - Method in interface org.shredzone.acme4j.provider.ChallengeProvider
Creates a Challenge.
create(Session) - Method in class org.shredzone.acme4j.AccountBuilder
Creates a new account.
createCertificate(KeyPair, Identifier) - Method in class org.shredzone.acme4j.challenge.TlsAlpn01Challenge
Creates a self-signed X509Certificate for this challenge.
createChallenge(Login, JSON) - Method in class org.shredzone.acme4j.provider.AbstractAcmeProvider
Creates a Challenge instance for the given challenge data.
createChallenge(Login, JSON) - Method in interface org.shredzone.acme4j.provider.AcmeProvider
Creates a Challenge instance for the given challenge data.
createChallenge(JSON) - Method in class org.shredzone.acme4j.Login
Creates a Challenge instance for the given challenge data.
createClientBuilder() - Method in class org.shredzone.acme4j.connector.HttpConnector
Creates a new HttpClient.Builder.
createECKeyPair(String) - Static method in class org.shredzone.acme4j.util.KeyPairUtils
Creates a new elliptic curve KeyPair.
createExternalAccountBinding(String, PublicKey, SecretKey, String, URL) - Static method in class org.shredzone.acme4j.toolbox.JoseUtils
Creates a JSON structure for external account binding.
createHttpConnector(NetworkSettings) - Method in class org.shredzone.acme4j.provider.AbstractAcmeProvider
Creates a HttpConnector.
createJoseRequest(URL, KeyPair, JSONBuilder, String, String) - Static method in class org.shredzone.acme4j.toolbox.JoseUtils
Creates an ACME JOSE request.
createKeyPair() - Static method in class org.shredzone.acme4j.util.KeyPairUtils
Creates a new standard KeyPair.
createKeyPair(int) - Static method in class org.shredzone.acme4j.util.KeyPairUtils
Creates a new RSA KeyPair.
createLogin(Session) - Method in class org.shredzone.acme4j.AccountBuilder
Creates a new account.
createRequestBuilder(URL) - Method in class org.shredzone.acme4j.connector.HttpConnector
Creates a new HttpRequest.Builder that is preconfigured and bound to the given URL.
createTestCertificate(PKCS10CertificationRequest, Instant, Instant, X509Certificate, PrivateKey) - Static method in class org.shredzone.acme4j.util.CertificateUtils
Creates a signed end entity certificate from the given CSR.
createTestIntermediateCertificate(String, Instant, Instant, PublicKey, X509Certificate, PrivateKey) - Static method in class org.shredzone.acme4j.util.CertificateUtils
Creates an intermediate certificate that is signed by an issuer.
createTestRootCertificate(String, Instant, Instant, KeyPair) - Static method in class org.shredzone.acme4j.util.CertificateUtils
Creates a self-signed root certificate.
createTlsAlpn01Certificate(KeyPair, Identifier, byte[]) - Static method in class org.shredzone.acme4j.util.CertificateUtils
Creates a self-signed X509Certificate that can be used for the TlsAlpn01Challenge.
CSRBuilder - Class in org.shredzone.acme4j.util
Generator for a CSR (Certificate Signing Request) suitable for ACME servers.
CSRBuilder() - Constructor for class org.shredzone.acme4j.util.CSRBuilder
 

D

deactivate() - Method in class org.shredzone.acme4j.Account
Permanently deactivates an account.
deactivate() - Method in class org.shredzone.acme4j.Authorization
Permanently deactivates the Authorization.
DEACTIVATED - Enum constant in enum class org.shredzone.acme4j.Status
The Account or Authorization has been deactivated by the client.
DEFAULT_RETRY_AFTER - Static variable in interface org.shredzone.acme4j.PollableResource
Default delay between status polls if there is no Retry-After header.
DefaultConnection - Class in org.shredzone.acme4j.connector
Default implementation of Connection.
DefaultConnection(HttpConnector) - Constructor for class org.shredzone.acme4j.connector.DefaultConnection
Creates a new DefaultConnection.
defaultUserAgent() - Static method in class org.shredzone.acme4j.connector.HttpConnector
Returns the default User-Agent to be used.
directory(Session, URI) - Method in class org.shredzone.acme4j.provider.AbstractAcmeProvider
 
directory(Session, URI) - Method in interface org.shredzone.acme4j.provider.AcmeProvider
Returns the provider's directory.
directoryExpires - Variable in class org.shredzone.acme4j.Session
 
directoryLastModified - Variable in class org.shredzone.acme4j.Session
 
dns(String) - Static method in class org.shredzone.acme4j.Identifier
Creates a new DNS identifier for the given domain name.
Dns01Challenge - Class in org.shredzone.acme4j.challenge
Implements the "dns-01" challenge.
Dns01Challenge(Login, JSON) - Constructor for class org.shredzone.acme4j.challenge.Dns01Challenge
Creates a new generic Dns01Challenge object.
domain(String) - Method in class org.shredzone.acme4j.OrderBuilder
Adds a domain name to the order.
domains(String...) - Method in class org.shredzone.acme4j.OrderBuilder
Adds domain names to the order.
domains(Collection<String>) - Method in class org.shredzone.acme4j.OrderBuilder
Adds a collection of domain names to the order.
download() - Method in class org.shredzone.acme4j.Certificate
Downloads the certificate chain.

E

empty() - Static method in class org.shredzone.acme4j.toolbox.JSON
Returns a JSON of an empty document.
equals(Object) - Method in class org.shredzone.acme4j.Identifier
 
equals(Object) - Method in class org.shredzone.acme4j.toolbox.JSON.Value
 
execute(byte[]) - Method in class org.shredzone.acme4j.Order
Finalizes the order (see Order.execute(KeyPair)).
execute(KeyPair) - Method in class org.shredzone.acme4j.Order
Finalizes the order.
execute(KeyPair, Consumer<CSRBuilder>) - Method in class org.shredzone.acme4j.Order
Finalizes the order (see Order.execute(KeyPair)).
execute(PKCS10CertificationRequest) - Method in class org.shredzone.acme4j.Order
Finalizes the order (see Order.execute(KeyPair)).
EXPIRED - Enum constant in enum class org.shredzone.acme4j.Status
The Authorization is expired.

F

fetch() - Method in class org.shredzone.acme4j.AcmeJsonResource
Updates this resource, by fetching the current resource data from the server.
fetch() - Method in interface org.shredzone.acme4j.PollableResource
Fetches the current status from the server.
fetch() - Method in class org.shredzone.acme4j.RenewalInfo
 
finalize() - Method in class org.shredzone.acme4j.AcmeResource
 
finalize() - Method in class org.shredzone.acme4j.Identifier
 
finalize() - Method in class org.shredzone.acme4j.Session
 
findCertificate(String) - Method in class org.shredzone.acme4j.Certificate
Finds a Certificate that was issued by the given issuer name.
findChallenge(Class<T>) - Method in class org.shredzone.acme4j.Authorization
Finds a Challenge of the given class type.
findChallenge(String) - Method in class org.shredzone.acme4j.Authorization
Finds a Challenge of the given type.
fromMap(Map<String, Object>) - Static method in class org.shredzone.acme4j.toolbox.JSON
Creates a JSON object from a map.

G

GenericAcmeProvider - Class in org.shredzone.acme4j.provider
A generic AcmeProvider.
GenericAcmeProvider() - Constructor for class org.shredzone.acme4j.provider.GenericAcmeProvider
 
get(int) - Method in class org.shredzone.acme4j.toolbox.JSON.Array
Gets the JSON.Value at the given index.
get(String) - Method in class org.shredzone.acme4j.toolbox.JSON
Returns the JSON.Value of the given key.
getAccount() - Method in class org.shredzone.acme4j.Login
Gets the Account that is bound to this login.
getAccountLocation() - Method in class org.shredzone.acme4j.Login
Gets the location URL of the account.
getAcmeValidation() - Method in class org.shredzone.acme4j.challenge.TlsAlpn01Challenge
Returns the value that is to be used as acmeValidation extension in the test certificate.
getAlternateCertificates() - Method in class org.shredzone.acme4j.Certificate
Returns alternate certificate chains, if available.
getAlternates() - Method in class org.shredzone.acme4j.Certificate
Returns URLs to alternate certificate chains.
getAuthenticator() - Method in class org.shredzone.acme4j.connector.NetworkSettings
Gets the Authenticator to be used, or null if none is to be set.
getAuthorization() - Method in class org.shredzone.acme4j.challenge.TokenChallenge
Returns the authorization string.
getAuthorizations() - Method in class org.shredzone.acme4j.Order
Gets the Authorization that are required to fulfil this order, in no specific order.
getAutoRenewalCertificate() - Method in class org.shredzone.acme4j.Order
Gets the STAR extension's Certificate if it is available.
getAutoRenewalEndDate() - Method in class org.shredzone.acme4j.Order
Returns the latest date of validity of the last certificate issued.
getAutoRenewalLifetime() - Method in class org.shredzone.acme4j.Order
Returns the maximum lifetime of each certificate.
getAutoRenewalLifetimeAdjust() - Method in class org.shredzone.acme4j.Order
Returns the pre-date period of each certificate.
getAutoRenewalMaxDuration() - Method in class org.shredzone.acme4j.Metadata
Returns the maximum delta between auto-renewal end date and auto-renewal start date.
getAutoRenewalMinLifetime() - Method in class org.shredzone.acme4j.Metadata
Returns the minimum acceptable value for the maximum validity of a certificate before auto-renewal.
getAutoRenewalStartDate() - Method in class org.shredzone.acme4j.Order
Returns the earliest date of validity of the first certificate issued.
getCaaIdentities() - Method in class org.shredzone.acme4j.Metadata
Returns a collection of hostnames, which the ACME server recognises as referring to itself for the purposes of CAA record validation.
getCertID() - Method in class org.shredzone.acme4j.Certificate
Deprecated.
Is not needed in the ACME context anymore and will thus be removed in a later version.
getCertificate() - Method in class org.shredzone.acme4j.Certificate
Returns the created certificate.
getCertificate() - Method in class org.shredzone.acme4j.Order
Gets the Certificate.
getCertificateChain() - Method in class org.shredzone.acme4j.Certificate
Returns the created certificate and issuer chain.
getChallenges() - Method in class org.shredzone.acme4j.Authorization
Gets a list of all challenges offered by the server, in no specific order.
getContacts() - Method in class org.shredzone.acme4j.Account.EditableAccount
Returns the list of all contact URIs for modification.
getContacts() - Method in class org.shredzone.acme4j.Account
List of registered contact addresses (emails, phone numbers etc).
getContentType(String) - Static method in class org.shredzone.acme4j.toolbox.AcmeUtils
Extracts the content type of a Content-Type header.
getCSR() - Method in class org.shredzone.acme4j.util.CSRBuilder
Gets the PKCS#10 certification request.
getDetail() - Method in class org.shredzone.acme4j.Problem
Returns a detailed and specific human-readable explanation of the problem.
getDigest() - Method in class org.shredzone.acme4j.challenge.Dns01Challenge
Returns the digest string to be set in the domain's _acme-challenge TXT record.
getDirectoryExpires() - Method in class org.shredzone.acme4j.Session
Returns the date when the current directory records will expire.
getDirectoryLastModified() - Method in class org.shredzone.acme4j.Session
Returns the date when the directory has been modified the last time.
getDocuments() - Method in exception org.shredzone.acme4j.exception.AcmeRateLimitedException
Collection of URLs pointing to documents about the rate limit that was hit.
getDomain() - Method in class org.shredzone.acme4j.Identifier
Returns the domain name if this is a DNS identifier.
getEncoded() - Method in class org.shredzone.acme4j.util.CSRBuilder
Gets an encoded PKCS#10 certification request.
getError() - Method in class org.shredzone.acme4j.challenge.Challenge
Returns a reason why the challenge has failed in the past, if returned by the server.
getError() - Method in class org.shredzone.acme4j.Order
Returns a Problem document with the reason if the order has failed.
getExpiration() - Method in interface org.shredzone.acme4j.connector.Connection
Returns the expiration date of the resource, if present.
getExpiration() - Method in class org.shredzone.acme4j.connector.DefaultConnection
 
getExpires() - Method in class org.shredzone.acme4j.Authorization
Gets the expiry date of the authorization, if set by the server.
getExpires() - Method in class org.shredzone.acme4j.Order
Gets the expiry date of the authorization, if set by the server.
getExplanation() - Method in class org.shredzone.acme4j.RenewalInfo
An optional URL pointing to a page which may explain why the suggested renewal window is what it is.
getFeature(String) - Method in class org.shredzone.acme4j.toolbox.JSON
Returns the JSON.Value of the given key.
getFinalizeLocation() - Method in class org.shredzone.acme4j.Order
Gets the location URL of where to send the finalization call to.
getIdentifier() - Method in class org.shredzone.acme4j.Authorization
Gets the Identifier to be authorized.
getIdentifier() - Method in class org.shredzone.acme4j.Problem
Returns the Identifier this problem relates to.
getIdentifiers() - Method in class org.shredzone.acme4j.Order
Gets a list of Identifier that are connected to this order.
getInstance() - Method in exception org.shredzone.acme4j.exception.AcmeUserActionRequiredException
Returns the URL of a document that gives instructions on the actions to be taken by a human.
getInstance() - Method in class org.shredzone.acme4j.Problem
Returns a URI that identifies the specific occurence of the problem.
getIP() - Method in class org.shredzone.acme4j.Identifier
Returns the IP address if this is an IP identifier.
getJSON() - Method in class org.shredzone.acme4j.AcmeJsonResource
Returns the JSON representation of the resource data.
getJSON() - Method in class org.shredzone.acme4j.Metadata
Returns the JSON representation of the metadata.
getKeyIdentifier() - Method in class org.shredzone.acme4j.Account
Returns the key identifier of the external non-ACME account.
getKeyPair() - Method in class org.shredzone.acme4j.Login
Gets the KeyPair of the ACME account.
getLanguageHeader() - Method in class org.shredzone.acme4j.Session
Gets an Accept-Language header value that matches the current locale.
getLastModified() - Method in interface org.shredzone.acme4j.connector.Connection
Returns the content of the last-modified header, if present.
getLastModified() - Method in class org.shredzone.acme4j.connector.DefaultConnection
 
getLinks(String) - Method in interface org.shredzone.acme4j.connector.Connection
Gets one or more relation links from the header.
getLinks(String) - Method in class org.shredzone.acme4j.connector.DefaultConnection
 
getLocale() - Method in class org.shredzone.acme4j.Session
Gets the current locale of this session, or null if no special language is selected.
getLocation() - Method in class org.shredzone.acme4j.AcmeResource
Gets the resource's location.
getLocation() - Method in interface org.shredzone.acme4j.connector.Connection
Gets a location from the Location header.
getLocation() - Method in class org.shredzone.acme4j.connector.DefaultConnection
 
getLocation() - Method in exception org.shredzone.acme4j.exception.AcmeLazyLoadingException
Returns the location of the resource that could not be loaded.
getLogin() - Method in class org.shredzone.acme4j.AcmeResource
Gets the Login this resource is bound with.
getMetadata() - Method in class org.shredzone.acme4j.Session
Gets the metadata of the provider's directory.
getNonce() - Method in interface org.shredzone.acme4j.connector.Connection
Gets the nonce from the nonce header.
getNonce() - Method in class org.shredzone.acme4j.connector.DefaultConnection
 
getNonce() - Method in class org.shredzone.acme4j.Session
Gets the last base64 encoded nonce, or null if the session is new.
getNotAfter() - Method in class org.shredzone.acme4j.Order
Gets the "not after" date that was used for the order.
getNotBefore() - Method in class org.shredzone.acme4j.Order
Gets the "not before" date that was used for the order.
getOrders() - Method in class org.shredzone.acme4j.Account
Returns an Iterator of all Order belonging to this Account.
getProblem() - Method in exception org.shredzone.acme4j.exception.AcmeServerException
Returns the Problem that caused the exception
getProxySelector() - Method in class org.shredzone.acme4j.connector.NetworkSettings
Gets the ProxySelector to be used for connections.
getRandomProposal(TemporalAmount) - Method in class org.shredzone.acme4j.RenewalInfo
Returns a proposed Instant when the certificate related to this RenewalInfo should be renewed.
getReasonCode() - Method in enum class org.shredzone.acme4j.RevocationReason
Returns the reason code as defined in RFC 5280.
getRenewalInfo() - Method in class org.shredzone.acme4j.Certificate
Reads the RenewalInfo for this certificate.
getRenewalInfoLocation() - Method in class org.shredzone.acme4j.Certificate
Returns the location of the certificate's RenewalInfo.
getRenewalUniqueIdentifier(X509Certificate) - Static method in class org.shredzone.acme4j.toolbox.AcmeUtils
Returns the certificate's unique identifier for renewal.
getRetryAfter() - Method in class org.shredzone.acme4j.AcmeJsonResource
Gets an estimation when the resource status will change.
getRetryAfter() - Method in interface org.shredzone.acme4j.connector.Connection
Returns the Retry-After header if present.
getRetryAfter() - Method in class org.shredzone.acme4j.connector.DefaultConnection
 
getRetryAfter() - Method in exception org.shredzone.acme4j.exception.AcmeRateLimitedException
Returns the instant of time the request is expected to succeed again.
getRetryAfter() - Method in exception org.shredzone.acme4j.exception.AcmeRetryAfterException
Deprecated.
Returns the retry-after instant returned by the server.
getServerUri() - Method in class org.shredzone.acme4j.Session
Gets the ACME server URI of this session.
getSession() - Method in class org.shredzone.acme4j.AcmeResource
Gets the Session this resource is bound with.
getSession() - Method in class org.shredzone.acme4j.Login
Gets the Session that is used.
getStatus() - Method in class org.shredzone.acme4j.Account
Returns the current status of the account.
getStatus() - Method in class org.shredzone.acme4j.Authorization
Gets the authorization status.
getStatus() - Method in class org.shredzone.acme4j.challenge.Challenge
Returns the current status of the challenge.
getStatus() - Method in class org.shredzone.acme4j.Order
Returns the current status of the order.
getStatus() - Method in interface org.shredzone.acme4j.PollableResource
Returns the current status of the resource.
getSubProblems() - Method in class org.shredzone.acme4j.Problem
Returns a list of sub-problems.
getSuggestedWindowEnd() - Method in class org.shredzone.acme4j.RenewalInfo
Returns the ending Instant of the time window the CA recommends for certificate renewal.
getSuggestedWindowStart() - Method in class org.shredzone.acme4j.RenewalInfo
Returns the starting Instant of the time window the CA recommends for certificate renewal.
getTermsOfService() - Method in class org.shredzone.acme4j.Metadata
Returns an URI of the current terms of service, or empty if not available.
getTermsOfServiceAgreed() - Method in class org.shredzone.acme4j.Account
Returns if the user agreed to the terms of service.
getTermsOfServiceUri() - Method in exception org.shredzone.acme4j.exception.AcmeUserActionRequiredException
Returns the URI of the terms-of-service document to accept.
getTimeout() - Method in class org.shredzone.acme4j.connector.NetworkSettings
Gets the current network timeout.
getTitle() - Method in class org.shredzone.acme4j.Problem
Returns a short, human-readable summary of the problem.
getToken() - Method in class org.shredzone.acme4j.challenge.Http01Challenge
Returns the token to be used for this challenge.
getToken() - Method in class org.shredzone.acme4j.challenge.TokenChallenge
Gets the token.
getType() - Method in class org.shredzone.acme4j.challenge.Challenge
Returns the challenge type by name (e.g.
getType() - Method in exception org.shredzone.acme4j.exception.AcmeLazyLoadingException
Returns the AcmeResource type of the resource that could not be loaded.
getType() - Method in exception org.shredzone.acme4j.exception.AcmeServerException
Returns the error type.
getType() - Method in class org.shredzone.acme4j.Identifier
Returns the identifier type.
getType() - Method in class org.shredzone.acme4j.Problem
Returns the problem type.
getValidated() - Method in class org.shredzone.acme4j.challenge.Challenge
Returns the validation date, if returned by the server.
getValue() - Method in class org.shredzone.acme4j.Identifier
Returns the identifier value.
getWebsite() - Method in class org.shredzone.acme4j.Metadata
Returns an URL of a website providing more information about the ACME server.
GZIP_PROPERTY_NAME - Static variable in class org.shredzone.acme4j.connector.NetworkSettings
Name of the system property to control GZIP compression.

H

handleRetryAfter(String) - Method in interface org.shredzone.acme4j.connector.Connection
Deprecated.
hasDirectory() - Method in class org.shredzone.acme4j.Session
Returns true if a copy of the directory is present in a local cache.
hasExternalAccountBinding() - Method in class org.shredzone.acme4j.Account
Returns true if the account is bound to an external non-ACME account.
hashCode() - Method in class org.shredzone.acme4j.Identifier
 
hashCode() - Method in class org.shredzone.acme4j.toolbox.JSON.Value
 
hasNext() - Method in class org.shredzone.acme4j.connector.ResourceIterator
Checks if there is another object in the result.
hasRenewalInfo() - Method in class org.shredzone.acme4j.Certificate
Returns true if the CA provides renewal information.
hexEncode(byte[]) - Static method in class org.shredzone.acme4j.toolbox.AcmeUtils
Hex encodes the given byte array.
Http01Challenge - Class in org.shredzone.acme4j.challenge
Implements the "http-01" challenge.
Http01Challenge(Login, JSON) - Constructor for class org.shredzone.acme4j.challenge.Http01Challenge
Creates a new generic Http01Challenge object.
httpClient - Variable in class org.shredzone.acme4j.connector.DefaultConnection
 
httpConnector - Variable in class org.shredzone.acme4j.connector.DefaultConnection
 
HttpConnector - Class in org.shredzone.acme4j.connector
A generic HTTP connector.
HttpConnector(NetworkSettings) - Constructor for class org.shredzone.acme4j.connector.HttpConnector
Creates a new HttpConnector that is using the given NetworkSettings.

I

identifier(Identifier) - Method in class org.shredzone.acme4j.OrderBuilder
Adds an Identifier to the order.
Identifier - Class in org.shredzone.acme4j
Represents an identifier.
Identifier(String, String) - Constructor for class org.shredzone.acme4j.Identifier
Creates a new Identifier.
Identifier(JSON) - Constructor for class org.shredzone.acme4j.Identifier
Creates a new Identifier from the given JSON structure.
identifiers(Collection<Identifier>) - Method in class org.shredzone.acme4j.OrderBuilder
Adds a collection of Identifier to the order.
INVALID - Enum constant in enum class org.shredzone.acme4j.Status
An error or authorization/validation failure has occured.
invalidate() - Method in class org.shredzone.acme4j.AcmeJsonResource
Invalidates the state of this resource.
invalidate() - Method in class org.shredzone.acme4j.Order
 
ip(String) - Static method in class org.shredzone.acme4j.Identifier
Creates a new IP identifier for the given InetAddress.
ip(InetAddress) - Static method in class org.shredzone.acme4j.Identifier
Creates a new IP identifier for the given InetAddress.
isAutoRenewalEnabled() - Method in class org.shredzone.acme4j.Metadata
Returns whether the CA supports short-term auto-renewal of certificates.
isAutoRenewalGetAllowed() - Method in class org.shredzone.acme4j.Metadata
Returns whether the CA also allows to fetch STAR certificates via GET request.
isAutoRenewalGetEnabled() - Method in class org.shredzone.acme4j.Order
Returns true if STAR certificates from this order can also be fetched via GET requests.
isAutoRenewing() - Method in class org.shredzone.acme4j.Order
Checks if this order is auto-renewing, according to the ACME STAR specifications.
isCompressionEnabled() - Method in class org.shredzone.acme4j.connector.NetworkSettings
Checks if HTTP compression is enabled.
isEmpty() - Method in class org.shredzone.acme4j.toolbox.JSON.Array
Returns true if the array is empty.
isExternalAccountRequired() - Method in class org.shredzone.acme4j.Metadata
Returns whether an external account is required by this CA.
isIssuedBy(String) - Method in class org.shredzone.acme4j.Certificate
Checks if this certificate was issued by the given issuer name.
isPresent() - Method in class org.shredzone.acme4j.toolbox.JSON.Value
Checks if this value is null.
isSubdomainAuthAllowed() - Method in class org.shredzone.acme4j.Authorization
Returns true if certificates for subdomains can be issued according to RFC9444.
isSubdomainAuthAllowed() - Method in class org.shredzone.acme4j.Metadata
Returns whether the CA supports subdomain auth according to RFC9444.
isValid() - Method in class org.shredzone.acme4j.AcmeJsonResource
Checks if this resource is valid.
isValidBase64Url(String) - Static method in class org.shredzone.acme4j.toolbox.AcmeUtils
Validates that the given String is a valid base64url encoded value.
isWildcard() - Method in class org.shredzone.acme4j.Authorization
Returns true if this Authorization is related to a wildcard domain, false otherwise.
iterator() - Method in class org.shredzone.acme4j.toolbox.JSON.Array
Creates a new Iterator that iterates over the array JSON.Value.

J

JoseUtils - Class in org.shredzone.acme4j.toolbox
Utility class that takes care of all the JOSE stuff.
JSON - Class in org.shredzone.acme4j.toolbox
A model containing a JSON result.
JSON.Array - Class in org.shredzone.acme4j.toolbox
Represents a JSON array.
JSON.Value - Class in org.shredzone.acme4j.toolbox
A single JSON value.
JSONBuilder - Class in org.shredzone.acme4j.toolbox
Builder for JSON structures.
JSONBuilder() - Constructor for class org.shredzone.acme4j.toolbox.JSONBuilder
 
jwkToPublicKey(Map<String, Object>) - Static method in class org.shredzone.acme4j.toolbox.JoseUtils
Converts a JOSE JWK structure to a PublicKey.

K

KEY_CHANGE - Enum constant in enum class org.shredzone.acme4j.connector.Resource
 
KEY_COMPROMISE - Enum constant in enum class org.shredzone.acme4j.RevocationReason
 
KEY_ERROR - Static variable in class org.shredzone.acme4j.challenge.Challenge
 
KEY_STATUS - Static variable in class org.shredzone.acme4j.challenge.Challenge
 
KEY_TOKEN - Static variable in class org.shredzone.acme4j.challenge.TokenChallenge
 
KEY_TYPE - Static variable in class org.shredzone.acme4j.challenge.Challenge
 
KEY_URL - Static variable in class org.shredzone.acme4j.challenge.Challenge
 
KEY_VALIDATED - Static variable in class org.shredzone.acme4j.challenge.Challenge
 
keyAlgorithm(JsonWebKey) - Static method in class org.shredzone.acme4j.toolbox.JoseUtils
Analyzes the key used in the JsonWebKey, and returns the key algorithm identifier for JsonWebSignature.
keyAuthorizationFor(String) - Method in class org.shredzone.acme4j.challenge.TokenChallenge
Computes the key authorization for the given token.
KeyPairUtils - Class in org.shredzone.acme4j.util
Utility class offering convenience methods for KeyPair.
keySet() - Method in class org.shredzone.acme4j.toolbox.JSON
Returns a set of all keys of this object.

L

lastResponse - Variable in class org.shredzone.acme4j.connector.DefaultConnection
 
localeToLanguageHeader(Locale) - Static method in class org.shredzone.acme4j.toolbox.AcmeUtils
Converts the given locale to an Accept-Language header value.
login(URL, KeyPair) - Method in class org.shredzone.acme4j.Session
Logs into an existing account.
Login - Class in org.shredzone.acme4j
A Login into an account.
Login(URL, KeyPair, Session) - Constructor for class org.shredzone.acme4j.Login
Creates a new Login.

M

macKeyAlgorithm(SecretKey) - Static method in class org.shredzone.acme4j.toolbox.JoseUtils
Analyzes the SecretKey, and returns the key algorithm identifier for JsonWebSignature.
map(Function<JSON.Value, T>) - Method in class org.shredzone.acme4j.toolbox.JSON.Value
Returns this value as an Optional of the desired type, for further mapping and filtering.
Metadata - Class in org.shredzone.acme4j
A collection of metadata related to the CA provider.
Metadata(JSON) - Constructor for class org.shredzone.acme4j.Metadata
Creates a new Metadata instance.
modify() - Method in class org.shredzone.acme4j.Account
Modifies the account data of the account.

N

networkSettings() - Method in class org.shredzone.acme4j.Session
Returns the current NetworkSettings.
NetworkSettings - Class in org.shredzone.acme4j.connector
Contains network settings to be used for network connections.
NetworkSettings() - Constructor for class org.shredzone.acme4j.connector.NetworkSettings
 
NEW_ACCOUNT - Enum constant in enum class org.shredzone.acme4j.connector.Resource
 
NEW_AUTHZ - Enum constant in enum class org.shredzone.acme4j.connector.Resource
 
NEW_NONCE - Enum constant in enum class org.shredzone.acme4j.connector.Resource
 
NEW_ORDER - Enum constant in enum class org.shredzone.acme4j.connector.Resource
 
newOrder() - Method in class org.shredzone.acme4j.Account
Creates a builder for a new Order.
newOrder() - Method in class org.shredzone.acme4j.Login
Creates a builder for a new Order.
next() - Method in class org.shredzone.acme4j.connector.ResourceIterator
Returns the next object of the result.
notAfter(Instant) - Method in class org.shredzone.acme4j.OrderBuilder
Sets a "not after" date in the certificate.
notBefore(Instant) - Method in class org.shredzone.acme4j.OrderBuilder
Sets a "not before" date in the certificate.

O

object(String) - Method in class org.shredzone.acme4j.toolbox.JSONBuilder
Creates an object for the given key.
onFeature(String) - Method in class org.shredzone.acme4j.toolbox.JSON.Value
Returns this value.
onlyExisting() - Method in class org.shredzone.acme4j.AccountBuilder
Signals that only an existing account should be returned.
optional() - Method in class org.shredzone.acme4j.toolbox.JSON.Value
Returns this value as Optional, for further mapping and filtering.
Order - Class in org.shredzone.acme4j
A representation of a certificate order at the CA.
Order(Login, URL) - Constructor for class org.shredzone.acme4j.Order
 
OrderBuilder - Class in org.shredzone.acme4j
Start a new certificate Order.
OrderBuilder(Login) - Constructor for class org.shredzone.acme4j.OrderBuilder
Create a new OrderBuilder.
org.shredzone.acme4j - module org.shredzone.acme4j
This is the main module of the acme4j client.
org.shredzone.acme4j - package org.shredzone.acme4j
acme4j is a Java client for the ACME protocol.
org.shredzone.acme4j.challenge - package org.shredzone.acme4j.challenge
This package contains all standard challenges, as well as base classes for challenges that are proprietary to a CA.
org.shredzone.acme4j.connector - package org.shredzone.acme4j.connector
This package contains internal classes for connection to the CA, and for handling the requests and responses.
org.shredzone.acme4j.exception - package org.shredzone.acme4j.exception
This package contains all exceptions that can be thrown by acme4j.
org.shredzone.acme4j.provider - package org.shredzone.acme4j.provider
Acme Providers are the link between acme4j and the ACME server.
org.shredzone.acme4j.toolbox - package org.shredzone.acme4j.toolbox
Internal toolbox.
org.shredzone.acme4j.util - package org.shredzone.acme4j.util
A collection of utility classes.

P

parse(InputStream) - Static method in class org.shredzone.acme4j.toolbox.JSON
Parses JSON from an InputStream.
parse(String) - Static method in enum class org.shredzone.acme4j.Status
Parses the string and returns a corresponding Status object.
parse(String) - Static method in class org.shredzone.acme4j.toolbox.JSON
Parses JSON from a String.
parseTimestamp(String) - Static method in class org.shredzone.acme4j.toolbox.AcmeUtils
Parses a RFC 3339 formatted date.
path() - Method in enum class org.shredzone.acme4j.connector.Resource
Returns the key name in the directory.
PENDING - Enum constant in enum class org.shredzone.acme4j.Status
The server has created the resource, and is waiting for the client to process it.
PollableResource - Interface in org.shredzone.acme4j
Marks an ACME Resource with a pollable status.
preAuthorize(Identifier) - Method in class org.shredzone.acme4j.Account
Pre-authorizes an Identifier.
preAuthorizeDomain(String) - Method in class org.shredzone.acme4j.Account
Pre-authorizes a domain.
prepareResponse(JSONBuilder) - Method in class org.shredzone.acme4j.challenge.Challenge
Prepares the response message for triggering the challenge.
PRIVATE_KEY - Enum constant in enum class org.shredzone.acme4j.toolbox.AcmeUtils.PemLabel
 
PRIVILEGE_WITHDRAWN - Enum constant in enum class org.shredzone.acme4j.RevocationReason
 
Problem - Class in org.shredzone.acme4j
A JSON problem.
Problem(JSON, URL) - Constructor for class org.shredzone.acme4j.Problem
Creates a new Problem object.
PROCESSING - Enum constant in enum class org.shredzone.acme4j.Status
The server is processing the resource.
provider() - Method in class org.shredzone.acme4j.Session
Returns the AcmeProvider that is used for this session.
PUBLIC_KEY - Enum constant in enum class org.shredzone.acme4j.toolbox.AcmeUtils.PemLabel
 
publicKeyToJWK(PublicKey) - Static method in class org.shredzone.acme4j.toolbox.JoseUtils
Converts a PublicKey to a JOSE JWK structure.
purgeDirectoryCache() - Method in class org.shredzone.acme4j.Session
Purges the directory cache.
put(String, Object) - Method in class org.shredzone.acme4j.toolbox.JSONBuilder
Puts a property.
put(String, Duration) - Method in class org.shredzone.acme4j.toolbox.JSONBuilder
Puts a Duration to the JSON.
put(String, Instant) - Method in class org.shredzone.acme4j.toolbox.JSONBuilder
Puts an Instant to the JSON.
putBase64(String, byte[]) - Method in class org.shredzone.acme4j.toolbox.JSONBuilder
Puts binary data to the JSON.
putKey(String, PublicKey) - Method in class org.shredzone.acme4j.toolbox.JSONBuilder
Puts a Key into the claim.

R

read() - Method in class org.shredzone.acme4j.connector.TrimmingInputStream
 
readCertificates() - Method in interface org.shredzone.acme4j.connector.Connection
Reads a certificate and its chain of issuers.
readCertificates() - Method in class org.shredzone.acme4j.connector.DefaultConnection
 
readCSR(InputStream) - Static method in class org.shredzone.acme4j.util.CertificateUtils
Reads a CSR PEM file.
readJsonResponse() - Method in interface org.shredzone.acme4j.connector.Connection
Reads a server response as JSON object.
readJsonResponse() - Method in class org.shredzone.acme4j.connector.DefaultConnection
 
readKeyPair(Reader) - Static method in class org.shredzone.acme4j.util.KeyPairUtils
Reads a KeyPair from a PEM file.
READY - Enum constant in enum class org.shredzone.acme4j.Status
The Order is ready to be finalized.
rebind(Login) - Method in class org.shredzone.acme4j.AcmeResource
Rebinds this resource to a Login.
RECORD_NAME_PREFIX - Static variable in class org.shredzone.acme4j.challenge.Dns01Challenge
The prefix of the domain name to be used for the DNS TXT record.
remove() - Method in class org.shredzone.acme4j.connector.ResourceIterator
Unsupported operation, only here to satisfy the Iterator interface.
REMOVE_FROM_CRL - Enum constant in enum class org.shredzone.acme4j.RevocationReason
 
RENEWAL_INFO - Enum constant in enum class org.shredzone.acme4j.connector.Resource
 
RenewalInfo - Class in org.shredzone.acme4j
Renewal Information of a certificate.
RenewalInfo(Login, URL) - Constructor for class org.shredzone.acme4j.RenewalInfo
 
renewalIsNotRequired(Instant) - Method in class org.shredzone.acme4j.RenewalInfo
Checks if the given Instant is before the suggested time window, so a certificate renewal is not required yet.
renewalIsOverdue(Instant) - Method in class org.shredzone.acme4j.RenewalInfo
Checks if the given Instant is past the time window, and a certificate renewal is overdue.
renewalIsRecommended(Instant) - Method in class org.shredzone.acme4j.RenewalInfo
Checks if the given Instant is within the suggested time window, and a certificate renewal is recommended.
replaces(String) - Method in class org.shredzone.acme4j.OrderBuilder
Notifies the CA that the ordered certificate will replace a previously issued certificate.
replaces(X509Certificate) - Method in class org.shredzone.acme4j.OrderBuilder
Notifies the CA that the ordered certificate will replace a previously issued certificate.
replaces(Certificate) - Method in class org.shredzone.acme4j.OrderBuilder
Notifies the CA that the ordered certificate will replace a previously issued certificate.
resetNonce(Session) - Method in interface org.shredzone.acme4j.connector.Connection
Resets the session nonce, by fetching a new one.
resetNonce(Session) - Method in class org.shredzone.acme4j.connector.DefaultConnection
 
resolve(URI) - Method in interface org.shredzone.acme4j.provider.AcmeProvider
Resolves the server URI and returns the matching directory URL.
resolve(URI) - Method in class org.shredzone.acme4j.provider.GenericAcmeProvider
 
Resource - Enum Class in org.shredzone.acme4j.connector
Enumeration of standard resources, and their key name in the CA's directory.
ResourceIterator<T extends AcmeResource> - Class in org.shredzone.acme4j.connector
An Iterator that fetches a batch of URLs from the ACME server, and generates AcmeResource instances.
ResourceIterator(Login, String, URL, BiFunction<Login, URL, T>) - Constructor for class org.shredzone.acme4j.connector.ResourceIterator
Creates a new ResourceIterator.
resourceUrl(Resource) - Method in class org.shredzone.acme4j.Session
Gets the URL of the given Resource.
resourceUrlOptional(Resource) - Method in class org.shredzone.acme4j.Session
Gets the URL of the given Resource.
RevocationReason - Enum Class in org.shredzone.acme4j
An enumeration of revocation reasons.
revoke() - Method in class org.shredzone.acme4j.Certificate
Revokes this certificate.
revoke(Login, X509Certificate, RevocationReason) - Static method in class org.shredzone.acme4j.Certificate
Revoke a certificate.
revoke(RevocationReason) - Method in class org.shredzone.acme4j.Certificate
Revokes this certificate.
revoke(Session, KeyPair, X509Certificate, RevocationReason) - Static method in class org.shredzone.acme4j.Certificate
Revoke a certificate.
REVOKE_CERT - Enum constant in enum class org.shredzone.acme4j.connector.Resource
 
REVOKED - Enum constant in enum class org.shredzone.acme4j.Status
The Authorization has been revoked by the server.

S

sendCertificateRequest(URL, Login) - Method in interface org.shredzone.acme4j.connector.Connection
Sends a signed POST-as-GET request for a certificate resource.
sendCertificateRequest(URL, Login) - Method in class org.shredzone.acme4j.connector.DefaultConnection
 
sendRequest(URL, Session, ZonedDateTime) - Method in interface org.shredzone.acme4j.connector.Connection
Sends a simple GET request.
sendRequest(URL, Session, ZonedDateTime) - Method in class org.shredzone.acme4j.connector.DefaultConnection
 
sendRequest(Session, URL, Consumer<HttpRequest.Builder>) - Method in class org.shredzone.acme4j.connector.DefaultConnection
Sends a HTTP request via http client.
sendSignedPostAsGetRequest(URL, Login) - Method in interface org.shredzone.acme4j.connector.Connection
Sends a signed POST-as-GET request.
sendSignedPostAsGetRequest(URL, Login) - Method in class org.shredzone.acme4j.connector.DefaultConnection
 
sendSignedRequest(URL, JSONBuilder, Login) - Method in interface org.shredzone.acme4j.connector.Connection
Sends a signed POST request.
sendSignedRequest(URL, JSONBuilder, Login) - Method in class org.shredzone.acme4j.connector.DefaultConnection
 
sendSignedRequest(URL, JSONBuilder, Session, KeyPair) - Method in interface org.shredzone.acme4j.connector.Connection
Sends a signed POST request.
sendSignedRequest(URL, JSONBuilder, Session, KeyPair) - Method in class org.shredzone.acme4j.connector.DefaultConnection
 
sendSignedRequest(URL, JSONBuilder, Session, KeyPair, URL, String) - Method in class org.shredzone.acme4j.connector.DefaultConnection
Sends a signed POST request.
Session - Class in org.shredzone.acme4j
A Session tracks the entire communication with a CA.
Session(String) - Constructor for class org.shredzone.acme4j.Session
Creates a new Session.
Session(URI) - Constructor for class org.shredzone.acme4j.Session
Creates a new Session.
Session(URI, AcmeProvider) - Constructor for class org.shredzone.acme4j.Session
Creates a new Session using the given AcmeProvider.
setAuthenticator(Authenticator) - Method in class org.shredzone.acme4j.connector.NetworkSettings
Sets an Authenticator to be used if HTTP authentication is needed (e.g.
setCommonName(String) - Method in class org.shredzone.acme4j.util.CSRBuilder
Sets the common name.
setCompressionEnabled(boolean) - Method in class org.shredzone.acme4j.connector.NetworkSettings
Sets if HTTP compression is enabled.
setCountry(String) - Method in class org.shredzone.acme4j.util.CSRBuilder
Sets the country.
setDirectoryExpires(ZonedDateTime) - Method in class org.shredzone.acme4j.Session
Sets the date when the current directory will expire.
setDirectoryLastModified(ZonedDateTime) - Method in class org.shredzone.acme4j.Session
Sets the date when the directory has been modified the last time.
setJSON(JSON) - Method in class org.shredzone.acme4j.AcmeJsonResource
Sets the JSON representation of the resource data.
setJSON(JSON) - Method in class org.shredzone.acme4j.challenge.Challenge
 
setKeyPair(KeyPair) - Method in class org.shredzone.acme4j.Login
Sets a different KeyPair.
setLocale(Locale) - Method in class org.shredzone.acme4j.Session
Sets the locale used in this session.
setLocality(String) - Method in class org.shredzone.acme4j.util.CSRBuilder
Sets the city or locality.
setNonce(String) - Method in class org.shredzone.acme4j.Session
Sets the base64 encoded nonce received by the server.
setOrganization(String) - Method in class org.shredzone.acme4j.util.CSRBuilder
Sets the organization.
setOrganizationalUnit(String) - Method in class org.shredzone.acme4j.util.CSRBuilder
Sets the organizational unit.
setProxySelector(ProxySelector) - Method in class org.shredzone.acme4j.connector.NetworkSettings
Sets a ProxySelector that is to be used for all connections.
setRetryAfter(Instant) - Method in class org.shredzone.acme4j.AcmeJsonResource
Sets a Retry-After instant.
setState(String) - Method in class org.shredzone.acme4j.util.CSRBuilder
Sets the state or province.
setTimeout(Duration) - Method in class org.shredzone.acme4j.connector.NetworkSettings
Sets the network timeout to be used for connections.
sha256hash(String) - Static method in class org.shredzone.acme4j.toolbox.AcmeUtils
Computes a SHA-256 hash of the given string.
sign(KeyPair) - Method in class org.shredzone.acme4j.util.CSRBuilder
Signs the completed CSR.
size() - Method in class org.shredzone.acme4j.toolbox.JSON.Array
Returns the array size.
Status - Enum Class in org.shredzone.acme4j
An enumeration of status codes of challenges and authorizations.
stream() - Method in class org.shredzone.acme4j.toolbox.JSON.Array
Returns a stream of values.
stripErrorPrefix(String) - Static method in class org.shredzone.acme4j.toolbox.AcmeUtils
Strips the acme error prefix from the error string.
SUPERSEDED - Enum constant in enum class org.shredzone.acme4j.RevocationReason
 

T

thumbprint(PublicKey) - Static method in class org.shredzone.acme4j.toolbox.JoseUtils
Computes a thumbprint of the given public key.
TlsAlpn01Challenge - Class in org.shredzone.acme4j.challenge
Implements the "tls-alpn-01" challenge.
TlsAlpn01Challenge(Login, JSON) - Constructor for class org.shredzone.acme4j.challenge.TlsAlpn01Challenge
Creates a new generic TlsAlpn01Challenge object.
toAce(String) - Static method in class org.shredzone.acme4j.toolbox.AcmeUtils
ASCII encodes a domain name.
toJSON() - Method in class org.shredzone.acme4j.toolbox.JSONBuilder
Returns a JSON representation of the current state.
TokenChallenge - Class in org.shredzone.acme4j.challenge
A generic extension of Challenge that handles challenges with a token and keyAuthorization.
TokenChallenge(Login, JSON) - Constructor for class org.shredzone.acme4j.challenge.TokenChallenge
Creates a new generic TokenChallenge object.
toMap() - Method in class org.shredzone.acme4j.Identifier
Returns the identifier as JSON map.
toMap() - Method in class org.shredzone.acme4j.toolbox.JSON
Returns the content as unmodifiable Map.
toMap() - Method in class org.shredzone.acme4j.toolbox.JSONBuilder
Returns a Map representation of the current state.
toRRName(String) - Static method in class org.shredzone.acme4j.challenge.Dns01Challenge
Converts a domain identifier to the Resource Record name to be used for the DNS TXT record.
toRRName(Identifier) - Static method in class org.shredzone.acme4j.challenge.Dns01Challenge
Converts a domain identifier to the Resource Record name to be used for the DNS TXT record.
toString() - Method in exception org.shredzone.acme4j.exception.AcmeUserActionRequiredException
 
toString() - Method in class org.shredzone.acme4j.Identifier
 
toString() - Method in class org.shredzone.acme4j.Problem
Returns a human-readable description of the problem, that is as specific as possible.
toString() - Method in enum class org.shredzone.acme4j.toolbox.AcmeUtils.PemLabel
 
toString() - Method in class org.shredzone.acme4j.toolbox.JSON
Returns the content as JSON string.
toString() - Method in class org.shredzone.acme4j.toolbox.JSONBuilder
Returns a JSON string representation of the current state.
toString() - Method in class org.shredzone.acme4j.util.CSRBuilder
 
trigger() - Method in class org.shredzone.acme4j.challenge.Challenge
Triggers this Challenge.
TrimmingInputStream - Class in org.shredzone.acme4j.connector
Normalizes line separators in an InputStream.
TrimmingInputStream(InputStream) - Constructor for class org.shredzone.acme4j.connector.TrimmingInputStream
Creates a new TrimmingInputStream.
TYPE - Static variable in class org.shredzone.acme4j.challenge.Dns01Challenge
Challenge type name: "dns-01"
TYPE - Static variable in class org.shredzone.acme4j.challenge.Http01Challenge
Challenge type name: "http-01"
TYPE - Static variable in class org.shredzone.acme4j.challenge.TlsAlpn01Challenge
Challenge type name: "tls-alpn-01"
TYPE_DNS - Static variable in class org.shredzone.acme4j.Identifier
Type constant for DNS identifiers.
TYPE_IP - Static variable in class org.shredzone.acme4j.Identifier
Type constant for IP identifiers.

U

UNKNOWN - Enum constant in enum class org.shredzone.acme4j.Status
The server did not provide a status, or the provided status is not a specified ACME status.
UNSPECIFIED - Enum constant in enum class org.shredzone.acme4j.RevocationReason
 
update() - Method in class org.shredzone.acme4j.AcmeJsonResource
Deprecated.
Use AcmeJsonResource.fetch() instead. It returns the retry-after value as Optional instead of throwing an AcmeRetryAfterException. This method will be removed in a future version.
useKeyPair(KeyPair) - Method in class org.shredzone.acme4j.AccountBuilder
Sets the KeyPair to be used for this account.

V

VALID - Enum constant in enum class org.shredzone.acme4j.Status
The resource is valid and can be used as intended.
validateContact(URI) - Static method in class org.shredzone.acme4j.toolbox.AcmeUtils
Validates a contact URI.
value() - Element in annotation interface org.shredzone.acme4j.provider.ChallengeType
Challenge type.
valueOf(String) - Static method in enum class org.shredzone.acme4j.connector.Resource
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.shredzone.acme4j.RevocationReason
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.shredzone.acme4j.Status
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.shredzone.acme4j.toolbox.AcmeUtils.PemLabel
Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.shredzone.acme4j.connector.Resource
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.shredzone.acme4j.RevocationReason
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.shredzone.acme4j.Status
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.shredzone.acme4j.toolbox.AcmeUtils.PemLabel
Returns an array containing the constants of this enum class, in the order they are declared.

W

waitForCompletion(Duration) - Method in class org.shredzone.acme4j.Authorization
Waits until the authorization is completed.
waitForCompletion(Duration) - Method in class org.shredzone.acme4j.challenge.Challenge
Waits until the challenge is completed.
waitForCompletion(Duration) - Method in class org.shredzone.acme4j.Order
Waits until the order finalization is completed.
waitForStatus(Set<Status>, Duration) - Method in interface org.shredzone.acme4j.PollableResource
Waits until a terminal status has been reached, by polling until one of the given status or the given timeout has been reached.
waitUntilReady(Duration) - Method in class org.shredzone.acme4j.Order
Waits until the order is ready for finalization.
withAncestorDomain(String) - Method in class org.shredzone.acme4j.Identifier
Sets an ancestor domain, as required in RFC-9444.
withKeyIdentifier(String, String) - Method in class org.shredzone.acme4j.AccountBuilder
Sets a Key Identifier and MAC key provided by the CA.
withKeyIdentifier(String, SecretKey) - Method in class org.shredzone.acme4j.AccountBuilder
Sets a Key Identifier and MAC key provided by the CA.
withMacAlgorithm(String) - Method in class org.shredzone.acme4j.AccountBuilder
Sets the MAC key algorithm that is provided by the CA.
write(OutputStream) - Method in class org.shredzone.acme4j.util.CSRBuilder
Writes the signed certificate request to an OutputStream.
write(Writer) - Method in class org.shredzone.acme4j.util.CSRBuilder
Writes the signed certificate request to a Writer.
writeCertificate(Writer) - Method in class org.shredzone.acme4j.Certificate
Writes the certificate to the given writer.
writeKeyPair(KeyPair, Writer) - Static method in class org.shredzone.acme4j.util.KeyPairUtils
Writes a KeyPair PEM file.
writePublicKey(PublicKey, Writer) - Static method in class org.shredzone.acme4j.util.KeyPairUtils
Writes a PublicKey as PEM file.
writeToPem(byte[], AcmeUtils.PemLabel, Writer) - Static method in class org.shredzone.acme4j.toolbox.AcmeUtils
Writes an encoded key or certificate to a file in PEM format.
A B C D E F G H I J K L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form