クラス VaultTemplate

方法の詳細

• doCreateRestTemplate

  @DeprecatedSE(since="4.1") protected RestTemplate doCreateRestTemplate(VaultEndpointProvider endpointProvider, ClientHttpRequestFactory requestFactory)

  使用すべきではありません。

  4.1 以降は、適切なコンストラクターを備えた VaultClient を使用してください。セッション認証はリクエストインターセプターではなく、VaultClient を介して実行されます。

  VaultEndpointProvider および ClientHttpRequestFactory を指定して、VaultTemplate が Vault 通信に使用する RestTemplate を作成します。VaultEndpointProvider は、テンプレート API で通常使用される相対 URL のホストとポートの詳細を提供するために使用されます。サブクラスはこのメソッドをオーバーライドして、RestTemplate をカスタマイズできます。

  パラメーター:

  endpointProvider - null であってはなりません。

  requestFactory - null であってはなりません。

  戻り値:

  Vault 通信に使用される RestTemplate。

  導入:

  2.1

• doCreateRestClient

  @DeprecatedSE(since="4.1") protected RestClient doCreateRestClient(VaultEndpointProvider endpointProvider, ClientHttpRequestFactory requestFactory)

  使用すべきではありません。

  4.1 以降は、適切なコンストラクターを備えた VaultClient を使用してください。セッション認証はリクエストインターセプターではなく、VaultClient を介して実行されます。

  VaultEndpointProvider と ClientHttpRequestFactory に基づいて、VaultTemplate が Vault 通信に使用する RestClient を作成します。VaultEndpointProvider は、クライアント API で一般的に使用される相対 URL のホストとポートの詳細を提供するために使用されます。サブクラスでこのメソッドをオーバーライドして、RestClient をカスタマイズできます。

  パラメーター:

  endpointProvider - null であってはなりません。

  requestFactory - null であってはなりません。

  戻り値:

  Vault 通信に使用される RestClient。

  導入:

  4.0

• doCreateSessionTemplate

  @DeprecatedSE(since="4.1") protected RestTemplate doCreateSessionTemplate(VaultEndpointProvider endpointProvider, ClientHttpRequestFactory requestFactory)

  使用すべきではありません。

  4.1 以降は、適切なコンストラクターを備えた VaultClient を使用してください。セッション認証はリクエストインターセプターではなく、VaultClient を介して実行されます。

  認証されたコンテキストを必要とする呼び出しの 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)

  使用すべきではありません。

  4.1 以降は、適切なコンストラクターを備えた VaultClient を使用してください。セッション認証はリクエストインターセプターではなく、VaultClient を介して実行されます。

  認証されたコンテキストを必要とする呼び出しの 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()

  次で指定:

  インターフェース InitializingBean 内の afterPropertiesSet 

• destroy

  public void destroy() throws ExceptionSE

  次で指定:

  インターフェース DisposableBean 内の destroy 

  例外:

  ExceptionSE

• opsForKeyValue

  public VaultKeyValueOperations opsForKeyValue(StringSE path)

  インターフェースからコピーされた説明: VaultOperations

  VaultKeyValueOperations を返し、Vault を照会して version を決定します。この方法で使用するパスは、指定されたマウント path からの相対パスである必要があります。

  次で指定:

  インターフェース VaultOperations 内の opsForKeyValue 

  パラメーター:

  path - マウントパス。空または null にすることはできません。

  戻り値:

  Vault キー / 値シークレットエンジンと対話するための操作インターフェース。

• opsForKeyValue

  public VaultKeyValueOperations opsForKeyValue(StringSE path, VaultKeyValueOperationsSupport.KeyValueBackend apiVersion)

  インターフェースからコピーされた説明: VaultOperations

  VaultKeyValueOperations を返します。このメソッドで使用されるパスは、指定されたマウント path からの相対パスである必要があります。

  次で指定:

  インターフェース VaultOperations 内の opsForKeyValue 

  パラメーター:

  path - マウントパス。空または null にすることはできません。

  apiVersion - 使用する API バージョン。null であってはなりません。

  戻り値:

  Vault キー / 値シークレットエンジンと対話するための操作インターフェース。

• opsForVersionedKeyValue

  public VaultVersionedKeyValueOperations opsForVersionedKeyValue(StringSE path)

  インターフェースからコピーされた説明: VaultOperations

  VaultVersionedKeyValueOperations を返します。

  次で指定:

  インターフェース VaultOperations 内の opsForVersionedKeyValue 

  パラメーター:

  path - マウントパス

  戻り値:

  バージョン管理された Vault キー / 値 (バージョン 2) シークレットエンジンと対話するための操作インターフェース。

• opsForPki

  public VaultPkiOperations opsForPki()

  次で指定:

  インターフェース VaultOperations 内の opsForPki 

  戻り値:

  Vault PKI シークレットエンジンと対話するための操作インターフェース。

• opsForPki

  public VaultPkiOperations opsForPki(StringSE path)

  インターフェースからコピーされた説明: VaultOperations

  PKI シークレットエンジンが pki とは異なるパスにマウントされている場合は、VaultPkiOperations を返します。

  次で指定:

  インターフェース VaultOperations 内の opsForPki 

  パラメーター:

  path - マウントパス

  戻り値:

  Vault PKI シークレットエンジンと対話するための操作インターフェース。

