Package com.oracle.cloud.spring.vault

Interface VaultTemplate

All Known Implementing Classes:
VaultTemplateImpl
public interface VaultTemplate
The VaultTemplate interface defines the API for accessing OCI Vault Service. Users can retrieve, create, update, list, and delete secrets within an OCI Vault.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.oracle.bmc.vault.responses.CreateSecretResponse
    createSecret(String secretName, com.oracle.bmc.vault.model.CreateSecretDetails body)
    Create a secret.
    default String
    decodeBundle(com.oracle.bmc.secrets.responses.GetSecretBundleByNameResponse bundle)
    Decode a secret bundle response as a String.
    Map<String,String>
    getAllSecrets()
    Retrieve all secrets from the Vault.
    com.oracle.bmc.secrets.responses.GetSecretBundleByNameResponse
    getSecret(String secretName)
    Retrieves a secret by name.
    List<com.oracle.bmc.vault.model.SecretSummary>
    listSecrets()
    Lists all secrets in the Vault.
    com.oracle.bmc.vault.responses.ScheduleSecretDeletionResponse
    scheduleSecretDeletion(String secretName, int deleteAfterDays)
    Schedule the deletion of a secret.
    com.oracle.bmc.vault.responses.UpdateSecretResponse
    updateSecret(String secretName, com.oracle.bmc.vault.model.UpdateSecretDetails body)
    Update a secret content.

  • Method Details

    • getSecret

      com.oracle.bmc.secrets.responses.GetSecretBundleByNameResponse getSecret(String secretName)
      Retrieves a secret by name.
      Parameters:
      secretName - The name of the secret.
      Returns:
      The secret bundle response.

    • getAllSecrets

      Map<String,String> getAllSecrets()
      Retrieve all secrets from the Vault.
      Returns:
      A mapping of secret names to secret values.

    • listSecrets

      List<com.oracle.bmc.vault.model.SecretSummary> listSecrets()
      Lists all secrets in the Vault.
      Returns:
      A list of secret summaries.

    • createSecret

      com.oracle.bmc.vault.responses.CreateSecretResponse createSecret(String secretName, com.oracle.bmc.vault.model.CreateSecretDetails body)
      Create a secret.
      Parameters:
      secretName - The name of the secret being created.
      body - The secret body to create.
      Returns:
      A create secret response.

    • scheduleSecretDeletion

      com.oracle.bmc.vault.responses.ScheduleSecretDeletionResponse scheduleSecretDeletion(String secretName, int deleteAfterDays)
      Schedule the deletion of a secret.
      Parameters:
      secretName - The name of the secret to schedule deletion for.
      deleteAfterDays - The number of days after which the secret will be deleted. May be between 1 and 30.
      Returns:
      A delete secret respones.

    • updateSecret

      com.oracle.bmc.vault.responses.UpdateSecretResponse updateSecret(String secretName, com.oracle.bmc.vault.model.UpdateSecretDetails body)
      Update a secret content.
      Parameters:
      secretName - The name of the secret to update.
      body - The secret body to update.
      Returns:
      An update secret response.

    • decodeBundle

      default String decodeBundle(com.oracle.bmc.secrets.responses.GetSecretBundleByNameResponse bundle)
      Decode a secret bundle response as a String.
      Parameters:
      bundle - The bundle to decode.
      Returns:
      The secret String content.