Package org.springframework.vault.core.certificate

Interface CertificateRegistry

All Known Implementing Classes:
CertificateContainer
public interface CertificateRegistry
Registry to manage RequestedCertificates (request and rotation).
Since:
4.1
Author:
Mark Paluch

  • Method Details

    • register

      void register(RequestedCertificate certificate)
      Register a RequestedCertificate with the registry.

      Subsequent registrations of the same RequestedCertificate are considered as a single registration and the secret will be managed only once.

      Parameters:
      certificate - the certificate to be managed.

    • register

      void register(RequestedCertificate certificate, CertificateListener listener)
      Register a RequestedCertificate with the registry with an associated CertificateListener.

      Subsequent registrations of the same RequestedCertificate are considered as a single registration and the secret will be managed only once. A requested secret that has been already been registered and activated by the container will not lead to emission of a new SecretLeaseCreatedEvent with the previous secrets body but rather only to future events such as rotations or renewals.

      Parameters:
      certificate - the requested certificate to be managed.
      listener - listener to associate with the requested certificate. The listener will be notified only with events concerning the requested certificate.

    • unregister

      boolean unregister(RequestedCertificate certificate)
      Unregister the RequestedCertificate from the registry. Removing the certificate stops rotations, and it removes listener registrations that were associated with the certificate registration.
      Parameters:
      certificate - the certificate to be deregistered.
      Returns:
      true if the certificate was registered before and has been removed; false otherwise.