Interface ReactiveCredHubCertificateOperations
- All Known Implementing Classes:
ReactiveCredHubCertificateTemplate
public interface ReactiveCredHubCertificateOperations
Specifies the interactions with CredHub to retrieve, regenerate, and update
certificates.
- Author:
- Scott Frederick
-
Method Summary
Modifier and TypeMethodDescriptionreactor.core.publisher.Flux<CertificateSummary>
getAll()
Retrieve all certificates from CredHub.reactor.core.publisher.Mono<CertificateSummary>
getByName
(CredentialName name) Retrieve a certificate using its name.reactor.core.publisher.Mono<CertificateCredentialDetails>
regenerate
(String id, boolean setAsTransitional) Regenerate a certificate.reactor.core.publisher.Flux<CredentialName>
regenerate
(CredentialName certificateName) Regenerate all certificates in CredHub that were signed by the specified certificate.reactor.core.publisher.Flux<CertificateCredentialDetails>
updateTransitionalVersion
(String id, String versionId) Make the specified version of a certificate the transitional version.
-
Method Details
-
getAll
reactor.core.publisher.Flux<CertificateSummary> getAll()Retrieve all certificates from CredHub.- Returns:
- a collection of certificates
-
getByName
Retrieve a certificate using its name.- Parameters:
name
- the name of the certificate credential; must not be null- Returns:
- the details of the retrieved certificate credential
-
regenerate
reactor.core.publisher.Mono<CertificateCredentialDetails> regenerate(String id, boolean setAsTransitional) Regenerate a certificate.- Parameters:
id
- the CredHub-generated ID of the certificate credential; must not be null and must be an ID returned bygetAll()
orgetByName(CredentialName)
setAsTransitional
-true
to mark the certificate version transitional;false
otherwise- Returns:
- the details of the certificate credential
-
regenerate
Regenerate all certificates in CredHub that were signed by the specified certificate.- Parameters:
certificateName
- the name of the signing certificate credential; must not be null- Returns:
- the names of all regenerated certificate credentials
-
updateTransitionalVersion
reactor.core.publisher.Flux<CertificateCredentialDetails> updateTransitionalVersion(String id, String versionId) Make the specified version of a certificate the transitional version.- Parameters:
id
- the CredHub-generated ID of the certificate credential; must not be null and must be an ID returned bygetAll()
orgetByName(CredentialName)
versionId
- the CredHub-generated ID of the version of the certificate credential that should be marked transitional, or null to indicate that no version is transitional- Returns:
- the details of the certificate credential, including all versions
-