Interface CaConfStore

  • All Known Implementing Classes:
    DbCaConfStore, FileCaConfStore

    public interface CaConfStore
    Execute the database queries to manage CA system.
    Author:
    Lijun Liao (xipki)
    • Method Detail

      • needsCertStore

        boolean needsCertStore()
      • getSystemEvent

        SystemEvent getSystemEvent​(String eventName)
                            throws org.xipki.ca.api.mgmt.CaMgmtException
        Retrieve the system event.
        Parameters:
        eventName - Event name
        Returns:
        the System event, may be null.
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException - If error occurs.
      • changeSystemEvent

        void changeSystemEvent​(SystemEvent systemEvent)
                        throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • createCaAliases

        Map<String,​Integer> createCaAliases()
                                           throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • createCertprofile

        org.xipki.ca.api.mgmt.entry.CertprofileEntry createCertprofile​(String name)
                                                                throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • createPublisher

        org.xipki.ca.api.mgmt.entry.PublisherEntry createPublisher​(String name)
                                                            throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • getRequestorId

        Integer getRequestorId​(String requestorName)
                        throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • createRequestor

        org.xipki.ca.api.mgmt.entry.RequestorEntry createRequestor​(String name)
                                                            throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • createSigner

        org.xipki.ca.api.mgmt.entry.SignerEntry createSigner​(String name)
                                                      throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • createKeypairGen

        org.xipki.ca.api.mgmt.entry.KeypairGenEntry createKeypairGen​(String name)
                                                              throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • createCaInfo

        CaInfo createCaInfo​(String name,
                            CertStore certstore)
                     throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • createCaHasRequestors

        Set<org.xipki.ca.api.mgmt.entry.CaHasRequestorEntry> createCaHasRequestors​(org.xipki.ca.api.NameId ca)
                                                                            throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • createCaHasProfiles

        Set<CaProfileIdAliases> createCaHasProfiles​(org.xipki.ca.api.NameId ca)
                                             throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • createCaHasPublishers

        Set<Integer> createCaHasPublishers​(org.xipki.ca.api.NameId ca)
                                    throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • addCa

        void addCa​(org.xipki.ca.api.mgmt.entry.CaEntry caEntry)
            throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • addCaAlias

        void addCaAlias​(String aliasName,
                        org.xipki.ca.api.NameId ca)
                 throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • addCertprofile

        void addCertprofile​(org.xipki.ca.api.mgmt.entry.CertprofileEntry dbEntry)
                     throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • addCertprofileToCa

        void addCertprofileToCa​(org.xipki.ca.api.NameId profile,
                                org.xipki.ca.api.NameId ca,
                                List<String> aliases)
                         throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • addPublisherToCa

        void addPublisherToCa​(org.xipki.ca.api.NameId publisher,
                              org.xipki.ca.api.NameId ca)
                       throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • addRequestor

        void addRequestor​(org.xipki.ca.api.mgmt.entry.RequestorEntry dbEntry)
                   throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • addEmbeddedRequestor

        org.xipki.ca.api.NameId addEmbeddedRequestor​(String requestorName)
                                              throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • addRequestorToCa

        void addRequestorToCa​(org.xipki.ca.api.mgmt.entry.CaHasRequestorEntry requestor,
                              org.xipki.ca.api.NameId ca)
                       throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • addPublisher

        void addPublisher​(org.xipki.ca.api.mgmt.entry.PublisherEntry dbEntry)
                   throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • changeCa

        void changeCa​(org.xipki.ca.api.mgmt.entry.ChangeCaEntry changeCaEntry,
                      org.xipki.ca.api.mgmt.entry.CaConfColumn currentCaConfColumn,
                      org.xipki.security.SecurityFactory securityFactory)
               throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • commitNextCrlNoIfLess

        void commitNextCrlNoIfLess​(org.xipki.ca.api.NameId ca,
                                   long nextCrlNo)
                            throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • changeCertprofile

        IdentifiedCertprofile changeCertprofile​(org.xipki.ca.api.NameId nameId,
                                                String type,
                                                String conf,
                                                CaManagerImpl certprofileManager)
                                         throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • changeRequestor

        RequestorEntryWrapper changeRequestor​(org.xipki.ca.api.NameId nameId,
                                              String type,
                                              String conf)
                                       throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • changeSigner

        org.xipki.ca.api.mgmt.entry.SignerEntry changeSigner​(String name,
                                                             String type,
                                                             String conf,
                                                             String base64Cert,
                                                             CaManagerImpl signerManager)
                                                      throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • removeCaAlias

        void removeCaAlias​(String aliasName)
                    throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • removeCertprofileFromCa

        void removeCertprofileFromCa​(String profileName,
                                     String caName)
                              throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • removeRequestorFromCa

        void removeRequestorFromCa​(String requestorName,
                                   String caName)
                            throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • removePublisherFromCa

        void removePublisherFromCa​(String publisherName,
                                   String caName)
                            throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • removeDbSchema

        void removeDbSchema​(String name)
                     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
      • addKeypairGen

        void addKeypairGen​(org.xipki.ca.api.mgmt.entry.KeypairGenEntry dbEntry)
                    throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • addSigner

        void addSigner​(org.xipki.ca.api.mgmt.entry.SignerEntry dbEntry)
                throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • unlockCa

        void unlockCa()
               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
      • getDbSchemaVersion

        int getDbSchemaVersion()
      • addDbSchema

        void addDbSchema​(String name,
                         String value)
                  throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • changeDbSchema

        void changeDbSchema​(String name,
                            String value)
                     throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • getDbSchemas

        Map<String,​String> getDbSchemas()
                                       throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • getCaNames

        List<String> getCaNames()
                         throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • deleteCa

        boolean deleteCa​(String name)
                  throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • getKeyPairGenNames

        List<String> getKeyPairGenNames()
                                 throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • deleteKeyPairGen

        boolean deleteKeyPairGen​(String name)
                          throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • getProfileNames

        List<String> getProfileNames()
                              throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • deleteProfile

        boolean deleteProfile​(String name)
                       throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • getPublisherNames

        List<String> getPublisherNames()
                                throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • deletePublisher

        boolean deletePublisher​(String name)
                         throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • getRequestorNames

        List<String> getRequestorNames()
                                throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • deleteRequestor

        boolean deleteRequestor​(String name)
                         throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • getSignerNames

        List<String> getSignerNames()
                             throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException
      • deleteSigner

        boolean deleteSigner​(String name)
                      throws org.xipki.ca.api.mgmt.CaMgmtException
        Throws:
        org.xipki.ca.api.mgmt.CaMgmtException