- AbstractAcmeProvider - Class in org.shredzone.acme4j.provider
-
- AbstractAcmeProvider() - Constructor for class org.shredzone.acme4j.provider.AbstractAcmeProvider
-
- accept(int...) - Method in interface org.shredzone.acme4j.connector.Connection
-
Checks if the HTTP response status is in the given list of acceptable HTTP states,
otherwise raises an
AcmeException
matching the error.
- accept(int...) - Method in class org.shredzone.acme4j.connector.DefaultConnection
-
- 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
-
- acceptAgreement(Registration, URI) - Method in class org.shredzone.acme4j.ClientTest
-
Presents the user a link to the Terms of Service, and asks for confirmation.
- acceptChallenge(String) - Method in class org.shredzone.acme4j.ClientTest
-
Presents the instructions for preparing the challenge validation, and waits for
dismissal.
- 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
-
- accepts(URI) - Method in class org.shredzone.acme4j.provider.letsencrypt.LetsEncryptAcmeProvider
-
- AcmeAgreementRequiredException - Exception in org.shredzone.acme4j.exception
-
An exception that is thrown when the client needs to accept the terms of service in
order to continue.
- AcmeAgreementRequiredException(String, String, URI, URI) - Constructor for exception org.shredzone.acme4j.exception.AcmeAgreementRequiredException
-
- AcmeConflictException - Exception in org.shredzone.acme4j.exception
-
An exception that is thrown when there is a conflict with the request.
- AcmeConflictException(String, URL) - Constructor for exception org.shredzone.acme4j.exception.AcmeConflictException
-
- AcmeException - Exception in org.shredzone.acme4j.exception
-
A generic ACME exception.
- AcmeException() - Constructor for exception org.shredzone.acme4j.exception.AcmeException
-
- AcmeException(String) - Constructor for exception org.shredzone.acme4j.exception.AcmeException
-
- AcmeException(String, Throwable) - Constructor for exception org.shredzone.acme4j.exception.AcmeException
-
- AcmeNetworkException - Exception in org.shredzone.acme4j.exception
-
This exception is thrown when a network error occured while communicating with the
server.
- AcmeNetworkException(IOException) - Constructor for exception org.shredzone.acme4j.exception.AcmeNetworkException
-
- AcmeProtocolException - Exception in org.shredzone.acme4j.exception
-
This runtime exception is thrown on ACME protocol errors that should not occur.
- AcmeProtocolException(String) - Constructor for exception org.shredzone.acme4j.exception.AcmeProtocolException
-
- AcmeProtocolException(String, Throwable) - Constructor for exception org.shredzone.acme4j.exception.AcmeProtocolException
-
- AcmeProvider - Interface in org.shredzone.acme4j.provider
-
An
AcmeProvider
provides methods to be used for communicating with the ACME
server.
- AcmeRateLimitExceededException - Exception in org.shredzone.acme4j.exception
-
An exception that is thrown when a rate limit was exceeded.
- AcmeRateLimitExceededException(String, String, Instant, Collection<URI>) - Constructor for exception org.shredzone.acme4j.exception.AcmeRateLimitExceededException
-
- AcmeResource - Class in org.shredzone.acme4j
-
A generic ACME resource.
- AcmeResource(Session) - Constructor for class org.shredzone.acme4j.AcmeResource
-
- AcmeRetryAfterException - Exception in org.shredzone.acme4j.exception
-
This exception is thrown when a server side process has not been completed yet, and the
server returned an estimated retry date.
- AcmeRetryAfterException(String, Instant) - Constructor for exception org.shredzone.acme4j.exception.AcmeRetryAfterException
-
- AcmeServerException - Exception in org.shredzone.acme4j.exception
-
An exception that is thrown when the ACME server returned an error.
- AcmeServerException(String, String) - Constructor for exception org.shredzone.acme4j.exception.AcmeServerException
-
- AcmeUnauthorizedException - Exception in org.shredzone.acme4j.exception
-
An exception that is thrown when the client is not authorized.
- AcmeUnauthorizedException(String, String) - Constructor for exception org.shredzone.acme4j.exception.AcmeUnauthorizedException
-
- AcmeUtils - Class in org.shredzone.acme4j.toolbox
-
Contains utility methods that are frequently used for the ACME protocol.
- addContact(URI) - Method in class org.shredzone.acme4j.Registration.EditableRegistration
-
Adds a new Contact to the registration.
- addContact(String) - Method in class org.shredzone.acme4j.Registration.EditableRegistration
-
Adds a new Contact to the registration.
- addContact(URI) - Method in class org.shredzone.acme4j.RegistrationBuilder
-
Add a contact URI to the list of contacts.
- addContact(String) - Method in class org.shredzone.acme4j.RegistrationBuilder
-
Add a contact address to the list of contacts.
- addDomain(String) - Method in class org.shredzone.acme4j.util.CSRBuilder
-
Adds a domain name to the CSR.
- addDomains(Collection<String>) - Method in class org.shredzone.acme4j.util.CSRBuilder
-
- addDomains(String...) - Method in class org.shredzone.acme4j.util.CSRBuilder
-
Adds multiple domain names.
- array(String, Object...) - 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.
- asInstant() - Method in class org.shredzone.acme4j.toolbox.JSON.Value
-
- 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 object, to access custom fields.
- asObject() - Method in class org.shredzone.acme4j.toolbox.JSON.Value
-
Returns the value as JSON object.
- asProblem() - Method in class org.shredzone.acme4j.toolbox.JSON.Value
-
- asString() - Method in class org.shredzone.acme4j.toolbox.JSON.Value
-
- 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(Session, URL) - Constructor for class org.shredzone.acme4j.Authorization
-
- authorize() - Method in class org.shredzone.acme4j.challenge.Challenge
-
Callback that is invoked when the challenge is supposed to compute its
authorization data.
- authorize() - Method in class org.shredzone.acme4j.challenge.TokenChallenge
-
- authorizeDomain(String) - Method in class org.shredzone.acme4j.Registration
-
Authorizes a domain.
- GenericAcmeProvider - Class in org.shredzone.acme4j.provider
-
- GenericAcmeProvider() - Constructor for class org.shredzone.acme4j.provider.GenericAcmeProvider
-
- get(int) - Method in class org.shredzone.acme4j.toolbox.JSON.Array
-
- get(String) - Method in class org.shredzone.acme4j.toolbox.JSON
-
- getAcmeErrorType() - Method in exception org.shredzone.acme4j.exception.AcmeServerException
-
Returns the ACME error type.
- getAgreement() - Method in class org.shredzone.acme4j.Registration
-
Returns the URI of the agreement document the user is required to accept.
- getAgreementUri() - Method in exception org.shredzone.acme4j.exception.AcmeAgreementRequiredException
-
Returns the
URI
of the agreement document to accept, or
null
if
the server did not provide a link to such a document.
- getAuthorization() - Method in class org.shredzone.acme4j.challenge.Http01Challenge
-
Returns the authorization string to be used for the response.
- getAuthorization() - Method in class org.shredzone.acme4j.challenge.TokenChallenge
-
Gets the authorization.
- getAuthorizations() - Method in class org.shredzone.acme4j.Registration
-
- 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.
- getCertificates() - Method in class org.shredzone.acme4j.Registration
-
- getChainLocation() - Method in class org.shredzone.acme4j.Certificate
-
Returns the URL of the certificate chain.
- getChallenges() - Method in class org.shredzone.acme4j.Authorization
-
Gets a list of all challenges offered by the server.
- getCombinations() - Method in class org.shredzone.acme4j.Authorization
-
Gets all combinations of challenges supported by the server.
- getContacts() - Method in class org.shredzone.acme4j.Registration.EditableRegistration
-
Returns the list of all contact URIs for modification.
- getContacts() - Method in class org.shredzone.acme4j.Registration
-
List of 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 human-readable description 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.
- getDocuments() - Method in exception org.shredzone.acme4j.exception.AcmeRateLimitExceededException
-
Collection of URIs pointing to documents about the rate limit that was hit.
- getDomain() - Method in class org.shredzone.acme4j.Authorization
-
Gets the domain name to be authorized.
- 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 the reason why the challenge failed, if returned by the server.
- getExpires() - Method in class org.shredzone.acme4j.Authorization
-
Gets the expiry date of the authorization, if set by the server.
- getInstance() - Method in exception org.shredzone.acme4j.exception.AcmeAgreementRequiredException
-
Returns the
URI
of a document showing a human how to agree to the terms and
conditions, or
null
if the server did not provide such a link.
- getJSON() - Method in class org.shredzone.acme4j.challenge.Challenge
-
Returns the JSON representation of the challenge data.
- getJSON() - Method in class org.shredzone.acme4j.Metadata
-
Returns the JSON representation of the metadata.
- getKeyPair() - Method in class org.shredzone.acme4j.Session
-
Gets the
KeyPair
of the ACME account.
- getLink(String) - Method in interface org.shredzone.acme4j.connector.Connection
-
Gets a relation link from the header.
- getLink(String) - Method in class org.shredzone.acme4j.connector.DefaultConnection
-
- getLinkAsURI(String) - Method in interface org.shredzone.acme4j.connector.Connection
-
Gets a relation link from the header.
- getLinkAsURI(String) - Method in class org.shredzone.acme4j.connector.DefaultConnection
-
- getLocale() - Method in class org.shredzone.acme4j.Session
-
Gets the current locale of this session.
- getLocation() - Method in class org.shredzone.acme4j.AcmeResource
-
Gets the resource's location.
- getLocation() - Method in class org.shredzone.acme4j.challenge.Challenge
-
Returns the location
URL
of the challenge.
- 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.AcmeConflictException
-
Location of the conflicting resource.
- getMetadata() - Method in class org.shredzone.acme4j.Session
-
Gets the metadata of the provider's directory.
- getNonce() - Method in class org.shredzone.acme4j.Session
-
Gets the last nonce, or null
if the session is new.
- getReasonCode() - Method in enum org.shredzone.acme4j.RevocationReason
-
Returns the reason code as defined in RFC 5280.
- getRetryAfter() - Method in exception org.shredzone.acme4j.exception.AcmeRateLimitExceededException
-
Returns the moment the request is expected to succeed again.
- getRetryAfter() - Method in exception org.shredzone.acme4j.exception.AcmeRetryAfterException
-
Returns the retry-after date 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.
- 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.Registration
-
Returns the current status of the registration.
- getTermsOfService() - Method in class org.shredzone.acme4j.Metadata
-
Returns an
URI
to the current terms of service, or
null
if not
available.
- 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.AcmeServerException
-
Returns the error 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.
- getWebsite() - Method in class org.shredzone.acme4j.Metadata
-
Returns an
URI
to a website providing more information about the ACME
server.