• opsForSys

  public VaultSysOperations opsForSys()

  次で指定:

  インターフェース VaultOperations 内の opsForSys 

  戻り値:

  操作インターフェースの管理 Vault アクセス。

• opsForToken

  public VaultTokenOperations opsForToken()

  次で指定:

  インターフェース VaultOperations 内の opsForToken 

  戻り値:

  Vault トークンとやり取りするための操作インターフェース。

• opsForTransform

  public VaultTransformOperations opsForTransform()

  次で指定:

  インターフェース VaultOperations 内の opsForTransform 

  戻り値:

  Vault 変換シークレットエンジンと対話するための操作インターフェース。

• opsForTransform

  public VaultTransformOperations opsForTransform(StringSE path)

  インターフェースからコピーされた説明: VaultOperations

  トランジットシークレットエンジンが transform とは異なるパスにマウントされている場合は、VaultTransformOperations を返します。

  次で指定:

  インターフェース VaultOperations 内の opsForTransform 

  パラメーター:

  path - マウントパス

  戻り値:

  Vault 変換シークレットエンジンと対話するための操作インターフェース。

• opsForTransit

  public VaultTransitOperations opsForTransit()

  次で指定:

  インターフェース VaultOperations 内の opsForTransit 

  戻り値:

  Vault トランジットシークレットエンジンと対話するための操作インターフェース。

• opsForTransit

  public VaultTransitOperations opsForTransit(StringSE path)

  インターフェースからコピーされた説明: VaultOperations

  トランジットシークレットエンジンが transit とは異なるパスにマウントされている場合は、VaultTransitOperations を返します。

  次で指定:

  インターフェース VaultOperations 内の opsForTransit 

  パラメーター:

  path - マウントパス

  戻り値:

  Vault トランジットシークレットエンジンと対話するための操作インターフェース。

• opsForWrapping

  public VaultWrappingOperations opsForWrapping()

  次で指定:

  インターフェース VaultOperations 内の opsForWrapping 

  戻り値:

  Vault システム / 折り返し エンドポイントと対話するための操作インターフェース。

• read

  public @Nullable VaultResponse read(StringSE path)

  インターフェースからコピーされた説明: VaultOperations

  Vault パスから GET) を読み取ります。このメソッドを使用したデータの読み取りは、リクエスト本体を必要としない API 呼び出し / シークレットエンジンに適しています。

  次で指定:

  インターフェース VaultOperations 内の read 

  パラメーター:

  path - null であってはなりません。

  戻り値:

  データ。パスが存在しない場合は null になる可能性があります。

• read

  public <T> @Nullable VaultResponseSupport<T> read(StringSE path, ClassSE<T> responseType)

  インターフェースからコピーされた説明: VaultOperations

  シークレットエンジンから (GET) を読み取ります。このメソッドを使用したデータの読み取りは、リクエスト本体を必要としないシークレットエンジンに適しています。

  次で指定:

  インターフェース VaultOperations 内の read 

  パラメーター:

  path - null であってはなりません。

  responseType - null であってはなりません。

  戻り値:

  データ。パスが存在しない場合は null になる可能性があります。

• list

  public @Nullable ListSE<StringSE> list(StringSE path)

  インターフェースからコピーされた説明: VaultOperations

  Vault パスからキーを列挙します。

  次で指定:

  インターフェース VaultOperations 内の list 

  パラメーター:

  path - null であってはなりません。

  戻り値:

  データ。パスが存在しない場合は null になる可能性があります。

• write

  public @Nullable VaultResponse write(StringSE path, @Nullable ObjectSE body)

  インターフェースからコピーされた説明: VaultOperations

  (POST) を Vault パスに書き込みます。

  次で指定:

  インターフェース VaultOperations 内の write 

  パラメーター:

  path - null であってはなりません。

  body - ボディ、存在しない場合は null の可能性があります。

  戻り値:

  null の可能性があります。

• delete

  public void delete(StringSE path)

  インターフェースからコピーされた説明: VaultOperations

  パスを削除します。

  次で指定:

  インターフェース VaultOperations 内の delete 

  パラメーター:

  path - null であってはなりません。

• doWithVault

  public <T extends @Nullable ObjectSE> T doWithVault(RestOperationsCallback<T> clientCallback)

  インターフェースからコピーされた説明: VaultOperations

  Vault RestOperationsCallback を実行します。セッションを必要とせずに、RestOperations を使用して Vault とやり取りできます。

  次で指定:

  インターフェース VaultOperations 内の doWithVault 

  パラメーター:

  clientCallback - リクエスト。

  戻り値:

  RestOperationsCallback 戻り値。

• doWithSession

  public <T extends @Nullable ObjectSE> T doWithSession(RestOperationsCallback<T> sessionCallback)

  インターフェースからコピーされた説明: VaultOperations

  Vault RestOperationsCallback を実行します。認証済みセッションで Vault とやり取りできます。セッションマネージャーまたは ClientAuthentication を使用しない操作では、セッショントークンは添付されず、VaultOperations.doWithVault(RestOperationsCallback) と同様に動作します。

  次で指定:

  インターフェース VaultOperations 内の doWithSession 

  パラメーター:

  sessionCallback - リクエスト。

  戻り値:

  RestOperationsCallback 戻り値。