クラス VaultTemplate

java.lang.ObjectSE
org.springframework.vault.core.VaultTemplate
実装されているすべてのインターフェース:
DisposableBeanInitializingBeanVaultOperations

public class VaultTemplate extends ObjectSE implements InitializingBean, VaultOperations, DisposableBean
このクラスは、Vault の主なやり取りをカプセル化します。VaultTemplate は初期化時に Vault にログインし、そのトークンをライフタイム全体にわたって使用します。これは、認証済みコンテキストおよび認証なしコンテキストで Vault とやり取りするためのメインのエントリポイントです。

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

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

作成者:
Mark Paluch
関連事項:
  • コンストラクターの詳細

  • メソッドの詳細

    • doCreateRestTemplate

      protected RestTemplate doCreateRestTemplate(VaultEndpointProvider endpointProvider, ClientHttpRequestFactory requestFactory)
      VaultEndpointProvider および ClientHttpRequestFactory を指定して、VaultTemplate が Vault 通信に使用する RestTemplate を作成します。VaultEndpointProvider は、テンプレート API で通常使用される相対 URL のホストとポートの詳細を提供するために使用されます。サブクラスはこのメソッドをオーバーライドして、RestTemplate をカスタマイズできます。
      パラメーター:
      endpointProvider - null であってはなりません。
      requestFactory - null であってはなりません。
      戻り値:
      Vault 通信に使用される RestTemplate
      導入:
      2.1
    • doCreateRestClient

      protected RestClient doCreateRestClient(VaultEndpointProvider endpointProvider, ClientHttpRequestFactory requestFactory)
      VaultEndpointProviderClientHttpRequestFactory に基づいて、VaultTemplate が Vault 通信に使用する RestClient を作成します。VaultEndpointProvider は、クライアント API で一般的に使用される相対 URL のホストとポートの詳細を提供するために使用されます。サブクラスでこのメソッドをオーバーライドして、RestClient をカスタマイズできます。
      パラメーター:
      endpointProvider - null であってはなりません。
      requestFactory - null であってはなりません。
      戻り値:
      Vault 通信に使用される RestClient
      導入:
      4.0
    • doCreateSessionTemplate

      protected RestTemplate doCreateSessionTemplate(VaultEndpointProvider endpointProvider, ClientHttpRequestFactory requestFactory)
      認証されたコンテキストを必要とする呼び出しの VaultEndpointProvider および ClientHttpRequestFactory を指定して、Vault 通信の VaultTemplate によって使用されるセッションバインド RestTemplate を作成します。VaultEndpointProvider は、テンプレート API で通常使用される相対 URL のホストとポートの詳細を提供するために使用されます。サブクラスはこのメソッドをオーバーライドして、RestTemplate をカスタマイズできます。
      パラメーター:
      endpointProvider - null であってはなりません。
      requestFactory - null であってはなりません。
      戻り値:
      Vault 通信に使用される RestTemplate
      導入:
      2.1
    • doCreateSessionClient

      protected RestClient doCreateSessionClient(VaultEndpointProvider endpointProvider, ClientHttpRequestFactory requestFactory)
      認証されたコンテキストを必要とする呼び出しの VaultEndpointProvider および ClientHttpRequestFactory を指定して、Vault 通信の VaultTemplate によって使用されるセッションバインド RestClient を作成します。VaultEndpointProvider は、テンプレート API で通常使用される相対 URL のホストとポートの詳細を提供するために使用されます。サブクラスはこのメソッドをオーバーライドして、RestClient をカスタマイズできます。
      パラメーター:
      endpointProvider - null であってはなりません。
      requestFactory - null であってはなりません。
      戻り値:
      Vault 通信に使用される RestClient
      導入:
      4.0
    • setSessionManager

      public void setSessionManager(SessionManager sessionManager)
      SessionManager を設定してください。
      パラメーター:
      sessionManager - null であってはなりません。
    • afterPropertiesSet

      public void afterPropertiesSet()
      次で指定:
      インターフェース InitializingBeanafterPropertiesSet 
    • destroy

      public void destroy() throws ExceptionSE
      次で指定:
      インターフェース DisposableBeandestroy 
      例外:
      ExceptionSE
    • opsForKeyValue

      インターフェースからコピーされた説明: VaultOperations
      VaultKeyValueOperations を返します。
      次で指定:
      インターフェース VaultOperationsopsForKeyValue 
      パラメーター:
      path - マウントパス。空または null にすることはできません。
      apiVersion - 使用する API バージョン。null であってはなりません。
      戻り値:
      Vault キー / 値シークレットエンジンと対話するための操作インターフェース。
    • opsForVersionedKeyValue

      public VaultVersionedKeyValueOperations opsForVersionedKeyValue(StringSE path)
      インターフェースからコピーされた説明: VaultOperations
      次で指定:
      インターフェース VaultOperationsopsForVersionedKeyValue 
      パラメーター:
      path - マウントパス
      戻り値:
      バージョン管理された Vault キー / 値 (バージョン 2) シークレットエンジンと対話するための操作インターフェース。
    • opsForPki

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

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

      public VaultSysOperations opsForSys()
      次で指定:
      インターフェース VaultOperationsopsForSys 
      戻り値:
      操作インターフェースの管理 Vault アクセス。
    • opsForToken

      public VaultTokenOperations opsForToken()
      次で指定:
      インターフェース VaultOperationsopsForToken 
      戻り値:
      Vault トークンとやり取りするための操作インターフェース。
    • opsForTransform

      public VaultTransformOperations opsForTransform()
      次で指定:
      インターフェース VaultOperationsopsForTransform 
      戻り値:
      Vault 変換シークレットエンジンと対話するための操作インターフェース。
    • opsForTransform

      public VaultTransformOperations opsForTransform(StringSE path)
      インターフェースからコピーされた説明: VaultOperations
      トランジットシークレットエンジンが transform とは異なるパスにマウントされている場合は、VaultTransformOperations を返します。
      次で指定:
      インターフェース VaultOperationsopsForTransform 
      パラメーター:
      path - マウントパス
      戻り値:
      Vault 変換シークレットエンジンと対話するための操作インターフェース。
    • opsForTransit

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

      public VaultTransitOperations opsForTransit(StringSE path)
      インターフェースからコピーされた説明: VaultOperations
      トランジットシークレットエンジンが transit とは異なるパスにマウントされている場合は、VaultTransitOperations を返します。
      次で指定:
      インターフェース VaultOperationsopsForTransit 
      パラメーター:
      path - マウントパス
      戻り値:
      Vault トランジットシークレットエンジンと対話するための操作インターフェース。
    • opsForWrapping

      public VaultWrappingOperations opsForWrapping()
      次で指定:
      インターフェース VaultOperationsopsForWrapping 
      戻り値:
      Vault システム / 折り返し エンドポイントと対話するための操作インターフェース。
    • read

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

      public <T> @Nullable VaultResponseSupport<T> read(StringSE path, ClassSE<T> responseType)
      インターフェースからコピーされた説明: VaultOperations
      Read (GET) from a secrets engine. Reading data using this method is suitable for secrets engines that do not require a request body.
      次で指定:
      インターフェース VaultOperationsread 
      パラメーター:
      path - null であってはなりません。
      responseType - null であってはなりません。
      戻り値:
      データ。パスが存在しない場合は null になる可能性があります。
    • list

      public @Nullable ListSE<StringSE> list(StringSE path)
      インターフェースからコピーされた説明: VaultOperations
      Vault パスからキーを列挙します。
      次で指定:
      インターフェース VaultOperationslist 
      パラメーター:
      path - null であってはなりません。
      戻り値:
      データ。パスが存在しない場合は null になる可能性があります。
    • write

      public @Nullable VaultResponse write(StringSE path, @Nullable ObjectSE body)
      インターフェースからコピーされた説明: VaultOperations
      (POST) を Vault パスに書き込みます。
      次で指定:
      インターフェース VaultOperationswrite 
      パラメーター:
      path - null であってはなりません。
      body - ボディ、存在しない場合は null の可能性があります。
      戻り値:
      null の可能性があります。
    • delete

      public void delete(StringSE path)
      インターフェースからコピーされた説明: VaultOperations
      パスを削除します。
      次で指定:
      インターフェース VaultOperationsdelete 
      パラメーター:
      path - null であってはなりません。
    • doWithVault

      public <T extends @Nullable ObjectSE> T doWithVault(RestOperationsCallback<T> clientCallback)
      インターフェースからコピーされた説明: VaultOperations
      Vault RestOperationsCallback を実行します。セッションを必要とせずに、RestOperations を使用して Vault とやり取りできます。
      次で指定:
      インターフェース VaultOperationsdoWithVault 
      パラメーター:
      clientCallback - リクエスト。
      戻り値:
      RestOperationsCallback 戻り値。
    • doWithSession

      public <T extends @Nullable ObjectSE> T doWithSession(RestOperationsCallback<T> sessionCallback)
      インターフェースからコピーされた説明: VaultOperations
      Vault RestOperationsCallback を実行します。認証されたセッションで Vault と対話できるようにします。
      次で指定:
      インターフェース VaultOperationsdoWithSession 
      パラメーター:
      sessionCallback - リクエスト。
      戻り値:
      RestOperationsCallback 戻り値。