org.xipki.cmpclient.internal

Class CmpClientImpl

java.lang.Object

org.xipki.cmpclient.internal.CmpClientImpl

All Implemented Interfaces:

Closeable, AutoCloseable, CmpClient

public final class CmpClientImpl
extends Object
implements CmpClient

Implementation of the interface CmpClient.

Since:

2.0.0

Author:

Lijun Liao

Constructor Summary

Constructors

Constructor and Description
CmpClientImpl()

Method Summary

Modifier and Type	Method and Description
void	close()
org.bouncycastle.cert.X509CRLHolder	downloadCrl(String caName, BigInteger crlNumber, org.xipki.util.ReqRespDebug debug) Downloads the CRL for the given CRL number.
org.bouncycastle.cert.X509CRLHolder	downloadCrl(String caName, org.xipki.util.ReqRespDebug debug) Downloads the current CRL.
EnrollCertResult	enrollCert(String caName, org.bouncycastle.asn1.pkcs.CertificationRequest csr, String profile, Date notBefore, Date notAfter, org.xipki.util.ReqRespDebug debug) Enrolls a certificate.
EnrollCertResult	enrollCerts(String caName, EnrollCertRequest request, org.xipki.util.ReqRespDebug debug) Enrolls a set of certificates.
org.bouncycastle.cert.X509CRLHolder	generateCrl(String caName, org.xipki.util.ReqRespDebug debug) Generates and downloads a new CRL.
org.xipki.security.X509Cert	getCaCert(String caName) Returns the CA certificate.
List<org.xipki.security.X509Cert>	getCaCertchain(String caName) Returns the CA certificate chain.
org.bouncycastle.asn1.x500.X500Name	getCaCertSubject(String caName) Returns the subject of CA certificate.
String	getCaNameByIssuer(org.bouncycastle.asn1.x500.X500Name issuer) Gets the name of the CA.
String	getCaNameForProfile(String certprofile) Returns name of CA that supports give certprofile.
Set<String>	getCaNames()
Set<CertprofileInfo>	getCertprofiles(String caName) Return set given Certprofiles supported by the CA caName.
List<org.xipki.security.X509Cert>	getDhPocPeerCertificates(String caName) Returns the certificates held by CA for the DH KeyAgreement.
org.xipki.util.HealthCheckResult	getHealthCheckResult(String caName) Gets the health status.
boolean	init()
CertIdOrError	removeCert(String caName, BigInteger serial, org.xipki.util.ReqRespDebug debug) Removes a certificate.
CertIdOrError	removeCert(String caName, org.xipki.security.X509Cert cert, org.xipki.util.ReqRespDebug debug) Removes a certificate.
Map<String,CertIdOrError>	removeCerts(UnrevokeOrRemoveCertRequest request, org.xipki.util.ReqRespDebug debug) Removes certificates.
CertIdOrError	revokeCert(String caName, BigInteger serial, int reason, Date invalidityDate, org.xipki.util.ReqRespDebug debug) Revokes a certificate.
CertIdOrError	revokeCert(String caName, org.xipki.security.X509Cert cert, int reason, Date invalidityDate, org.xipki.util.ReqRespDebug debug) Revokes a certificate.
Map<String,CertIdOrError>	revokeCerts(RevokeCertRequest request, org.xipki.util.ReqRespDebug debug) Revoke a set of certificates.
void	setConfFile(String confFile)
void	setSecurityFactory(org.xipki.security.SecurityFactory securityFactory)
CertIdOrError	unrevokeCert(String caName, BigInteger serial, org.xipki.util.ReqRespDebug debug) Unrevokes a certificate.
CertIdOrError	unrevokeCert(String caName, org.xipki.security.X509Cert cert, org.xipki.util.ReqRespDebug debug) Unrevokes certificates.
Map<String,CertIdOrError>	unrevokeCerts(UnrevokeOrRemoveCertRequest request, org.xipki.util.ReqRespDebug debug) Unrevokes certificates.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmpClientImpl

public CmpClientImpl()

Method Detail

setSecurityFactory

public void setSecurityFactory(org.xipki.security.SecurityFactory securityFactory)

