Package org.xipki.ca.server.db

Class DbCertStore

java.lang.Object

org.xipki.ca.server.db.DbCertStore

All Implemented Interfaces:

CertStore

public class DbCertStore
extends Object
implements CertStore

CA cert store.

Since:

2.0.0

Author:

Lijun Liao (xipki)

Nested Class Summary

Nested classes/interfaces inherited from interface org.xipki.ca.server.CertStore

CertStore.CertStatus, CertStore.SerialWithId

Field Summary

Fields

Modifier and Type	Field	Description
protected org.xipki.datasource.DataSourceWrapper	datasource

Constructor Summary

Constructors

Constructor	Description
DbCertStore(org.xipki.datasource.DataSourceWrapper datasource, CaConfStore caConfStore, UniqueIdGenerator idGenerator)

Method Summary

Modifier and Type	Method	Description
void	addCa(org.xipki.ca.api.NameId ident, org.xipki.security.X509Cert caCert, org.xipki.security.CertRevocationInfo caRevInfo)
boolean	addCert(org.xipki.ca.api.CertificateInfo certInfo, boolean saveKeypair)
void	addCertProfile(org.xipki.ca.api.NameId ident)
void	addCrl(org.xipki.ca.api.NameId ca, org.bouncycastle.cert.X509CRLHolder crl)
void	addRequestor(org.xipki.ca.api.NameId ident)
protected PreparedStatement	buildPrepStmt(String sql, org.xipki.ca.server.db.QueryExecutor.SqlColumn2... columns)
protected String	buildSelectFirstSql(String coreSql)
protected String	buildSelectFirstSql(String orderBy, String coreSql)
int	cleanupCrls(org.xipki.ca.api.NameId ca, int numCrls)
protected static org.xipki.ca.server.db.QueryExecutor.SqlColumn2	col2Bool(Boolean value)
protected static org.xipki.ca.server.db.QueryExecutor.SqlColumn2	col2Int(Integer value)
protected static org.xipki.ca.server.db.QueryExecutor.SqlColumn2	col2Long(Long value)
protected static org.xipki.ca.server.db.QueryExecutor.SqlColumn2	col2Str(String value)
protected static org.xipki.ca.server.db.QueryExecutor.SqlColumn2	col2Timestamp(Timestamp value)
protected static org.xipki.ca.server.db.QueryExecutor.SqlColumn	colBool(String name, Boolean value)
protected static org.xipki.ca.server.db.QueryExecutor.SqlColumn	colInt(String name, Integer value)
protected static org.xipki.ca.server.db.QueryExecutor.SqlColumn	colLong(String name, Long value)
protected static org.xipki.ca.server.db.QueryExecutor.SqlColumn	colStr(String name, String value)
protected static org.xipki.ca.server.db.QueryExecutor.SqlColumn	colStr(String name, String value, boolean sensitive, boolean signerConf)
protected org.xipki.ca.server.db.ResultRow	execQuery1PrepStmt(String sql, org.xipki.ca.server.db.QueryExecutor.SqlColumn2... params)
protected List<org.xipki.ca.server.db.ResultRow>	execQueryPrepStmt(String sql, org.xipki.ca.server.db.QueryExecutor.SqlColumn2... params)
protected List<org.xipki.ca.server.db.ResultRow>	execQueryStmt(String sql)
protected int	execUpdatePrepStmt(String sql, org.xipki.ca.server.db.QueryExecutor.SqlColumn2... params)
protected int	execUpdateStmt(String sql)
org.xipki.security.X509Cert	getCert(org.bouncycastle.asn1.x500.X500Name subjectName, String transactionId)	Get certificate for given subject and transactionId.
org.xipki.ca.api.CertificateInfo	getCertForId(org.xipki.ca.api.NameId ca, org.xipki.security.X509Cert caCert, long certId, CaIdNameMap idNameMap)
long	getCertId(org.xipki.ca.api.NameId ca, BigInteger serial)
org.xipki.ca.api.CertificateInfo	getCertInfo(org.xipki.ca.api.NameId ca, org.xipki.security.X509Cert caCert, BigInteger serial, CaIdNameMap idNameMap)
List<CertRevInfoWithSerial>	getCertsForDeltaCrl(org.xipki.ca.api.NameId ca, BigInteger baseCrlNumber, Instant notExpiredAt)
CertStore.CertStatus	getCertStatusForSubject(org.xipki.ca.api.NameId ca, org.bouncycastle.asn1.x500.X500Name subject)
org.xipki.ca.api.mgmt.CertWithRevocationInfo	getCertWithRevocationInfo(int caId, BigInteger serial, CaIdNameMap idNameMap)
org.xipki.ca.api.mgmt.CertWithRevocationInfo	getCertWithRevocationInfo(long certId, CaIdNameMap idNameMap)
org.xipki.ca.api.mgmt.CertWithRevocationInfo	getCertWithRevocationInfoBySubject(int caId, org.bouncycastle.asn1.x500.X500Name subject, byte[] san, CaIdNameMap idNameMap)
long	getCountOfCerts(long notBeforeSince)
long	getCountOfCerts(org.xipki.ca.api.NameId ca, boolean onlyRevoked)
byte[]	getEncodedCrl(org.xipki.ca.api.NameId ca, BigInteger crlNumber)
List<CertStore.SerialWithId>	getExpiredUnrevokedSerialNumbers(org.xipki.ca.api.NameId ca, long expiredAt, int numEntries)
long	getMaxCrlNumber(org.xipki.ca.api.NameId ca)
long	getMaxFullCrlNumber(org.xipki.ca.api.NameId ca)
List<CertRevInfoWithSerial>	getRevokedCerts(org.xipki.ca.api.NameId ca, Instant notExpiredAt, long startId, int numEntries)
List<CertStore.SerialWithId>	getSerialNumbers(org.xipki.ca.api.NameId ca, long startId, int numEntries, boolean onlyRevoked)
List<CertStore.SerialWithId>	getSuspendedCertSerials(org.xipki.ca.api.NameId ca, Instant latestLastUpdate, int numEntries)
long	getThisUpdateOfCurrentCrl(org.xipki.ca.api.NameId ca, boolean deltaCrl)
boolean	isHealthy()
List<org.xipki.ca.api.mgmt.CertListInfo>	listCerts(org.xipki.ca.api.NameId ca, org.bouncycastle.asn1.x500.X500Name subjectPattern, Instant validFrom, Instant validTo, org.xipki.ca.api.mgmt.CertListOrderBy orderBy, int numEntries)
protected void	notNulls(Object param1, String name1, Object param2, String name2)
protected void	notNulls(Object param1, String name1, Object param2, String name2, Object param3, String name3)
protected void	notNulls(Object param1, String name1, Object param2, String name2, Object param3, String name3, Object param4, String name4)
void	removeCa(String name)
void	removeCert(long id)
void	removeCertProfile(String name)
void	removeRequestor(String name)
void	revokeCa(String caName, org.xipki.security.CertRevocationInfo revocationInfo)
org.xipki.ca.api.mgmt.CertWithRevocationInfo	revokeCert(org.xipki.ca.api.NameId ca, BigInteger serialNumber, org.xipki.security.CertRevocationInfo revInfo, boolean force, CaIdNameMap idNameMap)
org.xipki.ca.api.mgmt.CertWithRevocationInfo	revokeSuspendedCert(org.xipki.ca.api.NameId ca, CertStore.SerialWithId serialNumber, org.xipki.security.CrlReason reason, CaIdNameMap idNameMap)
void	unrevokeCa(String caName)
org.xipki.ca.api.CertWithDbId	unsuspendCert(org.xipki.ca.api.NameId ca, BigInteger serialNumber, boolean force, CaIdNameMap idNamMap)
void	updateDbInfo()

