Module io.helidon.integrations.oci.vault

Package io.helidon.integrations.oci.vault

Interface OciVaultRx

public interface OciVaultRx

Reactive APIs for OCI Vault.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	OciVaultRx.Builder	Fluent API builder for OciVaultRx.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENDPOINT_FORMAT	Default endpoint format for KMS.
static final String	KMS_HOST_PREFIX	Host name prefix for key management service (KMS).
static final String	OCI_ENDPOINT_FORMAT	Default endpoint format for secrets.
static final String	RETRIEVAL_HOST_PREFIX	Host name prefix for secrets retrieval.
static final String	SECRET_API_VERSION	Version of Secret API supported by this client.
static final String	SECRET_BUNDLE_API_VERSION	Version of Secret Bundle API supported by this client.
static final String	VAULTS_HOST_PREFIX	Host name prefix.

Method Summary

Modifier and Type	Method	Description
static OciVaultRx.Builder	builder()	Create a new fluent API builder for OCI metrics.
static OciVaultRx	create()	Create OCI metrics using the default OciRestApi.
static OciVaultRx	create(Config config)	Create OCI metrics based on configuration.
Single<CreateSecret.Response>	createSecret(CreateSecret.Request request)	Create a new secret.
Single<Decrypt.Response>	decrypt(Decrypt.Request request)	Decrypt data.
Single<DeleteSecret.Response>	deleteSecret(DeleteSecret.Request request)	Schedules a secret deletion.
Single<Encrypt.Response>	encrypt(Encrypt.Request request)	Encrypt data.
Single<ApiOptionalResponse<GetKey.Response>>	getKey(GetKey.Request request)	Get key metadata.
Single<ApiOptionalResponse<Secret>>	getSecret(GetSecret.Request request)	Gets information about the specified secret.
Single<ApiOptionalResponse<GetSecretBundle.Response>>	getSecretBundle(GetSecretBundle.Request request)	Gets information about the specified secret.
Single<ApiOptionalResponse<GetVault.Response>>	getVault(GetVault.Request request)	Get Vault metadata.
Single<Sign.Response>	sign(Sign.Request request)	Sign a message.
Single<Verify.Response>	verify(Verify.Request request)	Verify a message signature.

Field Details

ENDPOINT_FORMAT

static final String ENDPOINT_FORMAT

Default endpoint format for KMS.

See Also:

• Constant Field Values

OCI_ENDPOINT_FORMAT

static final String OCI_ENDPOINT_FORMAT

Default endpoint format for secrets.

See Also:

• Constant Field Values

SECRET_API_VERSION

static final String SECRET_API_VERSION

Version of Secret API supported by this client.

See Also:

• Constant Field Values

SECRET_BUNDLE_API_VERSION

static final String SECRET_BUNDLE_API_VERSION

Version of Secret Bundle API supported by this client.

See Also:

• Constant Field Values

VAULTS_HOST_PREFIX

static final String VAULTS_HOST_PREFIX

Host name prefix.

See Also:

• Constant Field Values

KMS_HOST_PREFIX

static final String KMS_HOST_PREFIX

Host name prefix for key management service (KMS).

See Also:

• Constant Field Values

RETRIEVAL_HOST_PREFIX

static final String RETRIEVAL_HOST_PREFIX

Host name prefix for secrets retrieval. This is added before the VAULTS_HOST_PREFIX.

See Also:

• Constant Field Values

Method Details

builder

static OciVaultRx.Builder builder()

Create a new fluent API builder for OCI metrics.

Returns:

a new builder

create

static OciVaultRx create()

Create OCI metrics using the default OciRestApi.

Returns:

OCI metrics instance connecting based on DEFAULT profile

create

static OciVaultRx create(Config config)

Create OCI metrics based on configuration.

Parameters:

config - configuration on the node of OCI configuration

Returns:

OCI metrics instance configured from the configuration

See Also:

• OciVaultRx.Builder.config(io.helidon.config.Config)

getSecret

Single<ApiOptionalResponse<Secret>> getSecret(GetSecret.Request request)

Gets information about the specified secret.

Parameters:

request - get secret request

Returns:

future with secret response or exception

createSecret

Single<CreateSecret.Response> createSecret(CreateSecret.Request request)

Create a new secret.

Parameters:

request - create secret request

Returns:

future with create secret response or exception

getSecretBundle

Single<ApiOptionalResponse<GetSecretBundle.Response>> getSecretBundle(GetSecretBundle.Request request)

Gets information about the specified secret.

Parameters:

request - get secret bundle request

Returns:

future with response or error

deleteSecret

Single<DeleteSecret.Response> deleteSecret(DeleteSecret.Request request)

Schedules a secret deletion.

Parameters:

request - delete secret request

Returns:

future with response or error

encrypt

Single<Encrypt.Response> encrypt(Encrypt.Request request)

Encrypt data.

Parameters:

request - encryption request

Returns:

future with encrypted data

decrypt

Single<Decrypt.Response> decrypt(Decrypt.Request request)

Decrypt data.

Parameters:

request - decryption request

Returns:

future with decrypted data

sign

Single<Sign.Response> sign(Sign.Request request)

Sign a message.

Parameters:

request - signature request

Returns:

signature response

verify

Single<Verify.Response> verify(Verify.Request request)

Verify a message signature.

Parameters:

request - verification request

Returns:

verification response

getKey

Single<ApiOptionalResponse<GetKey.Response>> getKey(GetKey.Request request)

Get key metadata.

Parameters:

request - get key request

Returns:

get key response

getVault

Single<ApiOptionalResponse<GetVault.Response>> getVault(GetVault.Request request)

Get Vault metadata.

Parameters:

request - get vault request

Returns:

get vault response