org.springframework.credhub.support.certificate

Class CertificateParameters.CertificateParametersBuilder

java.lang.Object

org.springframework.credhub.support.certificate.CertificateParameters.CertificateParametersBuilder

Enclosing class:

CertificateParameters

public static class CertificateParameters.CertificateParametersBuilder
extends Object

A builder that provides a fluent API for constructing CertificateParameters.CertificateParametersBuilders.

Constructor Summary

Constructors

Constructor and Description
CertificateParametersBuilder()

Method Summary

Modifier and Type	Method and Description
CertificateParameters.CertificateParametersBuilder	alternateNames(String... alternativeNames) Set the Alternative Names (SAN) field to be used for the generated certificate.
CertificateParameters	build() Create a CertificateParameters from the provided values.
CertificateParameters.CertificateParametersBuilder	certificateAuthority(boolean certificateAuthority) Set the value of the flag that indicates whether the generated certificate is a certificate authority.
CertificateParameters.CertificateParametersBuilder	certificateAuthorityCredential(CredentialName certificateAuthorityCredential) Set the name of a certificate authority credential in CredHub to sign the generated certificate with.
CertificateParameters.CertificateParametersBuilder	certificateAuthorityCredential(String certificateAuthorityCredential) Set the name of a certificate authority credential in CredHub to sign the generated certificate with.
CertificateParameters.CertificateParametersBuilder	commonName(String commonName) Set the Common Name (CN) field to be used for the generated certificate.
CertificateParameters.CertificateParametersBuilder	country(String country) Set the Country (C) field to be used for the generated certificate.
CertificateParameters.CertificateParametersBuilder	duration(int duration) Set the duration in days that the generated certificate should be valid.
CertificateParameters.CertificateParametersBuilder	extendedKeyUsage(ExtendedKeyUsage... extendedKeyUsage) Set the value of the extended key usage extensions for the generated certificate.
CertificateParameters.CertificateParametersBuilder	keyLength(KeyLength keyLength) Set the length of the key for the generated certificate.
CertificateParameters.CertificateParametersBuilder	keyUsage(KeyUsage... keyUsage) Set the value of the key usage extensions for the generated certificate.
CertificateParameters.CertificateParametersBuilder	locality(String locality) Set the Locality (L) field to be used for the generated certificate.
CertificateParameters.CertificateParametersBuilder	organization(String organization) Set the Organization (O) field to be used for the generated certificate.
CertificateParameters.CertificateParametersBuilder	organizationUnit(String organizationUnit) Set the Organization Unit (OU) field to be used for the generated certificate.
CertificateParameters.CertificateParametersBuilder	selfSign(boolean selfSign) Set the value of the flag that indicates whether the generated certificate should be self-signed.
CertificateParameters.CertificateParametersBuilder	state(String state) Set the State (S) field to be used for the generated certificate.

Methods inherited from class java.lang.Object

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

Constructor Detail

CertificateParametersBuilder

public CertificateParametersBuilder()

Method Detail

keyLength

public CertificateParameters.CertificateParametersBuilder keyLength(KeyLength keyLength)

Set the length of the key for the generated certificate.

Parameters:

keyLength - the parameter value; must not be null

Returns:

the builder

commonName

public CertificateParameters.CertificateParametersBuilder commonName(String commonName)

Set the Common Name (CN) field to be used for the generated certificate.

Parameters:

commonName - the parameter value; must not be null

Returns:

the builder

alternateNames

public CertificateParameters.CertificateParametersBuilder alternateNames(String... alternativeNames)

Set the Alternative Names (SAN) field to be used for the generated certificate.

Parameters:

alternativeNames - the parameter value; must not be null

Returns:

the builder

organization

public CertificateParameters.CertificateParametersBuilder organization(String organization)

Set the Organization (O) field to be used for the generated certificate.

Parameters:

organization - the parameter value; must not be null

Returns:

the builder

organizationUnit

public CertificateParameters.CertificateParametersBuilder organizationUnit(String organizationUnit)

Set the Organization Unit (OU) field to be used for the generated certificate.

Parameters:

organizationUnit - the parameter value; must not be null

Returns:

the builder

locality

public CertificateParameters.CertificateParametersBuilder locality(String locality)

Set the Locality (L) field to be used for the generated certificate.

Parameters:

locality - the parameter value; must not be null

Returns:

the builder

state

public CertificateParameters.CertificateParametersBuilder state(String state)

Set the State (S) field to be used for the generated certificate.

Parameters:

state - the parameter value; must not be null

Returns:

the builder

country

public CertificateParameters.CertificateParametersBuilder country(String country)

Set the Country (C) field to be used for the generated certificate.

Parameters:

country - the parameter value; must not be null

Returns:

the builder

duration

public CertificateParameters.CertificateParametersBuilder duration(int duration)

Set the duration in days that the generated certificate should be valid.

Parameters:

duration - the parameter value

Returns:

the builder

certificateAuthorityCredential

public CertificateParameters.CertificateParametersBuilder certificateAuthorityCredential(String certificateAuthorityCredential)

Set the name of a certificate authority credential in CredHub to sign the generated certificate with.

Parameters:

certificateAuthorityCredential - the parameter value; must not be null

Returns:

the builder

certificateAuthorityCredential

public CertificateParameters.CertificateParametersBuilder certificateAuthorityCredential(CredentialName certificateAuthorityCredential)

Set the name of a certificate authority credential in CredHub to sign the generated certificate with.

Parameters:

certificateAuthorityCredential - the parameter value; must not be null

Returns:

the builder

certificateAuthority

public CertificateParameters.CertificateParametersBuilder certificateAuthority(boolean certificateAuthority)

Set the value of the flag that indicates whether the generated certificate is a certificate authority.

Parameters:

certificateAuthority - the parameter value

Returns:

the builder

selfSign

public CertificateParameters.CertificateParametersBuilder selfSign(boolean selfSign)

Set the value of the flag that indicates whether the generated certificate should be self-signed.

Parameters:

selfSign - the parameter value

Returns:

the builder

keyUsage

public CertificateParameters.CertificateParametersBuilder keyUsage(KeyUsage... keyUsage)

Set the value of the key usage extensions for the generated certificate.

Parameters:

keyUsage - one or more parameter values

Returns:

the builder

extendedKeyUsage

public CertificateParameters.CertificateParametersBuilder extendedKeyUsage(ExtendedKeyUsage... extendedKeyUsage)

Set the value of the extended key usage extensions for the generated certificate.

Parameters:

extendedKeyUsage - one or more parameter values

Returns:

the builder

build

public CertificateParameters build()

Create a CertificateParameters from the provided values.

Returns:

the created CertificateParameters