クラス ReactiveVaultTemplate
java.lang.ObjectSE
org.springframework.vault.core.ReactiveVaultTemplate
- 実装されているすべてのインターフェース:
ReactiveVaultOperations
このクラスは、Vault の主なやり取りをカプセル化します。
ReactiveVaultTemplate は初期化時に Vault にログインし、そのトークンをライフタイム全体にわたって使用します。これは、認証済みコンテキストおよび認証なしコンテキストで Vault とやり取りするための主要なエントリポイントです。ReactiveVaultTemplate では、コールバックメソッドを実行できます。コールバックは、session context および without a session 内でリクエストを実行できます。
このインターフェース(およびここからアクセス可能なインターフェース)で使用されるパスは、VaultEndpoint を基準とした相対パスとみなされます。完全修飾 URI のパスは、認証されたコンテキストで Vault クラスタメンバーにアクセスするために使用できます。不要な完全 URI アクセスを防ぐため、このインターフェースにパスを渡す前に必ずサニタイズしてください。
- 導入:
- 2.0
- 作成者:
- Mark Paluch, Raoof Mohammed, James Luke, Timothy R. Weiand
- 関連事項:
コンストラクターの概要
コンストラクターコンストラクター説明ReactiveVaultTemplate(VaultEndpointProvider endpointProvider, ClientHttpConnector connector) ReactiveVaultTemplate(VaultEndpointProvider endpointProvider, ClientHttpConnector connector, VaultTokenSupplier vaultTokenSupplier) ReactiveVaultTemplate(VaultEndpoint vaultEndpoint, ClientHttpConnector connector) ReactiveVaultTemplate(VaultEndpoint vaultEndpoint, ClientHttpConnector connector, VaultTokenSupplier vaultTokenSupplier) ReactiveVaultTemplate(WebClientBuilder webClientBuilder) WebClientBuilderを介して新しいReactiveVaultTemplateを作成します。ReactiveVaultTemplate(WebClientBuilder webClientBuilder, VaultTokenSupplier vaultTokenSupplier) 方法の概要
修飾子と型メソッド説明パスを削除します。protected WebClientdoCreateSessionWebClient(VaultEndpointProvider endpointProvider, ClientHttpConnector connector) 認証されたコンテキストを必要とする呼び出し用のVaultEndpointProviderおよびClientHttpConnectorを指定して、Vault 通信用にVaultTemplateによって使用されるセッションバインドWebClientを作成します。protected WebClientdoCreateWebClient(VaultEndpointProvider endpointProvider, ClientHttpConnector connector) VaultEndpointProviderおよびClientHttpConnectorを指定して、Vault 通信のためにReactiveVaultTemplateによって使用されるWebClientを作成します。<V,T extends org.reactivestreams.Publisher<V>>
TdoWithSession(FunctionSE<WebClient, ? extends T> sessionCallback) VaultRestOperationsCallbackを実行します。<V,T extends org.reactivestreams.Publisher<V>>
TdoWithVault(FunctionSE<WebClient, ? extends T> clientCallback) VaultRestOperationsCallbackを実行します。Vault パスからキーを列挙します。opsForKeyValue(StringSE path, VaultKeyValueOperationsSupport.KeyValueBackend apiVersion) VaultKeyValueOperationsを返します。opsForTransit(StringSE path) トランジットエンジンがtransitとは異なるパスにマウントされている場合は、ReactiveVaultTransitOperationsを返します。Vault パスから読み取ります。<T> Mono<VaultResponseSupport<T>>Vault パスから読み取ります。Vault パスに書き込みます。クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSEインターフェース org.springframework.vault.core.ReactiveVaultOperations から継承されたメソッド
write
コンストラクターの詳細
ReactiveVaultTemplate
VaultEndpoint、ClientHttpConnectorを使用して新しいReactiveVaultTemplateを作成します。このコンストラクターはVaultTokenSupplierを使用しません。これは、authentication token headerを使用せずに Vault エージェントの認証を継承するために Vault エージェントで使用することを目的としています。- パラメーター:
vaultEndpoint- null であってはなりません。connector- null であってはなりません。- 導入:
- 2.2.1
ReactiveVaultTemplate
public ReactiveVaultTemplate(VaultEndpoint vaultEndpoint, ClientHttpConnector connector, VaultTokenSupplier vaultTokenSupplier) - パラメーター:
vaultEndpoint- null であってはなりません。connector- null であってはなりません。vaultTokenSupplier- null であってはなりません。
ReactiveVaultTemplate
VaultEndpointProviderおよびClientHttpConnectorを使用して新しいReactiveVaultTemplateを作成します。このコンストラクターはVaultTokenSupplierを使用しません。これは、authentication token headerを使用せずに Vault エージェントの認証を継承するために Vault エージェントで使用することを目的としています。- パラメーター:
endpointProvider- null であってはなりません。connector- null であってはなりません。- 導入:
- 2.2.1
ReactiveVaultTemplate
public ReactiveVaultTemplate(VaultEndpointProvider endpointProvider, ClientHttpConnector connector, VaultTokenSupplier vaultTokenSupplier) - パラメーター:
endpointProvider- null であってはなりません。connector- null であってはなりません。vaultTokenSupplier- null であってはなりません。
ReactiveVaultTemplate
WebClientBuilderを通じて新しいReactiveVaultTemplateを作成します。このコンストラクターはVaultTokenSupplierを使用しません。これは、authentication token headerを使用せずに Vault エージェントの認証を継承するために Vault エージェントで使用することを目的としています。- パラメーター:
webClientBuilder- null であってはなりません。- 導入:
- 2.2.1
ReactiveVaultTemplate
public ReactiveVaultTemplate(WebClientBuilder webClientBuilder, VaultTokenSupplier vaultTokenSupplier) - パラメーター:
webClientBuilder- null であってはなりません。vaultTokenSupplier- null であってはなりません- 導入:
- 2.2
メソッドの詳細
doCreateWebClient
protected WebClient doCreateWebClient(VaultEndpointProvider endpointProvider, ClientHttpConnector connector) VaultEndpointProviderおよびClientHttpConnectorを指定して、ReactiveVaultTemplateが Vault 通信に使用するWebClientを作成します。VaultEndpointProviderは、テンプレート API で通常使用される相対 URL のホストとポートの詳細を提供するために使用されます。サブクラスはこのメソッドをオーバーライドして、WebClientをカスタマイズできます。- パラメーター:
endpointProvider- null であってはなりません。connector- null であってはなりません。- 戻り値:
- Vault 通信に使用される
WebClient。 - 導入:
- 2.1
doCreateSessionWebClient
protected WebClient doCreateSessionWebClient(VaultEndpointProvider endpointProvider, ClientHttpConnector connector) 認証されたコンテキストを必要とする呼び出しのVaultEndpointProviderおよびClientHttpConnectorを指定して、Vault 通信のVaultTemplateによって使用されるセッションバインドWebClientを作成します。VaultEndpointProviderは、テンプレート API で通常使用される相対 URL のホストとポートの詳細を提供するために使用されます。サブクラスはこのメソッドをオーバーライドして、WebClientをカスタマイズできます。- パラメーター:
endpointProvider- null であってはなりません。connector- null であってはなりません。- 戻り値:
- Vault 通信に使用される
WebClient。 - 導入:
- 2.1
opsForSys
- 次で指定:
- インターフェース
ReactiveVaultOperationsのopsForSys - 戻り値:
- 操作インターフェースの管理 Vault アクセス。
opsForTransit
- 次で指定:
- インターフェース
ReactiveVaultOperationsのopsForTransit - 戻り値:
- Vault トランジットエンジンと対話するための操作インターフェース。
opsForTransit
インターフェースからコピーされた説明:ReactiveVaultOperationsトランジットエンジンがtransitとは異なるパスにマウントされている場合は、ReactiveVaultTransitOperationsを返します。- 次で指定:
- インターフェース
ReactiveVaultOperationsのopsForTransit - パラメーター:
path- マウントパス- 戻り値:
- Vault トランジットエンジンと対話するための操作インターフェース。
opsForKeyValue
public ReactiveVaultKeyValueOperations opsForKeyValue(StringSE path, VaultKeyValueOperationsSupport.KeyValueBackend apiVersion) インターフェースからコピーされた説明:ReactiveVaultOperationsVaultKeyValueOperationsを返します。- 次で指定:
- インターフェース
ReactiveVaultOperationsのopsForKeyValue - パラメーター:
path- マウントパス。空または null にすることはできません。apiVersion- 使用する API バージョン。null であってはなりません。- 戻り値:
- Vault キー / 値シークレットエンジンと対話するための操作インターフェース。
opsForVersionedKeyValue
インターフェースからコピーされた説明:ReactiveVaultOperations- 次で指定:
- インターフェース
ReactiveVaultOperationsのopsForVersionedKeyValue - パラメーター:
path- マウントパス- 戻り値:
- バージョン管理された Vault キー / 値 (バージョン 2) シークレットエンジンと対話するための操作インターフェース。
read
インターフェースからコピーされた説明:ReactiveVaultOperationsVault パスから読み取ります。このメソッドを使用したデータの読み取りは、リクエストボディを必要としない API 呼び出し / シークレットエンジンに適しています。- 次で指定:
- インターフェース
ReactiveVaultOperationsのread - パラメーター:
path- null であってはなりません。- 戻り値:
- データ。パスが存在しない場合は空になることがあります。
read
インターフェースからコピーされた説明:ReactiveVaultOperationsVault パスから読み取ります。このメソッドを使用したデータの読み取りは、リクエストボディを必要としない API 呼び出し / シークレットエンジンに適しています。- 次で指定:
- インターフェース
ReactiveVaultOperationsのread - パラメーター:
path- null であってはなりません。responseType- null であってはなりません。- 戻り値:
- データ。パスが存在しない場合は空になることがあります。
list
インターフェースからコピーされた説明:ReactiveVaultOperationsVault パスからキーを列挙します。- 次で指定:
- インターフェース
ReactiveVaultOperationsのlist - パラメーター:
path- null であってはなりません。- 戻り値:
- データ。パスが存在しない場合は空になることがあります。
write
インターフェースからコピーされた説明:ReactiveVaultOperationsVault パスに書き込みます。- 次で指定:
- インターフェース
ReactiveVaultOperationsのwrite - パラメーター:
path- null であってはなりません。body- ボディ、存在しない場合は null の可能性があります。- 戻り値:
- レスポンス。レスポンスに本文がない場合は空になることがあります。
delete
インターフェースからコピーされた説明:ReactiveVaultOperationsパスを削除します。- 次で指定:
- インターフェース
ReactiveVaultOperationsのdelete - パラメーター:
path- null であってはなりません。
doWithVault
public <V,T extends org.reactivestreams.Publisher<V>> T doWithVault(FunctionSE<WebClient, ? extends T> clientCallback) throws VaultException, WebClientExceptionインターフェースからコピーされた説明:ReactiveVaultOperationsVaultRestOperationsCallbackを実行します。セッションを必要とせずに、RestOperationsを使用して Vault とやり取りできます。- 次で指定:
- インターフェース
ReactiveVaultOperationsのdoWithVault - パラメーター:
clientCallback- リクエスト。- 戻り値:
RestOperationsCallback戻り値。- 例外:
VaultException-HttpStatusCodeExceptionが発生したとき。WebClientException-WebClientからの例外。
doWithSession
public <V,T extends org.reactivestreams.Publisher<V>> T doWithSession(FunctionSE<WebClient, ? extends T> sessionCallback) throws VaultException, WebClientExceptionインターフェースからコピーされた説明:ReactiveVaultOperationsVaultRestOperationsCallbackを実行します。認証されたセッションで Vault と対話できるようにします。- 次で指定:
- インターフェース
ReactiveVaultOperationsのdoWithSession - パラメーター:
sessionCallback- リクエスト。- 戻り値:
RestOperationsCallback戻り値。- 例外:
VaultException-HttpStatusCodeExceptionが発生したとき。WebClientException-WebClientからの例外。