Package org.xipki.ca.server

Interface CertStore

  • All Known Implementing Classes:
    DbCertStore
    public interface CertStore
    CA cert store.
    Since:
    2.0.0
    Author:
    Lijun Liao (xipki)

    • Method Detail

      • removeCa

        void removeCa​(String name)
       throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException

      • removeCertProfile

        void removeCertProfile​(String name)
                throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException

      • removeRequestor

        void removeRequestor​(String name)
              throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException

      • addCertProfile

        void addCertProfile​(org.xipki.ca.api.NameId ident)
             throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException

      • addRequestor

        void addRequestor​(org.xipki.ca.api.NameId ident)
           throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException

      • addCa

        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
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException

      • revokeCa

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

      • unrevokeCa

        void unrevokeCa​(String caName)
         throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException

      • addCert

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

      • getMaxFullCrlNumber

        long getMaxFullCrlNumber​(org.xipki.ca.api.NameId ca)
                  throws org.xipki.pki.OperationException
        Throws:
        org.xipki.pki.OperationException

      • getMaxCrlNumber

        long getMaxCrlNumber​(org.xipki.ca.api.NameId ca)
              throws org.xipki.pki.OperationException
        Throws:
        org.xipki.pki.OperationException

      • getThisUpdateOfCurrentCrl

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

      • addCrl

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

      • revokeCert

        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
        Throws:
        org.xipki.pki.OperationException

      • revokeSuspendedCert

        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
        Throws:
        org.xipki.pki.OperationException

      • unsuspendCert

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

      • removeCert

        void removeCert​(long id)
         throws org.xipki.pki.OperationException
        Throws:
        org.xipki.pki.OperationException

      • getCountOfCerts

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

      • getCountOfCerts

        long getCountOfCerts​(long notBeforeSince)
              throws org.xipki.pki.OperationException
        Throws:
        org.xipki.pki.OperationException

      • getSerialNumbers

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

      • getExpiredUnrevokedSerialNumbers

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

      • getSuspendedCertSerials

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

      • getEncodedCrl

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

      • cleanupCrls

        int cleanupCrls​(org.xipki.ca.api.NameId ca,
                int numCrls)
         throws org.xipki.pki.OperationException
        Throws:
        org.xipki.pki.OperationException

      • getCertForId

        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
        Throws:
        org.xipki.pki.OperationException

      • getCertWithRevocationInfo

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

      • getCertWithRevocationInfo

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

      • getCertWithRevocationInfoBySubject

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

      • getCertId

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

      • getCertInfo

        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
        Throws:
        org.xipki.pki.OperationException

      • getCert

        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.
        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

        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
        Throws:
        org.xipki.pki.OperationException

      • getRevokedCerts

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

      • getCertsForDeltaCrl

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

      • getCertStatusForSubject

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

      • isHealthy

        boolean isHealthy()

      • updateDbInfo

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