Module io.helidon.integrations.vault.secrets.pki

Package io.helidon.integrations.vault.secrets.pki

Class IssueCertificate.Request

java.lang.Object

io.helidon.integrations.common.rest.ApiJsonBuilder<T>

io.helidon.integrations.common.rest.ApiJsonRequest<T>

io.helidon.integrations.vault.VaultRequest<T>

io.helidon.integrations.vault.secrets.pki.IssueCertificate.Request

All Implemented Interfaces:

ApiRequest<IssueCertificate.Request>

Enclosing class:

IssueCertificate

public static final class IssueCertificate.Request
extends VaultRequest<T>

Request object. Can be configured with additional headers, query parameters etc.

Method Summary

Modifier and Type	Method	Description
T	addAltName(String name)	Specifies requested Subject Alternative Name(s).
T	addIpSan(String subjectAlternativeName)	Specifies requested IP Subject Alternative Name(s).
T	addOtherSan(String oid, String value)	Specifies custom OID/UTF8-string SANs.
T	addUriSan(String subjectAlternativeName)	Specifies the requested URI Subject Alternative Name(s).
static IssueCertificate.Request	builder()	Fluent API builder for configuring a request.
T	commonName(String commonName)
T	excludeCnFromSans(boolean exclude)	If true, the given common_name will not be included in DNS or Email Subject Alternate Names (as appropriate).
T	format(PkiFormat format)
T	roleName(String roleName)
T	ttl(Duration duration)	Specifies requested Time To Live.

Methods inherited from class io.helidon.integrations.vault.VaultRequest

add, addCommaDelimitedArray, addToCommaDelimitedArray, durationToTtl, preBuild

Methods inherited from class io.helidon.integrations.common.rest.ApiJsonRequest

addHeader, addQueryParam, headers, queryParams, requestId, requestId, requestMediaType, requestMediaType, responseMediaType, responseMediaType

Methods inherited from class io.helidon.integrations.common.rest.ApiJsonBuilder

add, add, add, add, add, add, addBase64, addToArray, addToArray, addToArray, addToArray, addToArray, addToArray, addToObject, addToObject, addToObject, addToObject, addToObject, emptyArray, me, postBuild, toJson

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.integrations.common.rest.ApiRequest

toJson

Method Detail

builder

public static IssueCertificate.Request builder()

Fluent API builder for configuring a request. The request builder is passed as is, without a build method. The equivalent of a build method is ApiJsonBuilder.toJson(javax.json.JsonBuilderFactory) used by the RestApi.

Returns:

new request builder

addAltName

public T addAltName(String name)

Specifies requested Subject Alternative Name(s). These can be host names or email addresses; they will be parsed into their respective fields. If any requested names do not match role policy, the entire request will be denied.

Parameters:

name - alt name

Returns:

updated request

addIpSan

public T addIpSan(String subjectAlternativeName)

Specifies requested IP Subject Alternative Name(s). Only valid if the role allows IP SANs (which is the default).

Parameters:

subjectAlternativeName - IP subject alternative name

Returns:

updated request

addUriSan

public T addUriSan(String subjectAlternativeName)

Specifies the requested URI Subject Alternative Name(s).

Parameters:

subjectAlternativeName - URI subject alternative name

Returns:

updated request

addOtherSan

public T addOtherSan(String oid,
                     String value)

Specifies custom OID/UTF8-string SANs. These must match values specified on the role in allowed_other_sans (see role creation for allowed_other_sans globbing rules). The format is the same as OpenSSL: <oid>:<type>:<value> where the type is hardcoded to UTF8.

Parameters:

oid - OID of the subject alternative name

value - value of the subject alternative name

Returns:

updated request

ttl

public T ttl(Duration duration)

Specifies requested Time To Live. Cannot be greater than the role's max_ttl value. If not provided, the role's ttl value will be used. Note that the role values default to system values if not explicitly set.

Parameters:

duration - time to live

Returns:

updated request

excludeCnFromSans

public T excludeCnFromSans(boolean exclude)

If true, the given common_name will not be included in 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.

Parameters:

exclude - whether to exclude CN from subject alternative names

Returns:

updated request

commonName

public T commonName(String commonName)

format

public T format(PkiFormat format)

roleName

public T roleName(String roleName)