Methods inherited from class java.lang.Object

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

Field Detail

datasource

protected final org.xipki.datasource.DataSourceWrapper datasource

Constructor Detail

DbCertStore

public DbCertStore(org.xipki.datasource.DataSourceWrapper datasource,
                   CaConfStore caConfStore,
                   UniqueIdGenerator idGenerator)
            throws org.xipki.datasource.DataAccessException,
                   org.xipki.ca.api.mgmt.CaMgmtException

Throws:

org.xipki.datasource.DataAccessException

org.xipki.ca.api.mgmt.CaMgmtException

Method Detail

removeCa

public void removeCa(String name)
              throws org.xipki.ca.api.mgmt.CaMgmtException

Specified by:

removeCa in interface CertStore

Throws:

org.xipki.ca.api.mgmt.CaMgmtException

removeCertProfile

public void removeCertProfile(String name)
                       throws org.xipki.ca.api.mgmt.CaMgmtException

Specified by:

removeCertProfile in interface CertStore

Throws:

org.xipki.ca.api.mgmt.CaMgmtException

removeRequestor

public void removeRequestor(String name)
                     throws org.xipki.ca.api.mgmt.CaMgmtException

Specified by:

removeRequestor in interface CertStore

Throws:

org.xipki.ca.api.mgmt.CaMgmtException

