Module io.helidon.integrations.vault.secrets.database

Package io.helidon.integrations.vault.secrets.database

Interface DbSecretsRx

All Superinterfaces:

SecretsRx

public interface DbSecretsRx
extends SecretsRx

Database secrets engine API.

Documentation: https://www.vaultproject.io/docs/secrets/databases

Field Summary

Fields

Modifier and Type	Field	Description
static Engine<DbSecretsRx>	ENGINE	Database secrets engine.

Method Summary

Modifier and Type	Method	Description
Single<DbConfigure.Response>	configure(DbConfigure.Request<?> dbRequest)	Configure a database.
Single<DbCreateRole.Response>	createRole(DbCreateRole.Request request)	Create or update a role definition.
Single<DbDelete.Response>	delete(DbDelete.Request request)	Delete a database configuration.
default Single<DbDelete.Response>	delete(String name)	Delete a database configuration.
Single<DbDeleteRole.Response>	deleteRole(DbDeleteRole.Request request)	Delete a database role.
default Single<DbDeleteRole.Response>	deleteRole(String name)	Delete a database role.
Single<VaultOptionalResponse<DbGet.Response>>	get(DbGet.Request request)	Get credentials from the /creds endpoint.
default Single<Optional<DbCredentials>>	get(String name)	Get credentials from the /creds endpoint.
Single<VaultOptionalResponse<ListSecrets.Response>>	list(ListSecrets.Request request)	List database connections.

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

list, list

Field Detail

ENGINE

static final Engine<DbSecretsRx> ENGINE

Database secrets engine.

Documentation: https://www.vaultproject.io/docs/secrets/databases

Method Detail

list

Single<VaultOptionalResponse<ListSecrets.Response>> list(ListSecrets.Request request)

List database connections.

Specified by:

list in interface SecretsRx

Parameters:

request - request to list roles, path parameter is ignored

Returns:

role names

get

default Single<Optional<DbCredentials>> get(String name)

Get credentials from the /creds endpoint.

Parameters:

name - name of the credentials

Returns:

credentials

get

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

Get credentials from the /creds endpoint.

Parameters:

request - request with at least the name

Returns:

get DB response

createRole

Single<DbCreateRole.Response> createRole(DbCreateRole.Request request)

Create or update a role definition.

Parameters:

request - role request

Returns:

when the role is created

configure

Single<DbConfigure.Response> configure(DbConfigure.Request<?> dbRequest)

Configure a database.

Parameters:

dbRequest - configuration options - see specific database types

Returns:

when the database is configured

delete

default Single<DbDelete.Response> delete(String name)

Delete a database configuration.

Parameters:

name - name of the database configuration

Returns:

when the database configuration is deleted

delete

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

Delete a database configuration.

Parameters:

request - delete request with at least name configured

Returns:

delete database configuration response

deleteRole

default Single<DbDeleteRole.Response> deleteRole(String name)

Delete a database role.

Parameters:

name - name of the role

Returns:

when the role is deleted

deleteRole

Single<DbDeleteRole.Response> deleteRole(DbDeleteRole.Request request)

Delete a database role.

Parameters:

request - request with at least the role name configured

Returns:

delete database role response