org.shredzone.acme4j

Class Registration

java.lang.Object

org.shredzone.acme4j.AcmeResource

org.shredzone.acme4j.Registration

All Implemented Interfaces:

Serializable

public class Registration
extends AcmeResource

Represents a registration at the ACME server.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Registration.EditableRegistration Editable Registration.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Registration(Session session, URL location)
protected	Registration(Session session, URL location, URI agreement)

Method Summary

Modifier and Type	Method and Description
Authorization	authorizeDomain(String domain) Authorizes a domain.
static Registration	bind(Session session, URL location) Creates a new instance of Registration and binds it to the Session.
void	changeKey(KeyPair newKeyPair) Changes the KeyPair associated with the registration.
void	deactivate() Permanently deactivates an account.
URI	getAgreement() Returns the URI of the agreement document the user is required to accept.
Iterator<Authorization>	getAuthorizations() Returns an Iterator of all Authorization belonging to this Registration.
Iterator<Certificate>	getCertificates() Returns an Iterator of all Certificate belonging to this Registration.
List<URI>	getContacts() List of contact addresses (emails, phone numbers etc).
Status	getStatus() Returns the current status of the registration.
protected void	load() Lazily updates the object's state when one of the getters is invoked.
Registration.EditableRegistration	modify() Modifies the registration data of the account.
Certificate	requestCertificate(byte[] csr) Requests a certificate for the given CSR.
Certificate	requestCertificate(byte[] csr, Instant notBefore, Instant notAfter) Requests a certificate for the given CSR.
void	update() Updates the registration to the current account status.

Methods inherited from class org.shredzone.acme4j.AcmeResource

getLocation, getSession, rebind, setLocation, setSession

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Registration

protected Registration(Session session,
                       URL location)

Registration

protected Registration(Session session,
                       URL location,
                       URI agreement)

Method Detail

bind

public static Registration bind(Session session,
                                URL location)

Creates a new instance of Registration and binds it to the Session.

Parameters:

session - Session to be used

location - Location URL of the registration

Returns:

Registration bound to the session and location

getAgreement

public URI getAgreement()

Returns the URI of the agreement document the user is required to accept.

getContacts

public List<URI> getContacts()

List of contact addresses (emails, phone numbers etc).

getStatus

public Status getStatus()

Returns the current status of the registration.

getAuthorizations

public Iterator<Authorization> getAuthorizations()
                                          throws AcmeException

Returns an Iterator of all Authorization belonging to this Registration.

Using the iterator will initiate one or more requests to the ACME server.

Returns:

Iterator instance that returns Authorization objects. Iterator.hasNext() and Iterator.next() may throw AcmeProtocolException if a batch of authorization URIs could not be fetched from the server.

Throws:

AcmeException

getCertificates

public Iterator<Certificate> getCertificates()
                                      throws AcmeException

Returns an Iterator of all Certificate belonging to this Registration.

Using the iterator will initiate one or more requests to the ACME server.

Returns:

Iterator instance that returns Certificate objects. Iterator.hasNext() and Iterator.next() may throw AcmeProtocolException if a batch of certificate URIs could not be fetched from the server.

Throws:

AcmeException

update

public void update()
            throws AcmeException

Updates the registration to the current account status.

Throws:

AcmeException

authorizeDomain

public Authorization authorizeDomain(String domain)
                              throws AcmeException

Authorizes a domain. The domain is associated with this registration.

IDN domain names will be ACE encoded automatically.

Parameters:

domain - Domain name to be authorized

Returns:

Authorization object for this domain

Throws:

AcmeException

requestCertificate

public Certificate requestCertificate(byte[] csr)
                               throws AcmeException

Requests a certificate for the given CSR.

All domains given in the CSR must be authorized before.

Parameters:

csr - PKCS#10 Certificate Signing Request to be sent to the server

Returns:

The Certificate

Throws:

AcmeException

requestCertificate

public Certificate requestCertificate(byte[] csr,
                                      Instant notBefore,
                                      Instant notAfter)
                               throws AcmeException

Requests a certificate for the given CSR.

All domains given in the CSR must be authorized before.

Parameters:

csr - PKCS#10 Certificate Signing Request to be sent to the server

notBefore - requested value of the notBefore field in the certificate, null for default. May be ignored by the server.

notAfter - requested value of the notAfter field in the certificate, null for default. May be ignored by the server.

Returns:

The Certificate

Throws:

AcmeException

changeKey

public void changeKey(KeyPair newKeyPair)
               throws AcmeException

Changes the KeyPair associated with the registration.

After a successful call, the new key pair is used in the bound Session, and the old key pair can be disposed of.

Parameters:

newKeyPair - new KeyPair to be used for identifying this account

Throws:

AcmeException

deactivate

public void deactivate()
                throws AcmeException

Permanently deactivates an account. Related certificates may still be valid after account deactivation, and need to be revoked separately if neccessary.

A deactivated account cannot be reactivated!

Throws:

AcmeException

load

protected void load()

Lazily updates the object's state when one of the getters is invoked.

modify

public Registration.EditableRegistration modify()

Modifies the registration data of the account.

Returns:

Registration.EditableRegistration where the account can be modified