addCertProfile

public void addCertProfile(org.xipki.ca.api.NameId ident)
                    throws org.xipki.ca.api.mgmt.CaMgmtException

Specified by:

addCertProfile in interface CertStore

Throws:

org.xipki.ca.api.mgmt.CaMgmtException

addRequestor

public void addRequestor(org.xipki.ca.api.NameId ident)
                  throws org.xipki.ca.api.mgmt.CaMgmtException

Specified by:

addRequestor in interface CertStore

Throws:

org.xipki.ca.api.mgmt.CaMgmtException

addCa

public void addCa(org.xipki.ca.api.NameId ident,
                  org.xipki.security.X509Cert caCert,
                  org.xipki.security.CertRevocationInfo caRevInfo)
           throws org.xipki.ca.api.mgmt.CaMgmtException

Specified by:

addCa in interface CertStore

Throws:

org.xipki.ca.api.mgmt.CaMgmtException

revokeCa

public void revokeCa(String caName,
                     org.xipki.security.CertRevocationInfo revocationInfo)
              throws org.xipki.ca.api.mgmt.CaMgmtException

Specified by:

revokeCa in interface CertStore

Throws:

org.xipki.ca.api.mgmt.CaMgmtException

unrevokeCa

public void unrevokeCa(String caName)
                throws org.xipki.ca.api.mgmt.CaMgmtException

Specified by:

unrevokeCa in interface CertStore

Throws:

org.xipki.ca.api.mgmt.CaMgmtException

addCert

public boolean addCert(org.xipki.ca.api.CertificateInfo certInfo,
                       boolean saveKeypair)

Specified by:

addCert in interface CertStore

getMaxFullCrlNumber

public long getMaxFullCrlNumber(org.xipki.ca.api.NameId ca)
                         throws org.xipki.pki.OperationException

Specified by:

getMaxFullCrlNumber in interface CertStore

Throws:

org.xipki.pki.OperationException

getMaxCrlNumber

public long getMaxCrlNumber(org.xipki.ca.api.NameId ca)
                     throws org.xipki.pki.OperationException

Specified by:

getMaxCrlNumber in interface CertStore

Throws:

org.xipki.pki.OperationException

getThisUpdateOfCurrentCrl

public long getThisUpdateOfCurrentCrl(org.xipki.ca.api.NameId ca,
                                      boolean deltaCrl)
                               throws org.xipki.pki.OperationException

Specified by:

getThisUpdateOfCurrentCrl in interface CertStore

Throws:

org.xipki.pki.OperationException

addCrl

public void addCrl(org.xipki.ca.api.NameId ca,
                   org.bouncycastle.cert.X509CRLHolder crl)
            throws org.xipki.pki.OperationException,
                   CRLException

Specified by:

addCrl in interface CertStore

Throws:

org.xipki.pki.OperationException

CRLException

revokeCert

