パッケージ org.springframework.vault.core

インターフェース VaultOperations

すべての既知の実装クラス:
VaultTemplate
public interface VaultOperations
VaultTemplate によって実装される、Vault 操作の基本セットを指定するインターフェース。これは、認証済みおよび未認証のコンテキストで Vault と対話するためのメインエントリポイントです。

VaultOperations では、コールバックメソッドを実行できます。コールバックは、session context および without a session 内でリクエストを実行できます。

このインターフェース（およびここからアクセス可能なインターフェース）で使用されるパスは、VaultEndpoint を基準とした相対パスとみなされます。完全修飾 URI のパスは、認証されたコンテキストで Vault クラスタメンバーにアクセスするために使用できます。不要な完全 URI アクセスを防ぐため、このインターフェースにパスを渡す前に必ずサニタイズしてください。

作成者:
Mark Paluch, Lauren Voswinkel
関連事項:

  • メソッドの詳細

    • opsForKeyValue

      VaultKeyValueOperations opsForKeyValue(StringSE path, VaultKeyValueOperationsSupport.KeyValueBackend apiVersion)
      VaultKeyValueOperations を返します。
      パラメーター:
      path - マウントパス。空または null にすることはできません。
      apiVersion - 使用する API バージョン。null であってはなりません。
      戻り値:
      Vault キー / 値シークレットエンジンと対話するための操作インターフェース。
      導入:
      2.1

    • opsForVersionedKeyValue

      VaultVersionedKeyValueOperations opsForVersionedKeyValue(StringSE path)
      VaultVersionedKeyValueOperations を返します。
      パラメーター:
      path - マウントパス
      戻り値:
      バージョン管理された Vault キー / 値 (バージョン 2) シークレットエンジンと対話するための操作インターフェース。
      導入:
      2.1

    • opsForPki

      VaultPkiOperations opsForPki()
      戻り値:
      Vault PKI シークレットエンジンと対話するための操作インターフェース。

    • opsForPki

      VaultPkiOperations opsForPki(StringSE path)
      PKI シークレットエンジンが pki とは異なるパスにマウントされている場合は、VaultPkiOperations を返します。
      パラメーター:
      path - マウントパス
      戻り値:
      Vault PKI シークレットエンジンと対話するための操作インターフェース。

    • opsForSys

      VaultSysOperations opsForSys()
      戻り値:
      操作インターフェースの管理 Vault アクセス。

    • opsForToken

      VaultTokenOperations opsForToken()
      戻り値:
      Vault トークンとやり取りするための操作インターフェース。

    • opsForTransform

      VaultTransformOperations opsForTransform()
      戻り値:
      Vault 変換シークレットエンジンと対話するための操作インターフェース。
      導入:
      2.3

    • opsForTransform

      VaultTransformOperations opsForTransform(StringSE path)
      トランジットシークレットエンジンが transform とは異なるパスにマウントされている場合は、VaultTransformOperations を返します。
      パラメーター:
      path - マウントパス
      戻り値:
      Vault 変換シークレットエンジンと対話するための操作インターフェース。
      導入:
      2.3

    • opsForTransit

      VaultTransitOperations opsForTransit()
      戻り値:
      Vault トランジットシークレットエンジンと対話するための操作インターフェース。

    • opsForTransit

      VaultTransitOperations opsForTransit(StringSE path)
      トランジットシークレットエンジンが transit とは異なるパスにマウントされている場合は、VaultTransitOperations を返します。
      パラメーター:
      path - マウントパス
      戻り値:
      Vault トランジットシークレットエンジンと対話するための操作インターフェース。

    • opsForWrapping

      VaultWrappingOperations opsForWrapping()
      戻り値:
      Vault システム / 折り返し エンドポイントと対話するための操作インターフェース。
      導入:
      2.1

    • read

      @Nullable VaultResponse read(StringSE path)
      Vault パスから GET) を読み取ります。このメソッドを使用したデータの読み取りは、リクエスト本体を必要としない API 呼び出し / シークレットエンジンに適しています。
      パラメーター:
      path - null であってはなりません。
      戻り値:
      データ。パスが存在しない場合は null になる可能性があります。

    • readRequired

      default VaultResponse readRequired(StringSE path) throws SecretNotFoundException
      Vault パスから GET) を読み取ります。このメソッドを使用したデータの読み取りは、リクエスト本体を必要としない API 呼び出し / シークレットエンジンに適しています。
      パラメーター:
      path - null であってはなりません。
      戻り値:
      データ。
      例外:
      SecretNotFoundException - パスが存在しない場合。
      導入:
      4.0

    • read

      <T extends @Nullable ObjectSE> VaultResponseSupport<T> read(StringSE path, ClassSE<T> responseType)
      Read (GET) from a secrets engine. Reading data using this method is suitable for secrets engines that do not require a request body.
      パラメーター:
      path - null であってはなりません。
      responseType - null であってはなりません。
      戻り値:
      データ。パスが存在しない場合は null になる可能性があります。

    • readRequired

      default <T> VaultResponseSupport<T> readRequired(StringSE path, ClassSE<T> responseType)
      Read (GET) from a secrets engine. Reading data using this method is suitable for secrets engines that do not require a request body.
      パラメーター:
      path - null であってはなりません。
      responseType - null であってはなりません。
      戻り値:
      データ。
      例外:
      SecretNotFoundException - パスが存在しない場合。
      導入:
      4.0

    • list

      @Nullable ListSE<StringSE> list(StringSE path)
      Vault パスからキーを列挙します。
      パラメーター:
      path - null であってはなりません。
      戻り値:
      データ。パスが存在しない場合は null になる可能性があります。

    • write

      default @Nullable VaultResponse write(StringSE path)
      (POST) を Vault パスに書き込みます。
      パラメーター:
      path - null であってはなりません。
      戻り値:
      null の可能性があります。
      導入:
      2.0

    • write

      @Nullable VaultResponse write(StringSE path, @Nullable ObjectSE body)
      (POST) を Vault パスに書き込みます。
      パラメーター:
      path - null であってはなりません。
      body - ボディ、存在しない場合は null の可能性があります。
      戻り値:
      null の可能性があります。

    • invoke

      default VaultResponse invoke(StringSE path, @Nullable ObjectSE body)
      Vault パスで操作を呼び出します。通常は、レスポンスを期待するオプションのリクエストボディを伴う POST リクエストです。
      パラメーター:
      path - null であってはなりません。
      body - ボディ、存在しない場合は null の可能性があります。
      戻り値:
      レスポンス。
      例外:
      IllegalStateExceptionSE - レスポンスを返さずに操作が戻った場合。
      導入:
      4.0

    • delete

      void delete(StringSE path)
      パスを削除します。
      パラメーター:
      path - null であってはなりません。

    • doWithVault

      <T extends @Nullable ObjectSE> T doWithVault(RestOperationsCallback<T> clientCallback) throws VaultException, RestClientException
      Vault RestOperationsCallback を実行します。セッションを必要とせずに、RestOperations を使用して Vault とやり取りできます。
      パラメーター:
      clientCallback - リクエスト。
      戻り値:
      RestOperationsCallback 戻り値。
      例外:
      VaultException - HttpStatusCodeException が発生したとき。
      RestClientException - RestOperations からの例外。

    • doWithSession

      <T extends @Nullable ObjectSE> T doWithSession(RestOperationsCallback<T> sessionCallback) throws VaultException, RestClientException
      Vault RestOperationsCallback を実行します。認証されたセッションで Vault と対話できるようにします。
      パラメーター:
      sessionCallback - リクエスト。
      戻り値:
      RestOperationsCallback 戻り値。
      例外:
      VaultException - HttpStatusCodeException が発生したとき。
      RestClientException - RestOperations からの例外。