setConfFile

public void setConfFile(String confFile)

init

public boolean init()

Specified by:

init in interface CmpClient

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

enrollCert

public EnrollCertResult enrollCert(String caName,
                                   org.bouncycastle.asn1.pkcs.CertificationRequest csr,
                                   String profile,
                                   Date notBefore,
                                   Date notAfter,
                                   org.xipki.util.ReqRespDebug debug)
                            throws CmpClientException,
                                   PkiErrorException

Description copied from interface: CmpClient

Enrolls a certificate.

Specified by:

enrollCert in interface CmpClient

Parameters:

caName - CA name. Could be null.

csr - CSR. Must not benull.

profile - Certificate profile name. Must not benull.

notBefore - NotBefore. Could be null.

notAfter - NotAfter. Could be null.

debug - Request/response debug control. Could be null.

Returns:

the enrolling result.

Throws:

CmpClientException - if client error occurs.

PkiErrorException - if the response returns none-success status.

enrollCerts

public EnrollCertResult enrollCerts(String caName,
                                    EnrollCertRequest request,
                                    org.xipki.util.ReqRespDebug debug)
                             throws CmpClientException,
                                    PkiErrorException

Description copied from interface: CmpClient

Enrolls a set of certificates.

Specified by:

enrollCerts in interface CmpClient

Parameters:

caName - CA name. Could be null.

request - Request. Must not be null.

debug - Request/response debug control. Could be null.

Returns:

the enrolling result.

Throws:

CmpClientException - if client error occurs.

PkiErrorException - if the response returns none-success status.

revokeCert

public CertIdOrError revokeCert(String caName,
                                org.xipki.security.X509Cert cert,
                                int reason,
                                Date invalidityDate,
                                org.xipki.util.ReqRespDebug debug)
                         throws CmpClientException,
                                PkiErrorException

Description copied from interface: CmpClient

Revokes a certificate.

Specified by:

revokeCert in interface CmpClient

Parameters:

caName - CA name. Could be null.

cert - Target certificate. Must not be null.

reason - Revocation reason.

invalidityDate - Invalidity time. Could be null.

debug - Request/response debug control. Could be null.

Returns:

the revocation result.

Throws:

CmpClientException - if client error occurs.

PkiErrorException - if the response returns none-success status.

revokeCert

public CertIdOrError revokeCert(String caName,
                                BigInteger serial,
                                int reason,
                                Date invalidityDate,
                                org.xipki.util.ReqRespDebug debug)
                         throws CmpClientException,
                                PkiErrorException

Description copied from interface: CmpClient

Revokes a certificate.

Specified by:

revokeCert in interface CmpClient

Parameters:

caName - CA name. Could be null.

serial - Serial number of the target certificate. Must not be null.

reason - Revocation reason.

invalidityDate - Invalidity time. Could be null.

debug - Request/response debug control. Could be null.

Returns:

the revocation result.

Throws:

CmpClientException - if client error occurs.

PkiErrorException - if the response returns none-success status.

revokeCerts

public Map<String,CertIdOrError> revokeCerts(RevokeCertRequest request,
                                             org.xipki.util.ReqRespDebug debug)
                                      throws CmpClientException,
                                             PkiErrorException

Description copied from interface: CmpClient

Revoke a set of certificates.

Specified by:

revokeCerts in interface CmpClient

Parameters:

request - Request. Must not be null.

debug - Request/response debug control. Could be null.

Returns:

the revocation result.

Throws:

CmpClientException - if client error occurs.

PkiErrorException - if the response returns none-success status.

downloadCrl

public org.bouncycastle.cert.X509CRLHolder downloadCrl(String caName,
                                                       org.xipki.util.ReqRespDebug debug)
                                                throws CmpClientException,
                                                       PkiErrorException

Description copied from interface: CmpClient

Downloads the current CRL.

Specified by:

downloadCrl in interface CmpClient

Parameters:

caName - CA name. Must not be null.

debug - Request/response debug control. Could be null.

Returns:

the X509 CRL. Must not be null.

Throws:

CmpClientException - if client error occurs.

PkiErrorException - if the response returns none-success status.

downloadCrl

public org.bouncycastle.cert.X509CRLHolder downloadCrl(String caName,
                                                       BigInteger crlNumber,
                                                       org.xipki.util.ReqRespDebug debug)
                                                throws CmpClientException,
                                                       PkiErrorException

Description copied from interface: CmpClient

Downloads the CRL for the given CRL number.

Specified by:

downloadCrl in interface CmpClient

Parameters:

caName - CA name. Must not be null.

crlNumber - CRL number. null to download the current CRL.

debug - Request/response debug control. Could be null.

Returns:

the X509 CRL. Must not be null.

Throws:

CmpClientException - if client error occurs.

PkiErrorException - if the response returns none-success status.

generateCrl

public org.bouncycastle.cert.X509CRLHolder generateCrl(String caName,
                                                       org.xipki.util.ReqRespDebug debug)
                                                throws CmpClientException,
                                                       PkiErrorException

Description copied from interface: CmpClient

Generates and downloads a new CRL.

Specified by:

generateCrl in interface CmpClient

Parameters:

caName - CA name. Must not be null.

debug - Request/response debug control. Could be null.

Returns:

the X509 CRL. Must not be null.

Throws:

CmpClientException - if client error occurs.

PkiErrorException - if the response returns none-success status.

getCaNameByIssuer

public String getCaNameByIssuer(org.bouncycastle.asn1.x500.X500Name issuer)
                         throws CmpClientException

Description copied from interface: CmpClient

Gets the name of the CA.

Specified by:

getCaNameByIssuer in interface CmpClient

Parameters:

issuer - Issuer's subject.

Returns:

the CA name

Throws:

CmpClientException - if client error occurs.

getCaNameForProfile

public String getCaNameForProfile(String certprofile)
                           throws CmpClientException

Description copied from interface: CmpClient

Returns name of CA that supports give certprofile.

Specified by:

getCaNameForProfile in interface CmpClient

Parameters:

certprofile - The name of certprofile

Returns:

name of CA that supports give certprofile.

Throws:

CmpClientException - If more than one CA supports the certificate.

getCaNames

public Set<String> getCaNames()
                       throws CmpClientException

Specified by:

getCaNames in interface CmpClient

Throws:

CmpClientException

unrevokeCert

public CertIdOrError unrevokeCert(String caName,
                                  org.xipki.security.X509Cert cert,
                                  org.xipki.util.ReqRespDebug debug)
                           throws CmpClientException,
                                  PkiErrorException

Description copied from interface: CmpClient

Unrevokes certificates.

Specified by:

unrevokeCert in interface CmpClient

Parameters:

caName - CA name. Could be null.

cert - Target certificate. Must not be null.

debug - Request/response debug control. Could be null.

Returns:

result of the unrevocation.

Throws:

CmpClientException - if client error occurs.

PkiErrorException - if the response returns none-success status.

unrevokeCert

public CertIdOrError unrevokeCert(String caName,
                                  BigInteger serial,
                                  org.xipki.util.ReqRespDebug debug)
                           throws CmpClientException,
                                  PkiErrorException

Description copied from interface: CmpClient

Unrevokes a certificate.

Specified by:

unrevokeCert in interface CmpClient

Parameters:

caName - CA name. Could be null.

serial - Serial number of the certificate. Must not be null.

debug - Request/response debug control. Could be null.

Returns:

result of the unrevocation.

Throws:

CmpClientException - if client error occurs.

PkiErrorException - if the response returns none-success status.

unrevokeCerts

public Map<String,CertIdOrError> unrevokeCerts(UnrevokeOrRemoveCertRequest request,
                                               org.xipki.util.ReqRespDebug debug)
                                        throws CmpClientException,
                                               PkiErrorException

Description copied from interface: CmpClient

Unrevokes certificates.

Specified by:

unrevokeCerts in interface CmpClient

Parameters:

request - Request. Must not be null.

debug - Request/response debug control. Could be null.

Returns:

result of the unrevocation.

Throws:

CmpClientException - if client error occurs.