public org.xipki.ca.api.mgmt.CertWithRevocationInfo revokeCert(org.xipki.ca.api.NameId ca,
                                                               BigInteger serialNumber,
                                                               org.xipki.security.CertRevocationInfo revInfo,
                                                               boolean force,
                                                               CaIdNameMap idNameMap)
                                                        throws org.xipki.pki.OperationException

Specified by:

revokeCert in interface CertStore

Throws:

org.xipki.pki.OperationException

revokeSuspendedCert

public org.xipki.ca.api.mgmt.CertWithRevocationInfo revokeSuspendedCert(org.xipki.ca.api.NameId ca,
                                                                        CertStore.SerialWithId serialNumber,
                                                                        org.xipki.security.CrlReason reason,
                                                                        CaIdNameMap idNameMap)
                                                                 throws org.xipki.pki.OperationException

Specified by:

revokeSuspendedCert in interface CertStore

Throws:

org.xipki.pki.OperationException

unsuspendCert

public org.xipki.ca.api.CertWithDbId unsuspendCert(org.xipki.ca.api.NameId ca,
                                                   BigInteger serialNumber,
                                                   boolean force,
                                                   CaIdNameMap idNamMap)
                                            throws org.xipki.pki.OperationException

Specified by:

unsuspendCert in interface CertStore

Throws:

org.xipki.pki.OperationException

removeCert

public void removeCert(long id)
                throws org.xipki.pki.OperationException

Specified by:

removeCert in interface CertStore

Throws:

org.xipki.pki.OperationException

getCountOfCerts

public long getCountOfCerts(org.xipki.ca.api.NameId ca,
                            boolean onlyRevoked)
                     throws org.xipki.pki.OperationException

Specified by:

getCountOfCerts in interface CertStore

Throws:

org.xipki.pki.OperationException

getCountOfCerts

public long getCountOfCerts(long notBeforeSince)
                     throws org.xipki.pki.OperationException

Specified by:

getCountOfCerts in interface CertStore

Throws:

org.xipki.pki.OperationException

getSerialNumbers

public List<CertStore.SerialWithId> getSerialNumbers(org.xipki.ca.api.NameId ca,
                                                     long startId,
                                                     int numEntries,
                                                     boolean onlyRevoked)
                                              throws org.xipki.pki.OperationException

Specified by:

getSerialNumbers in interface CertStore

Throws:

org.xipki.pki.OperationException

getExpiredUnrevokedSerialNumbers

public List<CertStore.SerialWithId> getExpiredUnrevokedSerialNumbers(org.xipki.ca.api.NameId ca,
                                                                     long expiredAt,
                                                                     int numEntries)
                                                              throws org.xipki.pki.OperationException

Specified by:

getExpiredUnrevokedSerialNumbers in interface CertStore

Throws:

org.xipki.pki.OperationException

getSuspendedCertSerials

public List<CertStore.SerialWithId> getSuspendedCertSerials(org.xipki.ca.api.NameId ca,
                                                            Instant latestLastUpdate,
                                                            int numEntries)
                                                     throws org.xipki.pki.OperationException

Specified by:

getSuspendedCertSerials in interface CertStore

Throws:

org.xipki.pki.OperationException

getEncodedCrl

public byte[] getEncodedCrl(org.xipki.ca.api.NameId ca,
                            BigInteger crlNumber)
                     throws org.xipki.pki.OperationException

Specified by:

getEncodedCrl in interface CertStore

Throws:

org.xipki.pki.OperationException

cleanupCrls

public int cleanupCrls(org.xipki.ca.api.NameId ca,
                       int numCrls)
                throws org.xipki.pki.OperationException

Specified by:

cleanupCrls in interface CertStore

Throws:

org.xipki.pki.OperationException

getCertForId

public org.xipki.ca.api.CertificateInfo getCertForId(org.xipki.ca.api.NameId ca,
                                                     org.xipki.security.X509Cert caCert,
                                                     long certId,
                                                     CaIdNameMap idNameMap)
                                              throws org.xipki.pki.OperationException

Specified by:

getCertForId in interface CertStore

Throws:

org.xipki.pki.OperationException

