org.xipki.ca.server.db

Class CertStore

java.lang.Object

org.xipki.ca.server.db.CertStoreBase

org.xipki.ca.server.db.CertStore

public class CertStore
extends CertStoreBase

CA database store.

Since:

2.0.0

Author:

Lijun Liao

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CertStore.CertStatus
static class	CertStore.KnowCertResult
static class	CertStore.SerialWithId
static class	CertStore.SystemEvent
protected static class	QueryExecutor.ColumnType
protected static class	QueryExecutor.DbSchemaInfo
protected static class	QueryExecutor.SqlColumn
protected static class	QueryExecutor.SqlColumn2

Field Summary

Fields

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

Fields inherited from class org.xipki.ca.server.db.CertStoreBase

dbSchemaVersion, maxX500nameLen, SQL_ADD_CERT, SQL_ADD_CERT_V4, SQL_ADD_CRL, SQL_ADD_REQCERT, SQL_ADD_REQUEST, SQL_DELETE_UNREFERENCED_REQUEST, SQL_INSERT_PUBLISHQUEUE, SQL_MAX_CRLNO, SQL_MAX_FULL_CRLNO, SQL_MAX_THISUPDAATE_CRL, SQL_REMOVE_CERT_FOR_ID, SQL_REMOVE_PUBLISHQUEUE, SQL_REVOKE_CERT, SQL_REVOKE_SUSPENDED_CERT

Constructor Summary

Constructors

Constructor and Description
CertStore(org.xipki.datasource.DataSourceWrapper datasource, UniqueIdGenerator idGenerator)

Method Summary

Modifier and Type	Method and Description
boolean	addCert(org.xipki.ca.api.CertificateInfo certInfo)
void	addCrl(org.xipki.ca.api.NameId ca, org.bouncycastle.cert.X509CRLHolder crl)
long	addRequest(byte[] request)
void	addRequestCert(long requestId, long certId)
void	addToPublishQueue(org.xipki.ca.api.NameId publisher, long certId, org.xipki.ca.api.NameId ca)
org.xipki.ca.api.NameId	authenticateUser(String user, byte[] password)
protected PreparedStatement	buildPrepStmt(String sql, 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)
void	clearPublishQueue(org.xipki.ca.api.NameId ca, org.xipki.ca.api.NameId publisher)
protected static QueryExecutor.SqlColumn2	col2Bool(Boolean value)
protected static QueryExecutor.SqlColumn2	col2Int(Integer value)
protected static QueryExecutor.SqlColumn2	col2Long(Long value)
protected static QueryExecutor.SqlColumn2	col2Str(String value)
protected static QueryExecutor.SqlColumn2	col2Timestamp(Timestamp value)
protected static QueryExecutor.SqlColumn	colBool(String name, Boolean value)
protected static QueryExecutor.SqlColumn	colInt(String name, Integer value)
protected static QueryExecutor.SqlColumn	colLong(String name, Long value)
protected static QueryExecutor.SqlColumn	colStr(String name, String value)
protected static QueryExecutor.SqlColumn	colStr(String name, String value, boolean sensitive, boolean signerConf)
void	deleteUnreferencedRequests()
protected org.xipki.ca.server.db.ResultRow	execQuery1PrepStmt(String sql, QueryExecutor.SqlColumn2... params)
protected List<org.xipki.ca.server.db.ResultRow>	execQueryPrepStmt(String sql, QueryExecutor.SqlColumn2... params)
protected List<org.xipki.ca.server.db.ResultRow>	execQueryStmt(String sql)
protected int	execUpdatePrepStmt(String sql, QueryExecutor.SqlColumn2... params)
protected int	execUpdateStmt(String sql)
org.xipki.ca.api.mgmt.entry.CaHasUserEntry	getCaHasUser(org.xipki.ca.api.NameId ca, org.xipki.ca.api.NameId user)
List<org.xipki.security.X509Cert>	getCert(org.bouncycastle.asn1.x500.X500Name subjectName, byte[] transactionId) Get certificates 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)
byte[]	getCertRequest(org.xipki.ca.api.NameId ca, BigInteger serialNumber)
List<CertRevInfoWithSerial>	getCertsForDeltaCrl(org.xipki.ca.api.NameId ca, BigInteger baseCrlNumber, Date 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)
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<Long>	getPublishQueueEntries(org.xipki.ca.api.NameId ca, org.xipki.ca.api.NameId publisher, int numEntries)
List<CertRevInfoWithSerial>	getRevokedCerts(org.xipki.ca.api.NameId ca, Date 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, long latestLastUpdate, int numEntries)
long	getThisUpdateOfCurrentCrl(org.xipki.ca.api.NameId ca, boolean deltaCrl)
String	getUsername(int id)
boolean	isHealthy()
CertStore.KnowCertResult	knowsCertForSerial(org.xipki.ca.api.NameId ca, BigInteger serial)
List<org.xipki.ca.api.mgmt.CertListInfo>	listCerts(org.xipki.ca.api.NameId ca, org.bouncycastle.asn1.x500.X500Name subjectPattern, Date validFrom, Date 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	removeCert(long id)
void	removeCert(org.xipki.ca.api.NameId ca, BigInteger serialNumber)
void	removeFromPublishQueue(org.xipki.ca.api.NameId publisher, long certId)
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)
org.xipki.ca.api.CertWithDbId	unrevokeCert(org.xipki.ca.api.NameId ca, BigInteger serialNumber, boolean force, CaIdNameMap idNamMap)

