org.springframework.vault.support

Class VaultCertificateRequest.VaultCertificateRequestBuilder

java.lang.Object

org.springframework.vault.support.VaultCertificateRequest.VaultCertificateRequestBuilder

Enclosing class:

VaultCertificateRequest

public static class VaultCertificateRequest.VaultCertificateRequestBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
VaultCertificateRequest.VaultCertificateRequestBuilder	altNames(Iterable<String> altNames) Configure alternative names.
VaultCertificateRequest	build() Build a new VaultCertificateRequest instance.
VaultCertificateRequest.VaultCertificateRequestBuilder	commonName(String commonName) Configure the common name.
VaultCertificateRequest.VaultCertificateRequestBuilder	excludeCommonNameFromSubjectAltNames() Exclude the given common name from DNS or Email Subject Alternate Names (as appropriate).
VaultCertificateRequest.VaultCertificateRequestBuilder	ipSubjectAltNames(Iterable<String> ipSubjectAltNames) Configure IP subject alternative names.
VaultCertificateRequest.VaultCertificateRequestBuilder	ttl(Duration ttl) Configure a TTL.
VaultCertificateRequest.VaultCertificateRequestBuilder	ttl(int ttl) Deprecated. since 2.0, use ttl(Duration) for time unit safety.
VaultCertificateRequest.VaultCertificateRequestBuilder	ttl(long ttl, TimeUnit timeUnit) Configure a TTL.
VaultCertificateRequest.VaultCertificateRequestBuilder	uriSubjectAltNames(Iterable<String> uriSubjectAltNames) Configure URI subject alternative names.
VaultCertificateRequest.VaultCertificateRequestBuilder	withAltName(String altName) Add an alternative name.
VaultCertificateRequest.VaultCertificateRequestBuilder	withIpSubjectAltName(String ipSubjectAltName) Add an IP subject alternative name.
VaultCertificateRequest.VaultCertificateRequestBuilder	withUriSubjectAltName(String uriSubjectAltName) Add an URI subject alternative name.

Methods inherited from class java.lang.Object

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

Method Detail

commonName

public VaultCertificateRequest.VaultCertificateRequestBuilder commonName(String commonName)

Configure the common name.

Parameters:

commonName - must not be empty or null.

Returns:

this VaultCertificateRequest.VaultCertificateRequestBuilder.

altNames

public VaultCertificateRequest.VaultCertificateRequestBuilder altNames(Iterable<String> altNames)

Configure alternative names. Replaces previously configured alt names.

Parameters:

altNames - must not be null.

Returns:

this VaultCertificateRequest.VaultCertificateRequestBuilder.

withAltName

public VaultCertificateRequest.VaultCertificateRequestBuilder withAltName(String altName)

Add an alternative name.

Parameters:

altName - must not be empty or null.

Returns:

this VaultCertificateRequest.VaultCertificateRequestBuilder.

ipSubjectAltNames

public VaultCertificateRequest.VaultCertificateRequestBuilder ipSubjectAltNames(Iterable<String> ipSubjectAltNames)

Configure IP subject alternative names. Replaces previously configured IP subject alt names.

Parameters:

ipSubjectAltNames - must not be null.

Returns:

this VaultCertificateRequest.VaultCertificateRequestBuilder.

withIpSubjectAltName

public VaultCertificateRequest.VaultCertificateRequestBuilder withIpSubjectAltName(String ipSubjectAltName)

Add an IP subject alternative name.

Parameters:

ipSubjectAltName - must not be empty or null.

Returns:

this VaultCertificateRequest.VaultCertificateRequestBuilder.

uriSubjectAltNames

public VaultCertificateRequest.VaultCertificateRequestBuilder uriSubjectAltNames(Iterable<String> uriSubjectAltNames)

Configure URI subject alternative names. Replaces previously configured URI subject alt names.

Parameters:

uriSubjectAltNames - must not be null.

Returns:

this VaultCertificateRequest.VaultCertificateRequestBuilder.

Since:

2.2

withUriSubjectAltName

public VaultCertificateRequest.VaultCertificateRequestBuilder withUriSubjectAltName(String uriSubjectAltName)

Add an URI subject alternative name.

Parameters:

uriSubjectAltName - must not be empty or null.

Returns:

this VaultCertificateRequest.VaultCertificateRequestBuilder.

Since:

2.2

ttl

@Deprecated
public VaultCertificateRequest.VaultCertificateRequestBuilder ttl(int ttl)

Deprecated. since 2.0, use ttl(Duration) for time unit safety.

Configure a TTL.

Parameters:

ttl - the time to live, in seconds, must not be negative.

Returns:

this VaultCertificateRequest.VaultCertificateRequestBuilder.

ttl

public VaultCertificateRequest.VaultCertificateRequestBuilder ttl(long ttl,
                                                                  TimeUnit timeUnit)

Configure a TTL.

Parameters:

ttl - the time to live, must not be negative.

timeUnit - must not be null

Returns:

this VaultCertificateRequest.VaultCertificateRequestBuilder.

ttl

public VaultCertificateRequest.VaultCertificateRequestBuilder ttl(Duration ttl)

Configure a TTL.

Parameters:

ttl - the time to live, must not be null or negative.

Returns:

this VaultCertificateRequest.VaultCertificateRequestBuilder.

Since:

2.0

excludeCommonNameFromSubjectAltNames

public VaultCertificateRequest.VaultCertificateRequestBuilder excludeCommonNameFromSubjectAltNames()

Exclude the given common name from DNS or Email Subject Alternate Names (as appropriate). Useful if the CN is not a hostname or email address, but is instead some human-readable identifier.

Returns:

this VaultCertificateRequest.VaultCertificateRequestBuilder.

build

public VaultCertificateRequest build()

Build a new VaultCertificateRequest instance. Requires commonName(String) to be configured.

Returns:

a new VaultCertificateRequest.