java.lang.Object

org.shredzone.acme4j.connector.DefaultConnection

Alle implementierten Schnittstellen:: AutoCloseable, Connection

public class DefaultConnection extends Object implements Connection

Default implementation of Connection. It communicates with the ACME server via HTTP, with a client that is provided by the given HttpConnector.

Feldübersicht

Felder

Modifizierer und Typ

Feld

Beschreibung

protected final HttpClient

httpClient

protected final HttpConnector

httpConnector

protected HttpResponse<InputStream>

lastResponse
Konstruktorübersicht

Konstruktoren

Konstruktor

Beschreibung

DefaultConnection(HttpConnector httpConnector)

Creates a new DefaultConnection.
Methodenübersicht

Modifizierer und Typ

Methode

Beschreibung

void

close()

Closes the Connection, releasing all resources.

Optional<ZonedDateTime>

getExpiration()

Returns the expiration date of the resource, if present.

Optional<ZonedDateTime>

getLastModified()

Returns the content of the last-modified header, if present.

Collection<URL>

getLinks(String relation)

Gets one or more relation links from the header.

URL

getLocation()

Gets a location from the Location header.

Optional<String>

getNonce()

Gets the nonce from the nonce header.

Optional<Instant>

getRetryAfter()

Returns the Retry-After header if present.

List<X509Certificate>

readCertificates()

Reads a certificate and its chain of issuers.

JSON

readJsonResponse()

Reads a server response as JSON object.

void

resetNonce(Session session)

Resets the session nonce, by fetching a new one.

int

sendCertificateRequest(URL url, Login login)

Sends a signed POST-as-GET request for a certificate resource.

int

sendRequest(URL url, Session session, ZonedDateTime ifModifiedSince)

Sends a simple GET request.

protected void

sendRequest(Session session, URL url, Consumer<HttpRequest.Builder> body)

Sends a HTTP request via http client.

int

sendSignedPostAsGetRequest(URL url, Login login)

Sends a signed POST-as-GET request.

int

sendSignedRequest(URL url, JSONBuilder claims, Login login)

Sends a signed POST request.

int

sendSignedRequest(URL url, JSONBuilder claims, Session session, KeyPair keypair)

Sends a signed POST request.

protected int

sendSignedRequest(URL url, JSONBuilder claims, Session session, KeyPair keypair, URL accountLocation, String accept)

Sends a signed POST request.

Von Klasse geerbte Methoden java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Von Schnittstelle geerbte Methoden org.shredzone.acme4j.connector.Connection
handleRetryAfter

Felddetails
- httpConnector
  
  protected final HttpConnector httpConnector
- httpClient
  
  protected final HttpClient httpClient
- lastResponse
  
  @Nullable protected HttpResponse<InputStream> lastResponse
Konstruktordetails
- DefaultConnection
  
  public DefaultConnection(HttpConnector httpConnector)
  
  Creates a new DefaultConnection.
  
  Parameter:
  
  httpConnector - HttpConnector to be used for HTTP connections
Methodendetails
- resetNonce
  
  public void resetNonce(Session session) throws AcmeException
  
  Beschreibung aus Schnittstelle kopiert: Connection
  
  Resets the session nonce, by fetching a new one.
  
  Angegeben von:
  
  resetNonce in Schnittstelle Connection
  
  Parameter:
  
  session - Session instance to fetch a nonce for
  
  Löst aus:
  
  AcmeException
- sendRequest
  
  public int sendRequest(URL url, Session session, @Nullable ZonedDateTime ifModifiedSince) throws AcmeException
  
  Beschreibung aus Schnittstelle kopiert: Connection
  
  Sends a simple GET request.
  If the response code was not HTTP status 200, an AcmeException matching the error is raised.
  
  Angegeben von:
  
  sendRequest in Schnittstelle Connection
  
  Parameter:
  
  url - URL to send the request to.
  
  session - Session instance to be used for tracking
  
  ifModifiedSince - ZonedDateTime to be sent as "If-Modified-Since" header, or null if this header is not to be used
  
  Gibt zurück:
  
  HTTP status that was returned
  
  Löst aus:
  
  AcmeException
