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

インターフェース VaultOperations

すべての既知の実装クラス:
VaultTemplate
public interface VaultOperations
リアクティブランタイムで Vault 操作を実行するための中心的なエントリポイント。

VaultTemplate によって実装されたこのインターフェースは、Key/Value、Transit、sys などの Vault バックエンドとやり取りするためのリアクティブ API を公開します。authenticated doWithSession と unauthenticated doWithVault の両方のアクセスに対してコールバック形式の実行をサポートします。

このテンプレート API インターフェースおよびその他のテンプレート API インターフェースにおける Paths used は、通常、基盤となる VaultClient の VaultEndpoint を基準とします。クライアントがエンドポイントなしで構成されている場合は、完全修飾 URI を使用できます。

相対 URI と絶対 URI のどちらを使用しているかにかかわらず、操作には認証ヘッダーやその他のヘッダーが適用されることに注意してください。認証ヘッダーを使用した外部エンドポイントへの不要なアクセスを防ぐため、アプリケーションはパスをサニタイズして外部エンドポイントへの不要なアクセスを回避する必要があります。

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

  • 方法の詳細

    • opsForKeyValue

      VaultKeyValueOperations opsForKeyValue(StringSE path)
      VaultKeyValueOperations を返し、Vault を照会して version を決定します。この方法で使用するパスは、指定されたマウント path からの相対パスである必要があります。
      パラメーター:
      path - マウントパス。空または null にすることはできません。
      戻り値:
      Vault キー / 値シークレットエンジンと対話するための操作インターフェース。
      導入:
      4.1

    • opsForKeyValue

      VaultKeyValueOperations opsForKeyValue(StringSE path, VaultKeyValueOperationsSupport.KeyValueBackend apiVersion)
      VaultKeyValueOperations を返します。このメソッドで使用されるパスは、指定されたマウント path からの相対パスである必要があります。
      パラメーター:
      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> @Nullable VaultResponseSupport<T> read(StringSE path, ClassSE<T> responseType)
      シークレットエンジンから (GET) を読み取ります。このメソッドを使用したデータの読み取りは、リクエスト本体を必要としないシークレットエンジンに適しています。
      パラメーター:
      path - null であってはなりません。
      responseType - null であってはなりません。
      戻り値:
      データ。パスが存在しない場合は null になる可能性があります。

    • readRequired

      default <T> VaultResponseSupport<T> readRequired(StringSE path, ClassSE<T> responseType)
      シークレットエンジンから (GET) を読み取ります。このメソッドを使用したデータの読み取りは、リクエスト本体を必要としないシークレットエンジンに適しています。
      パラメーター:
      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 とやり取りできます。セッションマネージャーまたは ClientAuthentication を使用しない操作では、セッショントークンは添付されず、doWithVault(RestOperationsCallback) と同様に動作します。
      パラメーター:
      sessionCallback - リクエスト。
      戻り値:
      RestOperationsCallback 戻り値。
      例外:
      VaultException - HttpStatusCodeException が発生したとき。
      RestClientException - RestOperations からの例外。