Module io.helidon.integrations.vault.secrets.kv

Package io.helidon.integrations.vault.secrets.kv2

Interface Kv2SecretsRx

All Superinterfaces:

SecretsRx

public interface Kv2SecretsRx
extends SecretsRx

Reactive API for secrets for KV version 2 secrets engine.

See Also:

ENGINE, Vault.secrets(io.helidon.integrations.vault.Engine)

Field Summary

Fields

Modifier and Type	Field	Description
static Engine<Kv2SecretsRx>	ENGINE	KV (Key/Value) secrets engine version 2.

Method Summary

Modifier and Type	Method	Description
Single<CreateKv2.Response>	create(CreateKv2.Request request)	Create a new secret.
default Single<CreateKv2.Response>	create(String path, Map<String,String> newSecretValues)	Create a new secret on the defined path.
Single<DeleteKv2.Response>	delete(DeleteKv2.Request request)	Delete a secret version.
default Single<DeleteKv2.Response>	delete(String path, int... versions)	Delete specific versions of a secret.
Single<DeleteAllKv2.Response>	deleteAll(DeleteAllKv2.Request request)	Delete the secret and all its versions permanently.
default Single<DeleteAllKv2.Response>	deleteAll(String path)	Delete the secret and all its versions permanently.
Single<DestroyKv2.Response>	destroy(DestroyKv2.Request request)	Permanently remove specific version(s) of a secret.
default Single<DestroyKv2.Response>	destroy(String path, int... versions)	Permanently remove specific versions of a secret.
Single<VaultOptionalResponse<GetKv2.Response>>	get(GetKv2.Request request)	Get a version of a secret.
default Single<Optional<Kv2Secret>>	get(String path)	Get the latest version of a secret.
default Single<Optional<Kv2Secret>>	get(String path, int version)	Get a version of a secret.
Single<UndeleteKv2.Response>	undelete(UndeleteKv2.Request request)	Undelete a secret version.
default Single<UndeleteKv2.Response>	undelete(String path, int... versions)	Undelete deleted versions of a secret.
Single<UpdateKv2.Response>	update(UpdateKv2.Request request)	Update a secret on the defined path.
default Single<Integer>	update(String path, Map<String,String> newValues)	Update a secret on the defined path.
default Single<Integer>	update(String path, Map<String,String> newValues, int expectedVersion)	Update a secret on the defined path.

Methods inherited from interface io.helidon.integrations.vault.SecretsRx

list, list, list

Field Detail

ENGINE

static final Engine<Kv2SecretsRx> ENGINE

KV (Key/Value) secrets engine version 2.

Documentation: https://www.vaultproject.io/docs/secrets/kv/kv-v2

Method Detail

get

default Single<Optional<Kv2Secret>> get(String path)

Get the latest version of a secret.

Parameters:

path - relative to the mount point, no leading slash

Returns:

the secret

get

default Single<Optional<Kv2Secret>> get(String path,
                                        int version)

Get a version of a secret.

Parameters:

path - relative to the mount point, no leading slash

version - version to retrieve

Returns:

the secret

get

Single<VaultOptionalResponse<GetKv2.Response>> get(GetKv2.Request request)

Get a version of a secret.

Parameters:

request - with secret's path and optional version

Returns:

vault response with the secret if found

update

default Single<Integer> update(String path,
                               Map<String,String> newValues)

Update a secret on the defined path. The new values replace existing values.

Parameters:

path - relative to the mount point, no leading slash

newValues - new values of the secret

Returns:

the version created

update

default Single<Integer> update(String path,
                               Map<String,String> newValues,
                               int expectedVersion)

Update a secret on the defined path. The new values replace existing values.

Parameters:

path - relative to the mount point, no leading slash

newValues - new values of the secret

expectedVersion - expected latest version

Returns:

the version created

update

Single<UpdateKv2.Response> update(UpdateKv2.Request request)

Update a secret on the defined path. The new values replace existing values.

Parameters:

request - update request with path, new values and expected version

Returns:

vault response with the version created

create

default Single<CreateKv2.Response> create(String path,
                                          Map<String,String> newSecretValues)

Create a new secret on the defined path.

Parameters:

path - relative to the mount point, no leading slash

newSecretValues - values to use in the new secret

Returns:

vault response

create

Single<CreateKv2.Response> create(CreateKv2.Request request)

Create a new secret.

Parameters:

request - request with path and values

Returns:

create secret response

delete

default Single<DeleteKv2.Response> delete(String path,
                                          int... versions)

Delete specific versions of a secret.

Parameters:

path - relative to the mount point, no leading slash

versions - versions to delete

Returns:

vault response

delete

Single<DeleteKv2.Response> delete(DeleteKv2.Request request)

Delete a secret version.

Parameters:

request - request with path and version(s)

Returns:

delete secret response

undelete

default Single<UndeleteKv2.Response> undelete(String path,
                                              int... versions)

Undelete deleted versions of a secret. This method can be called repeatedly and even on non-existent versions without throwing an exception.

Parameters:

path - relative to the mount point, no leading slash

versions - versions to undelete

Returns:

vault response

undelete

Single<UndeleteKv2.Response> undelete(UndeleteKv2.Request request)

Undelete a secret version.

Parameters:

request - request with and and version(s)

Returns:

undelete secret response

destroy

default Single<DestroyKv2.Response> destroy(String path,
                                            int... versions)

Permanently remove specific versions of a secret. This method can be called repeatedly and even on non-existent versions without throwing an exception.

Parameters:

path - relative to the mount point, no leading slash

versions - versions to destroy

Returns:

vault response

destroy

Single<DestroyKv2.Response> destroy(DestroyKv2.Request request)

Permanently remove specific version(s) of a secret. This method can be called repeatedly and even on non-existent versions without throwing an exception.

Parameters:

request - request with path and version(s)

Returns:

destroy secret response

deleteAll

default Single<DeleteAllKv2.Response> deleteAll(String path)

Delete the secret and all its versions permanently. This method can be called repeatedly and even on non-existent versions without throwing an exception.

Parameters:

path - relative to the mount point, no leading slash

Returns:

vault response

deleteAll

Single<DeleteAllKv2.Response> deleteAll(DeleteAllKv2.Request request)

Delete the secret and all its versions permanently. This method can be called repeatedly and even on non-existent versions without throwing an exception.

Parameters:

request - with relative path to the mount point, no leading slash

Returns:

vault response