org.springframework.credhub.core.certificate

Class ReactiveCredHubCertificateTemplate

java.lang.Object

org.springframework.credhub.core.certificate.ReactiveCredHubCertificateTemplate

All Implemented Interfaces:

ReactiveCredHubCertificateOperations

public class ReactiveCredHubCertificateTemplate
extends java.lang.Object
implements ReactiveCredHubCertificateOperations

Implements the interactions with CredHub to retrieve, regenerate, and update certificates.

Author:

Scott Frederick

Constructor Summary

Constructors

Constructor and Description
ReactiveCredHubCertificateTemplate(ReactiveCredHubOperations credHubOperations) Create a new ReactiveCredHubCertificateTemplate.

Method Summary

Modifier and Type	Method and Description
reactor.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.Flux<CredentialName>	regenerate(CredentialName certificateName) Regenerate all certificates in CredHub that were signed by the specified certificate.
reactor.core.publisher.Mono<CertificateCredentialDetails>	regenerate(java.lang.String id, boolean setAsTransitional) Regenerate a certificate.
reactor.core.publisher.Flux<CertificateCredentialDetails>	updateTransitionalVersion(java.lang.String id, java.lang.String versionId) Make the specified version of a certificate the transitional version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReactiveCredHubCertificateTemplate

public ReactiveCredHubCertificateTemplate(ReactiveCredHubOperations credHubOperations)

Create a new ReactiveCredHubCertificateTemplate.

Parameters:

credHubOperations - the ReactiveCredHubOperations to use for interactions with CredHub

Method Detail

getAll

public reactor.core.publisher.Flux<CertificateSummary> getAll()

Description copied from interface: ReactiveCredHubCertificateOperations

Retrieve all certificates from CredHub.

Specified by:

getAll in interface ReactiveCredHubCertificateOperations

Returns:

a collection of certificates

getByName

public reactor.core.publisher.Mono<CertificateSummary> getByName(CredentialName name)

Description copied from interface: ReactiveCredHubCertificateOperations

Retrieve a certificate using its name.

Specified by:

getByName in interface ReactiveCredHubCertificateOperations

Parameters:

name - the name of the certificate credential; must not be null

Returns:

the details of the retrieved certificate credential

regenerate

public reactor.core.publisher.Mono<CertificateCredentialDetails> regenerate(java.lang.String id,
                                                                            boolean setAsTransitional)

Description copied from interface: ReactiveCredHubCertificateOperations

Regenerate a certificate.

Specified by:

regenerate in interface ReactiveCredHubCertificateOperations

Parameters:

id - the CredHub-generated ID of the certificate credential; must not be null and must be an ID returned by ReactiveCredHubCertificateOperations.getAll() or ReactiveCredHubCertificateOperations.getByName(CredentialName)

setAsTransitional - true to mark the certificate version transitional; false otherwise

Returns:

the details of the certificate credential

regenerate

public reactor.core.publisher.Flux<CredentialName> regenerate(CredentialName certificateName)

Description copied from interface: ReactiveCredHubCertificateOperations

Regenerate all certificates in CredHub that were signed by the specified certificate.

Specified by:

regenerate in interface ReactiveCredHubCertificateOperations

Parameters:

certificateName - the name of the signing certificate credential; must not be null

Returns:

the names of all regenerated certificate credentials

updateTransitionalVersion

public reactor.core.publisher.Flux<CertificateCredentialDetails> updateTransitionalVersion(java.lang.String id,
                                                                                           java.lang.String versionId)

Description copied from interface: ReactiveCredHubCertificateOperations

Make the specified version of a certificate the transitional version.

Specified by:

updateTransitionalVersion in interface ReactiveCredHubCertificateOperations

Parameters:

id - the CredHub-generated ID of the certificate credential; must not be null and must be an ID returned by ReactiveCredHubCertificateOperations.getAll() or ReactiveCredHubCertificateOperations.getByName(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