org.shredzone.acme4j.connector

Interface Connection

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DefaultConnection

public interface Connection
extends AutoCloseable

Connects to the ACME server and offers different methods for invoking the API.

Method Summary

Modifier and Type	Method and Description
int	accept(int... httpStatus) Checks if the HTTP response status is in the given list of acceptable HTTP states, otherwise raises an AcmeException matching the error.
void	close() Closes the Connection, releasing all resources.
URL	getLink(String relation) Gets a relation link from the header.
URI	getLinkAsURI(String relation) Gets a relation link from the header.
URL	getLocation() Gets a location from the Location header.
void	handleRetryAfter(String message) Throws an AcmeRetryAfterException if the last status was HTTP Accepted and a Retry-After header was received.
X509Certificate	readCertificate() Reads a certificate.
JSON	readJsonResponse() Reads a server response as JSON data.
void	sendRequest(URL url, Session session) Sends a simple GET request.
void	sendSignedRequest(URL url, JSONBuilder claims, Session session) Sends a signed POST request.
void	updateSession(Session session) Updates a Session by evaluating the HTTP response header.

Method Detail

sendRequest

void sendRequest(URL url,
                 Session session)
          throws AcmeException

Sends a simple GET request.

Parameters:

url - URL to send the request to.

session - Session instance to be used for tracking

Throws:

AcmeException

sendSignedRequest

void sendSignedRequest(URL url,
                       JSONBuilder claims,
                       Session session)
                throws AcmeException

Sends a signed POST request.

Parameters:

url - URL to send the request to.

claims - JSONBuilder containing claims. Must not be null.

session - Session instance to be used for signing and tracking

Throws:

AcmeException

accept

int accept(int... httpStatus)
    throws AcmeException

Checks if the HTTP response status is in the given list of acceptable HTTP states, otherwise raises an AcmeException matching the error.

Parameters:

httpStatus - Acceptable HTTP states

Returns:

Actual HTTP status that was accepted

Throws:

AcmeException

readJsonResponse

JSON readJsonResponse()
               throws AcmeException

Reads a server response as JSON data.

Returns:

The JSON response

Throws:

AcmeException

readCertificate

X509Certificate readCertificate()
                         throws AcmeException

Reads a certificate.

Returns:

X509Certificate that was read.

Throws:

AcmeException

handleRetryAfter

void handleRetryAfter(String message)
               throws AcmeException

Throws an AcmeRetryAfterException if the last status was HTTP Accepted and a Retry-After header was received.

Parameters:

message - Message to be sent along with the AcmeRetryAfterException

Throws:

AcmeException

updateSession

void updateSession(Session session)

Updates a Session by evaluating the HTTP response header.

Parameters:

session - Session instance to be updated

getLocation

URL getLocation()

Gets a location from the Location header.

Relative links are resolved against the last request's URL.

Returns:

Location URL, or null if no Location header was set

getLink

URL getLink(String relation)

Gets a relation link from the header.

Relative links are resolved against the last request's URL. If there is more than one relation, the first one is returned.

Parameters:

relation - Link relation

Returns:

Link URL, or null if there was no such relation link

getLinkAsURI

URI getLinkAsURI(String relation)

Gets a relation link from the header.

Relative links are resolved against the last request's URL. If there is more than one relation, the first one is returned.

Parameters:

relation - Link relation

Returns:

Link URI, or null if there was no such relation link

close

void close()

Closes the Connection, releasing all resources.

Specified by:

close in interface AutoCloseable