PkiErrorException - if the response returns none-success status.

removeCert

public CertIdOrError removeCert(String caName,
                                org.xipki.security.X509Cert cert,
                                org.xipki.util.ReqRespDebug debug)
                         throws CmpClientException,
                                PkiErrorException

Description copied from interface: CmpClient

Removes a certificate.

Specified by:

removeCert in interface CmpClient

Parameters:

caName - CA name. Could be null.

cert - Target certificate.

debug - Request/response debug control. Could be null.

Returns:

result of the removing

Throws:

CmpClientException - if client error occurs.

PkiErrorException - if the response returns none-success status.

removeCert

public CertIdOrError removeCert(String caName,
                                BigInteger serial,
                                org.xipki.util.ReqRespDebug debug)
                         throws CmpClientException,
                                PkiErrorException

Description copied from interface: CmpClient

Removes a certificate.

Specified by:

removeCert in interface CmpClient

Parameters:

caName - CA name. Could be null.

serial - Serial number of the target certificate.

debug - Request/response debug control. Could be null.

Returns:

the result of the remove

Throws:

CmpClientException - if client error occurs.

PkiErrorException - if the response returns none-success status.

removeCerts

public Map<String,CertIdOrError> removeCerts(UnrevokeOrRemoveCertRequest request,
                                             org.xipki.util.ReqRespDebug debug)
                                      throws CmpClientException,
                                             PkiErrorException

Description copied from interface: CmpClient

Removes certificates.

Specified by:

removeCerts in interface CmpClient

Parameters:

request - Request. Must not be null.

debug - Request/response debug control. Could be null.

Returns:

the result of the removing

Throws:

CmpClientException - if client error occurs.

PkiErrorException - if the response returns none-success status.

getCertprofiles

public Set<CertprofileInfo> getCertprofiles(String caName)
                                     throws CmpClientException

Description copied from interface: CmpClient

Return set given Certprofiles supported by the CA caName.

Specified by:

getCertprofiles in interface CmpClient

Parameters:

caName - CA name. Must not be null

Returns:

the certificate profiles supported by the given CA.

Throws:

CmpClientException - if client error occurs.

getHealthCheckResult

public org.xipki.util.HealthCheckResult getHealthCheckResult(String caName)
                                                      throws CmpClientException

Description copied from interface: CmpClient

Gets the health status.

Specified by:

getHealthCheckResult in interface CmpClient

Parameters:

caName - CA name. Must not be null.

Returns:

the health status.

Throws:

CmpClientException - if client error occurs.

getCaCert

public org.xipki.security.X509Cert getCaCert(String caName)
                                      throws CmpClientException

Description copied from interface: CmpClient

Returns the CA certificate.

Specified by:

getCaCert in interface CmpClient

Parameters:

caName - the CA name

Returns:

the CA certificate

Throws:

CmpClientException - if client error occurs.

getCaCertchain

public List<org.xipki.security.X509Cert> getCaCertchain(String caName)
                                                 throws CmpClientException

Description copied from interface: CmpClient

Returns the CA certificate chain.

Specified by:

getCaCertchain in interface CmpClient

Parameters:

caName - the CA name

Returns:

the CA certificate

Throws:

CmpClientException - if client error occurs.

getCaCertSubject

public org.bouncycastle.asn1.x500.X500Name getCaCertSubject(String caName)
                                                     throws CmpClientException

Description copied from interface: CmpClient

Returns the subject of CA certificate.

Specified by:

getCaCertSubject in interface CmpClient

Parameters:

caName - the CA name

Returns:

the subject of CA certificate

Throws:

CmpClientException - if client error occurs.

getDhPocPeerCertificates

public List<org.xipki.security.X509Cert> getDhPocPeerCertificates(String caName)
                                                           throws CmpClientException

Description copied from interface: CmpClient

Returns the certificates held by CA for the DH KeyAgreement.

Specified by:

getDhPocPeerCertificates in interface CmpClient

Parameters:

caName - the CA name

Returns:

the certificates held by CA for the DH KeyAgreement,

Throws:

CmpClientException - if client error occurs.