getCertWithRevocationInfo

public org.xipki.ca.api.mgmt.CertWithRevocationInfo getCertWithRevocationInfo(long certId,
                                                                              CaIdNameMap idNameMap)
                                                                       throws org.xipki.pki.OperationException

Specified by:

getCertWithRevocationInfo in interface CertStore

Throws:

org.xipki.pki.OperationException

getCertWithRevocationInfo

public org.xipki.ca.api.mgmt.CertWithRevocationInfo getCertWithRevocationInfo(int caId,
                                                                              BigInteger serial,
                                                                              CaIdNameMap idNameMap)
                                                                       throws org.xipki.pki.OperationException

Specified by:

getCertWithRevocationInfo in interface CertStore

Throws:

org.xipki.pki.OperationException

getCertWithRevocationInfoBySubject

public org.xipki.ca.api.mgmt.CertWithRevocationInfo getCertWithRevocationInfoBySubject(int caId,
                                                                                       org.bouncycastle.asn1.x500.X500Name subject,
                                                                                       byte[] san,
                                                                                       CaIdNameMap idNameMap)
                                                                                throws org.xipki.pki.OperationException

Specified by:

getCertWithRevocationInfoBySubject in interface CertStore

Throws:

org.xipki.pki.OperationException

getCertId

public long getCertId(org.xipki.ca.api.NameId ca,
                      BigInteger serial)
               throws org.xipki.pki.OperationException

Specified by:

getCertId in interface CertStore

Throws:

org.xipki.pki.OperationException

getCertInfo

public org.xipki.ca.api.CertificateInfo getCertInfo(org.xipki.ca.api.NameId ca,
                                                    org.xipki.security.X509Cert caCert,
                                                    BigInteger serial,
                                                    CaIdNameMap idNameMap)
                                             throws org.xipki.pki.OperationException

Specified by:

getCertInfo in interface CertStore

Throws:

org.xipki.pki.OperationException

getCert

public org.xipki.security.X509Cert getCert(org.bouncycastle.asn1.x500.X500Name subjectName,
                                           String transactionId)
                                    throws org.xipki.pki.OperationException

Get certificate for given subject and transactionId.

Specified by:

getCert in interface CertStore

Parameters:

subjectName - Subject of Certificate or requested Subject.

transactionId - the transactionId

Returns:

certificate for given subject and transactionId.

Throws:

org.xipki.pki.OperationException - If error occurs.

listCerts

public List<org.xipki.ca.api.mgmt.CertListInfo> listCerts(org.xipki.ca.api.NameId ca,
                                                          org.bouncycastle.asn1.x500.X500Name subjectPattern,
                                                          Instant validFrom,
                                                          Instant validTo,
                                                          org.xipki.ca.api.mgmt.CertListOrderBy orderBy,
                                                          int numEntries)
                                                   throws org.xipki.pki.OperationException

Specified by:

listCerts in interface CertStore

Throws:

org.xipki.pki.OperationException

getRevokedCerts

public List<CertRevInfoWithSerial> getRevokedCerts(org.xipki.ca.api.NameId ca,
                                                   Instant notExpiredAt,
                                                   long startId,
                                                   int numEntries)
                                            throws org.xipki.pki.OperationException

Specified by:

getRevokedCerts in interface CertStore

Throws:

org.xipki.pki.OperationException

getCertsForDeltaCrl

public List<CertRevInfoWithSerial> getCertsForDeltaCrl(org.xipki.ca.api.NameId ca,
                                                       BigInteger baseCrlNumber,
                                                       Instant notExpiredAt)
                                                throws org.xipki.pki.OperationException

Specified by:

getCertsForDeltaCrl in interface CertStore

Throws:

org.xipki.pki.OperationException

getCertStatusForSubject

public CertStore.CertStatus getCertStatusForSubject(org.xipki.ca.api.NameId ca,
                                                    org.bouncycastle.asn1.x500.X500Name subject)
                                             throws org.xipki.pki.OperationException

Specified by:

getCertStatusForSubject in interface CertStore

Throws:

