Package org.springframework.credhub.core.certificate

Class CredHubCertificateTemplate

java.lang.Object

org.springframework.credhub.core.certificate.CredHubCertificateTemplate

All Implemented Interfaces:

CredHubCertificateOperations

public class CredHubCertificateTemplate
extends Object
implements CredHubCertificateOperations

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

Author:

Scott Frederick

Constructor Summary

Constructors

Constructor	Description
CredHubCertificateTemplate(CredHubOperations credHubOperations)	Create a new CredHubCertificateTemplate.

Method Summary

Modifier and Type	Method	Description
List<CertificateSummary>	getAll()	Retrieve all certificates from CredHub.
CertificateSummary	getByName(CredentialName name)	Retrieve a certificate using its name.
CertificateCredentialDetails	regenerate(String id, boolean setAsTransitional)	Regenerate a certificate.
List<CredentialName>	regenerate(CredentialName certificateName)	Regenerate all certificates in CredHub that were signed by the specified certificate.
List<CertificateCredentialDetails>	updateTransitionalVersion(String id, 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 Details

CredHubCertificateTemplate

public CredHubCertificateTemplate(CredHubOperations credHubOperations)

Create a new CredHubCertificateTemplate.

Parameters:

credHubOperations - the CredHubOperations to use for interactions with CredHub

Method Details

getAll

public List<CertificateSummary> getAll()

Description copied from interface: CredHubCertificateOperations

Retrieve all certificates from CredHub.

Specified by:

getAll in interface CredHubCertificateOperations

Returns:

a collection of certificates

getByName

public CertificateSummary getByName(CredentialName name)

Description copied from interface: CredHubCertificateOperations

Retrieve a certificate using its name.

Specified by:

getByName in interface CredHubCertificateOperations

Parameters:

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

Returns:

the details of the retrieved certificate credential

regenerate

public CertificateCredentialDetails regenerate(String id,
 boolean setAsTransitional)

Description copied from interface: CredHubCertificateOperations

Regenerate a certificate.

Specified by:

regenerate in interface CredHubCertificateOperations

Parameters:

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

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

Returns:

the details of the certificate credential

regenerate

public List<CredentialName> regenerate(CredentialName certificateName)

Description copied from interface: CredHubCertificateOperations

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

Specified by:

regenerate in interface CredHubCertificateOperations

Parameters:

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

Returns:

the names of all regenerated certificate credentials

updateTransitionalVersion

public List<CertificateCredentialDetails> updateTransitionalVersion(String id,
 String versionId)

Description copied from interface: CredHubCertificateOperations

Make the specified version of a certificate the transitional version.

Specified by:

updateTransitionalVersion in interface CredHubCertificateOperations

Parameters:

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