- sendCertificateRequest
  
  public int sendCertificateRequest(URL url, Login login) throws AcmeException
  
  Beschreibung aus Schnittstelle kopiert: Connection
  
  Sends a signed POST-as-GET request for a certificate resource. Requires a Login for the session and KeyPair. The Login account location is sent in a "kid" protected header.
  If the server does not return a 200 class status code, an AcmeException is raised matching the error.
  
  Angegeben von:
  
  sendCertificateRequest in Schnittstelle Connection
  
  Parameter:
  
  url - URL to send the request to.
  
  login - Login instance to be used for signing and tracking.
  
  Gibt zurück:
  
  HTTP 200 class status that was returned
  
  Löst aus:
  
  AcmeException
- sendSignedPostAsGetRequest
  
  public int sendSignedPostAsGetRequest(URL url, Login login) throws AcmeException
  
  Beschreibung aus Schnittstelle kopiert: Connection
  
  Sends a signed POST-as-GET request. Requires a Login for the session and KeyPair. The Login account location is sent in a "kid" protected header.
  If the server does not return a 200 class status code, an AcmeException is raised matching the error.
  
  Angegeben von:
  
  sendSignedPostAsGetRequest in Schnittstelle Connection
  
  Parameter:
  
  url - URL to send the request to.
  
  login - Login instance to be used for signing and tracking.
  
  Gibt zurück:
  
  HTTP 200 class status that was returned
  
  Löst aus:
  
  AcmeException
- sendSignedRequest
  
  public int sendSignedRequest(URL url, JSONBuilder claims, Login login) throws AcmeException
  
  Beschreibung aus Schnittstelle kopiert: Connection
  
  Sends a signed POST request. Requires a Login for the session and KeyPair. The Login account location is sent in a "kid" protected header.
  If the server does not return a 200 class status code, an AcmeException is raised matching the error.
  
  Angegeben von:
  
  sendSignedRequest in Schnittstelle Connection
  
  Parameter:
  
  url - URL to send the request to.
  
  claims - JSONBuilder containing claims.
  
  login - Login instance to be used for signing and tracking.
  
  Gibt zurück:
  
  HTTP 200 class status that was returned
  
  Löst aus:
  
  AcmeException
- sendSignedRequest
  
  public int sendSignedRequest(URL url, JSONBuilder claims, Session session, KeyPair keypair) throws AcmeException
  
  Beschreibung aus Schnittstelle kopiert: Connection
  
  Sends a signed POST request. Only requires a Session. The KeyPair is sent in a "jwk" protected header field.
  If the server does not return a 200 class status code, an AcmeException is raised matching the error.
  
  Angegeben von:
  
  sendSignedRequest in Schnittstelle Connection
  
  Parameter:
  
  url - URL to send the request to.
  
  claims - JSONBuilder containing claims.
  
  session - Session instance to be used for tracking.
  
  keypair - KeyPair to be used for signing.
  
  Gibt zurück:
  
  HTTP 200 class status that was returned
  
  Löst aus:
  
  AcmeException
- readJsonResponse
  
  public JSON readJsonResponse() throws AcmeException
  
  Beschreibung aus Schnittstelle kopiert: Connection
  
  Reads a server response as JSON object.
  
  Angegeben von:
  
  readJsonResponse in Schnittstelle Connection
  
  Gibt zurück:
  
  The JSON response.
  
  Löst aus:
  
  AcmeException
- readCertificates
  
  public List<X509Certificate> readCertificates() throws AcmeException
  
  Beschreibung aus Schnittstelle kopiert: Connection
  
  Reads a certificate and its chain of issuers.
  
  Angegeben von:
  
  readCertificates in Schnittstelle Connection
  
  Gibt zurück:
  
  List of X.509 certificate and chain that was read.
  
  Löst aus:
  
  AcmeException
- getNonce
  
  public Optional<String> getNonce()
  
  Beschreibung aus Schnittstelle kopiert: Connection
  
  Gets the nonce from the nonce header.
  
  Angegeben von:
  
  getNonce in Schnittstelle Connection
  
  Gibt zurück:
  
  Base64 encoded nonce, or empty if no nonce header was set