org.xipki.pki.OperationException

isHealthy

public boolean isHealthy()

Specified by:

isHealthy in interface CertStore

updateDbInfo

public void updateDbInfo()
                  throws org.xipki.datasource.DataAccessException,
                         org.xipki.ca.api.mgmt.CaMgmtException

Specified by:

updateDbInfo in interface CertStore

Throws:

org.xipki.datasource.DataAccessException

org.xipki.ca.api.mgmt.CaMgmtException

buildSelectFirstSql

protected String buildSelectFirstSql(String coreSql)

buildSelectFirstSql

protected String buildSelectFirstSql(String orderBy,
                                     String coreSql)

colBool

protected static org.xipki.ca.server.db.QueryExecutor.SqlColumn colBool(String name,
                                                                        Boolean value)

colInt

protected static org.xipki.ca.server.db.QueryExecutor.SqlColumn colInt(String name,
                                                                       Integer value)

colLong

protected static org.xipki.ca.server.db.QueryExecutor.SqlColumn colLong(String name,
                                                                        Long value)

colStr

protected static org.xipki.ca.server.db.QueryExecutor.SqlColumn colStr(String name,
                                                                       String value)

colStr

protected static org.xipki.ca.server.db.QueryExecutor.SqlColumn colStr(String name,
                                                                       String value,
                                                                       boolean sensitive,
                                                                       boolean signerConf)

col2Bool

protected static org.xipki.ca.server.db.QueryExecutor.SqlColumn2 col2Bool(Boolean value)

col2Int

protected static org.xipki.ca.server.db.QueryExecutor.SqlColumn2 col2Int(Integer value)

col2Long

protected static org.xipki.ca.server.db.QueryExecutor.SqlColumn2 col2Long(Long value)

col2Str

protected static org.xipki.ca.server.db.QueryExecutor.SqlColumn2 col2Str(String value)

col2Timestamp

protected static org.xipki.ca.server.db.QueryExecutor.SqlColumn2 col2Timestamp(Timestamp value)

execUpdateStmt

protected int execUpdateStmt(String sql)
                      throws org.xipki.datasource.DataAccessException

Throws:

org.xipki.datasource.DataAccessException

execUpdatePrepStmt

protected int execUpdatePrepStmt(String sql,
                                 org.xipki.ca.server.db.QueryExecutor.SqlColumn2... params)
                          throws org.xipki.datasource.DataAccessException

Throws:

org.xipki.datasource.DataAccessException

execQueryStmt

protected List<org.xipki.ca.server.db.ResultRow> execQueryStmt(String sql)
                                                        throws org.xipki.datasource.DataAccessException

Throws:

org.xipki.datasource.DataAccessException

execQuery1PrepStmt

protected org.xipki.ca.server.db.ResultRow execQuery1PrepStmt(String sql,
                                                              org.xipki.ca.server.db.QueryExecutor.SqlColumn2... params)
                                                       throws org.xipki.datasource.DataAccessException

Throws:

org.xipki.datasource.DataAccessException

execQueryPrepStmt

protected List<org.xipki.ca.server.db.ResultRow> execQueryPrepStmt(String sql,
                                                                   org.xipki.ca.server.db.QueryExecutor.SqlColumn2... params)
                                                            throws org.xipki.datasource.DataAccessException

Throws:

org.xipki.datasource.DataAccessException

buildPrepStmt

protected PreparedStatement buildPrepStmt(String sql,
                                          org.xipki.ca.server.db.QueryExecutor.SqlColumn2... columns)
                                   throws org.xipki.datasource.DataAccessException

Throws:

org.xipki.datasource.DataAccessException

notNulls

protected void notNulls(Object param1,
                        String name1,
                        Object param2,
                        String name2)

notNulls

protected void notNulls(Object param1,
                        String name1,
                        Object param2,
                        String name2,
                        Object param3,
                        String name3)

notNulls

protected void notNulls(Object param1,
                        String name1,
                        Object param2,
                        String name2,
                        Object param3,
                        String name3,
                        Object param4,
                        String name4)