org.shredzone.acme4j

Class Certificate

java.lang.Object

org.shredzone.acme4j.AcmeResource

org.shredzone.acme4j.Certificate

All Implemented Interfaces:

Serializable

public class Certificate
extends AcmeResource

Represents a certificate and its certificate chain.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Certificate(Session session, URL certUrl)
protected	Certificate(Session session, URL certUrl, URL chainUrl, X509Certificate cert)

Method Summary

Modifier and Type	Method and Description
static Certificate	bind(Session session, URL location) Creates a new instance of Certificate and binds it to the Session.
X509Certificate	download() Downloads the certificate.
X509Certificate[]	downloadChain() Downloads the issuer chain.
X509Certificate[]	downloadFullChain() Downloads the certificate and the corresponding issuer chain.
URL	getChainLocation() Returns the URL of the certificate chain.
void	revoke() Revokes this certificate.
void	revoke(RevocationReason reason) Revokes this certificate.
static void	revoke(Session session, X509Certificate cert, RevocationReason reason) Revoke a certificate.

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

Certificate

protected Certificate(Session session,
                      URL certUrl)

Certificate

protected Certificate(Session session,
                      URL certUrl,
                      URL chainUrl,
                      X509Certificate cert)

Method Detail

bind

public static Certificate bind(Session session,
                               URL location)

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

Parameters:

session - Session to be used

location - Location of the Certificate

Returns:

Certificate bound to the session and location

getChainLocation

public URL getChainLocation()

Returns the URL of the certificate chain. null if not known or not available.

download

public X509Certificate download()
                         throws AcmeException

Downloads the certificate. The result is only the end-entity certificate, without the issuer chain.

The result is cached.

Returns:

X509Certificate that was downloaded

Throws:

AcmeRetryAfterException - the certificate is still being created, and the server returned an estimated date when it will be ready for download. You should wait for the date given in AcmeRetryAfterException.getRetryAfter() before trying again.

AcmeException

See Also:

downloadFullChain()

downloadChain

public X509Certificate[] downloadChain()
                                throws AcmeException

Downloads the issuer chain. The result does not contain the end-entity certificate.

The result is cached.

Returns:

Chain of X509Certificates

Throws:

AcmeRetryAfterException - the certificate is still being created, and the server returned an estimated date when it will be ready for download. You should wait for the date given in AcmeRetryAfterException.getRetryAfter() before trying again.

AcmeException

downloadFullChain

public X509Certificate[] downloadFullChain()
                                    throws AcmeException

Downloads the certificate and the corresponding issuer chain. The issued certificate is always on index 0, followed by the CA certificates, with the root CA being at the last index.

The result is cached.

Returns:

Chain of X509Certificates

Throws:

AcmeRetryAfterException - the certificate is still being created, and the server returned an estimated date when it will be ready for download. You should wait for the date given in AcmeRetryAfterException.getRetryAfter() before trying again.

AcmeException

Since:

1.1

revoke

public void revoke()
            throws AcmeException

Revokes this certificate.

Throws:

AcmeException

revoke

public void revoke(RevocationReason reason)
            throws AcmeException

Revokes this certificate.

Parameters:

reason - RevocationReason stating the reason of the revocation that is used when generating OCSP responses and CRLs. null to give no reason.

Throws:

AcmeException

revoke

public static void revoke(Session session,
                          X509Certificate cert,
                          RevocationReason reason)
                   throws AcmeException

Revoke a certificate. This call is meant to be used for revoking certificates if the account's key pair was lost.

Parameters:

session - Session to be used. Here you can also generate a session by using the key pair that was used for signing the CSR.

cert - X509Certificate to be revoked

reason - RevocationReason stating the reason of the revocation that is used when generating OCSP responses and CRLs. null to give no reason.

Throws:

AcmeException