Methods inherited from class org.xipki.ca.server.db.CertStoreBase

buildArraySql, buildCertRevInfo, buildPrepStmt0, execQuery1PrepStmt0, execQueryLongPrepStmt, execQueryPrepStmt0, execQueryStmt0, execUpdatePrepStmt0, execUpdateStmt0, getMax, parseCert, prepareStatement

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

CertStore

public CertStore(org.xipki.datasource.DataSourceWrapper datasource,
                 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

addCert

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

addToPublishQueue

public void addToPublishQueue(org.xipki.ca.api.NameId publisher,
                              long certId,
                              org.xipki.ca.api.NameId ca)
                       throws org.xipki.ca.api.OperationException

Throws:

org.xipki.ca.api.OperationException

removeFromPublishQueue

public void removeFromPublishQueue(org.xipki.ca.api.NameId publisher,
                                   long certId)
                            throws org.xipki.ca.api.OperationException

Throws:

org.xipki.ca.api.OperationException

clearPublishQueue

public void clearPublishQueue(org.xipki.ca.api.NameId ca,
                              org.xipki.ca.api.NameId publisher)
                       throws org.xipki.ca.api.OperationException

Throws:

org.xipki.ca.api.OperationException

getMaxFullCrlNumber

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

Throws:

org.xipki.ca.api.OperationException

getMaxCrlNumber

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

Throws:

org.xipki.ca.api.OperationException

getThisUpdateOfCurrentCrl

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

Throws:

org.xipki.ca.api.OperationException

addCrl

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

Throws:

org.xipki.ca.api.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.ca.api.OperationException

Throws:

org.xipki.ca.api.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.ca.api.OperationException

Throws:

org.xipki.ca.api.OperationException

unrevokeCert

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

Throws:

org.xipki.ca.api.OperationException

removeCert

public void removeCert(org.xipki.ca.api.NameId ca,
                       BigInteger serialNumber)
                throws org.xipki.ca.api.OperationException

Throws:

org.xipki.ca.api.OperationException

removeCert

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

Throws:

org.xipki.ca.api.OperationException

getPublishQueueEntries

public List<Long> getPublishQueueEntries(org.xipki.ca.api.NameId ca,
                                         org.xipki.ca.api.NameId publisher,
                                         int numEntries)
                                  throws org.xipki.ca.api.OperationException

Throws:

org.xipki.ca.api.OperationException

getCountOfCerts

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

Throws:

org.xipki.ca.api.OperationException

getSerialNumbers

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

Throws:

org.xipki.ca.api.OperationException

getExpiredUnrevokedSerialNumbers

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

Throws:

org.xipki.ca.api.OperationException

getSuspendedCertSerials

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

Throws:

org.xipki.ca.api.OperationException

getEncodedCrl

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

Throws:

org.xipki.ca.api.OperationException

cleanupCrls

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

Throws:

org.xipki.ca.api.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.ca.api.OperationException

Throws:

org.xipki.ca.api.OperationException

getCertWithRevocationInfo

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

Throws:

org.xipki.ca.api.OperationException

getCertWithRevocationInfo

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

Throws:

org.xipki.ca.api.OperationException

getCertId

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

Throws:

org.xipki.ca.api.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.ca.api.OperationException

Throws:

org.xipki.ca.api.OperationException

getCert

public List<org.xipki.security.X509Cert> getCert(org.bouncycastle.asn1.x500.X500Name subjectName,
                                                 byte[] transactionId)
                                          throws org.xipki.ca.api.OperationException

Get certificates for given subject and transactionId.

Parameters:

subjectName - Subject of Certificate or requested Subject.

transactionId - will only be considered if there are more than one certificate matches the subject.

Returns:

certificates for given subject and transactionId.

Throws:

org.xipki.ca.api.OperationException - If error occurs.

getCertRequest

public byte[] getCertRequest(org.xipki.ca.api.NameId ca,
                             BigInteger serialNumber)
                      throws org.xipki.ca.api.OperationException

Throws:

org.xipki.ca.api.OperationException

listCerts

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

Throws:

org.xipki.ca.api.OperationException

authenticateUser

public org.xipki.ca.api.NameId authenticateUser(String user,
                                                byte[] password)
                                         throws org.xipki.ca.api.OperationException

Throws:

org.xipki.ca.api.OperationException

getUsername

public String getUsername(int id)
                   throws org.xipki.ca.api.OperationException

Throws:

org.xipki.ca.api.OperationException

getCaHasUser

public org.xipki.ca.api.mgmt.entry.CaHasUserEntry getCaHasUser(org.xipki.ca.api.NameId ca,
                                                               org.xipki.ca.api.NameId user)
                                                        throws org.xipki.ca.api.OperationException

Throws:

org.xipki.ca.api.OperationException

knowsCertForSerial

public CertStore.KnowCertResult knowsCertForSerial(org.xipki.ca.api.NameId ca,
                                                   BigInteger serial)
                                            throws org.xipki.ca.api.OperationException

Throws:

org.xipki.ca.api.OperationException

getRevokedCerts

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

Throws:

org.xipki.ca.api.OperationException

getCertsForDeltaCrl

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

Throws:

org.xipki.ca.api.OperationException

getCertStatusForSubject

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

Throws:

org.xipki.ca.api.OperationException

isHealthy

public boolean isHealthy()

deleteUnreferencedRequests

public void deleteUnreferencedRequests()
                                throws org.xipki.ca.api.OperationException

Throws:

org.xipki.ca.api.OperationException

addRequest

public long addRequest(byte[] request)
                throws org.xipki.ca.api.OperationException

Throws:

org.xipki.ca.api.OperationException

addRequestCert

public void addRequestCert(long requestId,
                           long certId)
                    throws org.xipki.ca.api.OperationException

Throws:

org.xipki.ca.api.OperationException

buildSelectFirstSql

protected String buildSelectFirstSql(String coreSql)

buildSelectFirstSql

protected String buildSelectFirstSql(String orderBy,
                                     String coreSql)

colBool

protected static QueryExecutor.SqlColumn colBool(String name,
                                                 Boolean value)

colInt

protected static QueryExecutor.SqlColumn colInt(String name,
                                                Integer value)

colLong

protected static QueryExecutor.SqlColumn colLong(String name,
                                                 Long value)

colStr

protected static QueryExecutor.SqlColumn colStr(String name,
                                                String value)

colStr

protected static QueryExecutor.SqlColumn colStr(String name,
                                                String value,
                                                boolean sensitive,
                                                boolean signerConf)

col2Bool

protected static QueryExecutor.SqlColumn2 col2Bool(Boolean value)

col2Int

protected static QueryExecutor.SqlColumn2 col2Int(Integer value)

col2Long

protected static QueryExecutor.SqlColumn2 col2Long(Long value)

col2Str

protected static QueryExecutor.SqlColumn2 col2Str(String value)

col2Timestamp

protected static 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,
                                 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,
                                                              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,
                                                                   QueryExecutor.SqlColumn2... params)
                                                            throws org.xipki.datasource.DataAccessException

Throws:

org.xipki.datasource.DataAccessException

buildPrepStmt

protected PreparedStatement buildPrepStmt(String sql,
                                          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)