- getLocation
  
  public URL getLocation()
  
  Beschreibung aus Schnittstelle kopiert: Connection
  
  Gets a location from the Location header.
  Relative links are resolved against the last request's URL.
  
  Angegeben von:
  
  getLocation in Schnittstelle Connection
  
  Gibt zurück:
  
  Location URL
- getLastModified
  
  public Optional<ZonedDateTime> getLastModified()
  
  Beschreibung aus Schnittstelle kopiert: Connection
  
  Returns the content of the last-modified header, if present.
  
  Angegeben von:
  
  getLastModified in Schnittstelle Connection
  
  Gibt zurück:
  
  Date in the Last-Modified header, or empty if the server did not provide this information.
- getExpiration
  
  public Optional<ZonedDateTime> getExpiration()
  
  Beschreibung aus Schnittstelle kopiert: Connection
  
  Returns the expiration date of the resource, if present.
  
  Angegeben von:
  
  getExpiration in Schnittstelle Connection
  
  Gibt zurück:
  
  Expiration date, either from the Cache-Control or Expires header. If empty, the server did not provide an expiration date, or forbid caching.
- getLinks
  
  public Collection<URL> getLinks(String relation)
  
  Beschreibung aus Schnittstelle kopiert: Connection
  
  Gets one or more relation links from the header. The result is expected to be a URL.
  Relative links are resolved against the last request's URL.
  
  Angegeben von:
  
  getLinks in Schnittstelle Connection
  
  Parameter:
  
  relation - Link relation
  
  Gibt zurück:
  
  Collection of links. Empty if there was no such relation.
- close
  
  public void close()
  
  Beschreibung aus Schnittstelle kopiert: Connection
  
  Closes the Connection, releasing all resources.
  
  Angegeben von:
  
  close in Schnittstelle AutoCloseable
  
  Angegeben von:
  
  close in Schnittstelle Connection
- sendRequest
  
  protected void sendRequest(Session session, URL url, Consumer<HttpRequest.Builder> body) throws IOException
  
  Sends a HTTP request via http client. This is the central method to be used for sending. It will create a HttpRequest by using the request builder, configure commnon headers, and then send the request via HttpClient.
  
  Parameter:
  
  session - Session to be used for sending
  
  url - Target URL
  
  body - Callback that completes the HttpRequest.Builder with the request body (e.g. HTTP method, request body, more headers).
  
  Löst aus:
  
  IOException
- sendSignedRequest
  
  protected int sendSignedRequest(URL url, @Nullable JSONBuilder claims, Session session, KeyPair keypair, @Nullable URL accountLocation, String accept) throws AcmeException
  
  Sends a signed POST request.
  
  Parameter:
  
  url - URL to send the request to.
  
  claims - JSONBuilder containing claims. null for POST-as-GET request.
  
  session - Session instance to be used for signing and tracking
  
  keypair - KeyPair to be used for signing
  
  accountLocation - If set, the account location is set as "kid" header. If null, the public key is set as "jwk" header.
  
  accept - Accept header
  
  Gibt zurück:
  
  HTTP 200 class status that was returned
  
  Löst aus:
  
  AcmeException
- getRetryAfter
  
  public Optional<Instant> getRetryAfter()
  
  Beschreibung aus Schnittstelle kopiert: Connection
  
  Returns the Retry-After header if present.
  
  Angegeben von:
  
  getRetryAfter in Schnittstelle Connection

Klasse DefaultConnection

Feldübersicht

Konstruktorübersicht

Methodenübersicht

Von Klasse geerbte Methoden java.lang.Object

Von Schnittstelle geerbte Methoden org.shredzone.acme4j.connector.Connection

Felddetails

httpConnector

httpClient

lastResponse

Konstruktordetails

DefaultConnection

Methodendetails

resetNonce

sendRequest

sendCertificateRequest

sendSignedPostAsGetRequest

sendSignedRequest

sendSignedRequest

readJsonResponse

readCertificates

getNonce

getLocation

getLastModified

getExpiration

getLinks

close

sendRequest

sendSignedRequest

getRetryAfter