クラス VaultTemplate
java.lang.ObjectSE
org.springframework.vault.core.VaultTemplate
- 実装されているすべてのインターフェース:
DisposableBean、InitializingBean、VaultOperations
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
- 関連事項:
コンストラクターの概要
コンストラクターコンストラクター説明VaultTemplate(RestClientBuilder restClientBuilder) RestClientBuilderを介して新しいVaultTemplateを作成します。VaultTemplate(RestClientBuilder restClientBuilder, SessionManager sessionManager) VaultTemplate(RestTemplateBuilder restTemplateBuilder) RestTemplateBuilderを介して新しいVaultTemplateを作成します。VaultTemplate(RestTemplateBuilder restTemplateBuilder, SessionManager sessionManager) VaultTemplate(VaultEndpoint vaultEndpoint) VaultEndpointで新しいVaultTemplateを作成します。VaultTemplate(VaultEndpointProvider endpointProvider, ClientHttpRequestFactory requestFactory) VaultTemplate(VaultEndpointProvider endpointProvider, ClientHttpRequestFactory requestFactory, SessionManager sessionManager) VaultTemplate(VaultEndpoint vaultEndpoint, ClientHttpRequestFactory clientHttpRequestFactory) VaultTemplate(VaultEndpoint vaultEndpoint, ClientHttpRequestFactory clientHttpRequestFactory, SessionManager sessionManager) VaultTemplate(VaultEndpoint vaultEndpoint, ClientAuthentication clientAuthentication) 方法の概要
修飾子と型メソッド説明voidvoidパスを削除します。voiddestroy()protected RestClientdoCreateRestClient(VaultEndpointProvider endpointProvider, ClientHttpRequestFactory requestFactory) VaultEndpointProviderおよびClientHttpRequestFactoryを指定して、Vault 通信のためにVaultTemplateによって使用されるRestClientを作成します。protected RestTemplatedoCreateRestTemplate(VaultEndpointProvider endpointProvider, ClientHttpRequestFactory requestFactory) VaultEndpointProviderおよびClientHttpRequestFactoryを指定して、Vault 通信のためにVaultTemplateによって使用されるRestTemplateを作成します。protected RestClientdoCreateSessionClient(VaultEndpointProvider endpointProvider, ClientHttpRequestFactory requestFactory) 認証されたコンテキストを必要とする呼び出し用のVaultEndpointProviderおよびClientHttpRequestFactoryを指定して、Vault 通信用にVaultTemplateによって使用されるセッションバインドRestClientを作成します。protected RestTemplatedoCreateSessionTemplate(VaultEndpointProvider endpointProvider, ClientHttpRequestFactory requestFactory) 認証されたコンテキストを必要とする呼び出し用のVaultEndpointProviderおよびClientHttpRequestFactoryを指定して、Vault 通信用にVaultTemplateによって使用されるセッションバインドRestTemplateを作成します。<T extends @Nullable ObjectSE>
TdoWithSession(RestOperationsCallback<T> sessionCallback) VaultRestOperationsCallbackを実行します。<T extends @Nullable ObjectSE>
TdoWithVault(RestOperationsCallback<T> clientCallback) VaultRestOperationsCallbackを実行します。Vault パスからキーを列挙します。opsForKeyValue(StringSE path, VaultKeyValueOperationsSupport.KeyValueBackend apiVersion) VaultKeyValueOperationsを返します。PKI シークレットエンジンがpkiとは異なるパスにマウントされている場合は、VaultPkiOperationsを返します。opsForTransform(StringSE path) トランジットシークレットエンジンがtransformとは異なるパスにマウントされている場合は、VaultTransformOperationsを返します。opsForTransit(StringSE path) トランジットシークレットエンジンがtransitとは異なるパスにマウントされている場合は、VaultTransitOperationsを返します。@Nullable VaultResponseVault パスから (GET)を読み取ります。<T> @Nullable VaultResponseSupport<T>シークレットエンジンから (GET)) を読み取ります。voidsetSessionManager(SessionManager sessionManager) SessionManagerを設定してください。@Nullable VaultResponse(POST)を Vault パスに書き込みます。クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSEインターフェース org.springframework.vault.core.VaultOperations から継承されたメソッド
invoke, readRequired, readRequired, write
コンストラクターの詳細
VaultTemplate
VaultEndpointで新しいVaultTemplateを作成します。このコンストラクターは、ClientAuthenticationメカニズムを使用しません。authentication token headerを使用せずに Vault エージェントの認証を継承するために、Vault エージェントで使用することを目的としています。- パラメーター:
vaultEndpoint- null であってはなりません。- 導入:
- 2.2.1
VaultTemplate
- パラメーター:
vaultEndpoint- null であってはなりません。clientAuthentication- null であってはなりません。
VaultTemplate
public VaultTemplate(VaultEndpoint vaultEndpoint, ClientHttpRequestFactory clientHttpRequestFactory) VaultEndpointおよびClientHttpRequestFactoryで新しいVaultTemplateを作成します。このコンストラクターはClientAuthenticationメカニズムを使用しません。authentication token headerを使用せずに Vault エージェントの認証を継承するために、Vault エージェントで使用することを目的としています。- パラメーター:
vaultEndpoint- null であってはなりません。clientHttpRequestFactory- null であってはなりません。- 導入:
- 2.2.1
VaultTemplate
public VaultTemplate(VaultEndpoint vaultEndpoint, ClientHttpRequestFactory clientHttpRequestFactory, SessionManager sessionManager) - パラメーター:
vaultEndpoint- null であってはなりません。clientHttpRequestFactory- null であってはなりません。sessionManager- null であってはなりません。
VaultTemplate
public VaultTemplate(VaultEndpointProvider endpointProvider, ClientHttpRequestFactory requestFactory) VaultEndpointProvider、ClientHttpRequestFactory、SessionManagerで新しいVaultTemplateを作成します。このコンストラクターはClientAuthenticationメカニズムを使用しません。authentication token headerを使用せずに Vault エージェントの認証を継承するために、Vault エージェントで使用することを目的としています。- パラメーター:
endpointProvider- null であってはなりません。requestFactory- null であってはなりません。- 導入:
- 2.2.1
VaultTemplate
public VaultTemplate(VaultEndpointProvider endpointProvider, ClientHttpRequestFactory requestFactory, SessionManager sessionManager) - パラメーター:
endpointProvider- null であってはなりません。requestFactory- null であってはなりません。sessionManager- null であってはなりません。- 導入:
- 1.1
VaultTemplate
RestTemplateBuilderを介して新しいVaultTemplateを作成します。このコンストラクターはClientAuthenticationメカニズムを使用しません。これは、authentication token headerを使用せずに Vault エージェントで Vault エージェントの認証を継承するために使用します。- パラメーター:
restTemplateBuilder- null であってはなりません。- 導入:
- 2.2.1
VaultTemplate
RestClientBuilderを介して新しいVaultTemplateを作成します。このコンストラクターはClientAuthenticationメカニズムを使用しません。これは、authentication token headerを使用せずに Vault エージェントで Vault エージェントの認証を継承するために使用します。- パラメーター:
restClientBuilder- null であってはなりません。- 導入:
- 4.0
VaultTemplate
- パラメーター:
restTemplateBuilder- null であってはなりません。sessionManager- null であってはなりません。- 導入:
- 2.2
VaultTemplate
- パラメーター:
restClientBuilder- null であってはなりません。sessionManager- null であってはなりません。- 導入:
- 4.0
メソッドの詳細
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) VaultEndpointProviderとClientHttpRequestFactoryに基づいて、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
SessionManagerを設定してください。- パラメーター:
sessionManager- null であってはなりません。
afterPropertiesSet
public void afterPropertiesSet()- 次で指定:
- インターフェース
InitializingBeanのafterPropertiesSet
destroy
- 次で指定:
- インターフェース
DisposableBeanのdestroy - 例外:
ExceptionSE
opsForKeyValue
public VaultKeyValueOperations opsForKeyValue(StringSE path, VaultKeyValueOperationsSupport.KeyValueBackend apiVersion) インターフェースからコピーされた説明:VaultOperationsVaultKeyValueOperationsを返します。- 次で指定:
- インターフェース
VaultOperationsのopsForKeyValue - パラメーター:
path- マウントパス。空または null にすることはできません。apiVersion- 使用する API バージョン。null であってはなりません。- 戻り値:
- Vault キー / 値シークレットエンジンと対話するための操作インターフェース。
opsForVersionedKeyValue
インターフェースからコピーされた説明:VaultOperations- 次で指定:
- インターフェース
VaultOperationsのopsForVersionedKeyValue - パラメーター:
path- マウントパス- 戻り値:
- バージョン管理された Vault キー / 値 (バージョン 2) シークレットエンジンと対話するための操作インターフェース。
opsForPki
- 次で指定:
- インターフェース
VaultOperationsのopsForPki - 戻り値:
- Vault PKI シークレットエンジンと対話するための操作インターフェース。
opsForPki
インターフェースからコピーされた説明:VaultOperationsPKI シークレットエンジンがpkiとは異なるパスにマウントされている場合は、VaultPkiOperationsを返します。- 次で指定:
- インターフェース
VaultOperationsのopsForPki - パラメーター:
path- マウントパス- 戻り値:
- Vault PKI シークレットエンジンと対話するための操作インターフェース。
opsForSys
- 次で指定:
- インターフェース
VaultOperationsのopsForSys - 戻り値:
- 操作インターフェースの管理 Vault アクセス。
opsForToken
- 次で指定:
- インターフェース
VaultOperationsのopsForToken - 戻り値:
- Vault トークンとやり取りするための操作インターフェース。
opsForTransform
- 次で指定:
- インターフェース
VaultOperationsのopsForTransform - 戻り値:
- Vault 変換シークレットエンジンと対話するための操作インターフェース。
opsForTransform
インターフェースからコピーされた説明:VaultOperationsトランジットシークレットエンジンがtransformとは異なるパスにマウントされている場合は、VaultTransformOperationsを返します。- 次で指定:
- インターフェース
VaultOperationsのopsForTransform - パラメーター:
path- マウントパス- 戻り値:
- Vault 変換シークレットエンジンと対話するための操作インターフェース。
opsForTransit
- 次で指定:
- インターフェース
VaultOperationsのopsForTransit - 戻り値:
- Vault トランジットシークレットエンジンと対話するための操作インターフェース。
opsForTransit
インターフェースからコピーされた説明:VaultOperationsトランジットシークレットエンジンがtransitとは異なるパスにマウントされている場合は、VaultTransitOperationsを返します。- 次で指定:
- インターフェース
VaultOperationsのopsForTransit - パラメーター:
path- マウントパス- 戻り値:
- Vault トランジットシークレットエンジンと対話するための操作インターフェース。
opsForWrapping
- 次で指定:
- インターフェース
VaultOperationsのopsForWrapping - 戻り値:
- Vault システム / 折り返し エンドポイントと対話するための操作インターフェース。
read
インターフェースからコピーされた説明:VaultOperationsVault パスからGET)を読み取ります。このメソッドを使用したデータの読み取りは、リクエスト本体を必要としない API 呼び出し / シークレットエンジンに適しています。- 次で指定:
- インターフェース
VaultOperationsのread - パラメーター:
path- null であってはなりません。- 戻り値:
- データ。パスが存在しない場合は null になる可能性があります。
read
インターフェースからコピーされた説明:VaultOperationsRead (GET)from a secrets engine. Reading data using this method is suitable for secrets engines that do not require a request body.- 次で指定:
- インターフェース
VaultOperationsのread - パラメーター:
path- null であってはなりません。responseType- null であってはなりません。- 戻り値:
- データ。パスが存在しない場合は null になる可能性があります。
list
インターフェースからコピーされた説明:VaultOperationsVault パスからキーを列挙します。- 次で指定:
- インターフェース
VaultOperationsのlist - パラメーター:
path- null であってはなりません。- 戻り値:
- データ。パスが存在しない場合は null になる可能性があります。
write
インターフェースからコピーされた説明:VaultOperations(POST)を Vault パスに書き込みます。- 次で指定:
- インターフェース
VaultOperationsのwrite - パラメーター:
path- null であってはなりません。body- ボディ、存在しない場合は null の可能性があります。- 戻り値:
- null の可能性があります。
delete
インターフェースからコピーされた説明:VaultOperationsパスを削除します。- 次で指定:
- インターフェース
VaultOperationsのdelete - パラメーター:
path- null であってはなりません。
doWithVault
インターフェースからコピーされた説明:VaultOperationsVaultRestOperationsCallbackを実行します。セッションを必要とせずに、RestOperationsを使用して Vault とやり取りできます。- 次で指定:
- インターフェース
VaultOperationsのdoWithVault - パラメーター:
clientCallback- リクエスト。- 戻り値:
RestOperationsCallback戻り値。
doWithSession
インターフェースからコピーされた説明:VaultOperationsVaultRestOperationsCallbackを実行します。認証されたセッションで Vault と対話できるようにします。- 次で指定:
- インターフェース
VaultOperationsのdoWithSession - パラメーター:
sessionCallback- リクエスト。- 戻り値:
RestOperationsCallback戻り値。