Modul org.shredzone.acme4j
Package org.shredzone.acme4j

Schnittstelle PollableResource

Alle bekannten Implementierungsklassen:
Authorization, Challenge, Dns01Challenge, Http01Challenge, Order, TlsAlpn01Challenge, TokenChallenge
public interface PollableResource
Marks an ACME Resource with a pollable status.

The resource provides a status, and a method for updating the internal cache to read the current status from the server.

Seit:
3.4.0

  • Feldübersicht

    Felder
    Modifizierer und Typ
    Feld
    Beschreibung
    static final Duration
    DEFAULT_RETRY_AFTER
    Default delay between status polls if there is no Retry-After header.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    Optional<Instant>
    fetch()
    Fetches the current status from the server.
    Status
    getStatus()
    Returns the current status of the resource.
    default Status
    waitForStatus(Set<Status> statusSet, Duration timeout)
    Waits until a terminal status has been reached, by polling until one of the given status or the given timeout has been reached.

  • Felddetails

    • DEFAULT_RETRY_AFTER

      static final Duration DEFAULT_RETRY_AFTER
      Default delay between status polls if there is no Retry-After header.

  • Methodendetails

    • getStatus

      Status getStatus()
      Returns the current status of the resource.

    • fetch

      Optional<Instant> fetch() throws AcmeException
      Fetches the current status from the server.
      Gibt zurück:
      Retry-After time, if given by the CA, otherwise empty.
      Löst aus:
      AcmeException

    • waitForStatus

      default Status waitForStatus(Set<Status> statusSet, Duration timeout) throws AcmeException, InterruptedException
      Waits until a terminal status has been reached, by polling until one of the given status or the given timeout has been reached. This call honors the Retry-After header if set by the CA.

      This method is synchronous and blocks the current thread.

      If the resource is already in a terminal status, the method returns immediately.

      Parameter:
      statusSet - Set of Status that are accepted as terminal
      timeout - Timeout until a terminal status must have been reached
      Gibt zurück:
      Status that was reached
      Löst aus:
      AcmeException
      InterruptedException