クラス VaultTemplate
java.lang.ObjectSE
org.springframework.vault.core.VaultTemplate
- 実装されたすべてのインターフェース:
DisposableBean
、InitializingBean
、VaultOperations
public class VaultTemplate
extends ObjectSE
implements InitializingBean, VaultOperations, DisposableBean
このクラスは、メインの Vault インタラクションをカプセル化します。
VaultTemplate
は初期化時に Vault にログインし、存続期間全体にわたってトークンを使用します。- 作成者:
- Mark Paluch
- 関連事項:
コンストラクターのサマリー
コンストラクターコンストラクター説明VaultTemplate
(RestTemplateBuilder restTemplateBuilder) 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) メソッドのサマリー
修飾子と型メソッド説明void
void
パスを削除します。void
destroy()
protected RestTemplate
doCreateRestTemplate
(VaultEndpointProvider endpointProvider, ClientHttpRequestFactory requestFactory) VaultEndpointProvider
およびClientHttpRequestFactory
を指定して、Vault 通信のためにVaultTemplate
によって使用されるRestTemplate
を作成します。protected RestTemplate
doCreateSessionTemplate
(VaultEndpointProvider endpointProvider, ClientHttpRequestFactory requestFactory) 認証されたコンテキストを必要とする呼び出し用のVaultEndpointProvider
およびClientHttpRequestFactory
を指定して、Vault 通信用にVaultTemplate
によって使用されるセッションバインドRestTemplate
を作成します。<T> T
doWithSession
(RestOperationsCallback<T> sessionCallback) VaultRestOperationsCallback
を実行します。<T> T
doWithVault
(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
を返します。Vault パスから読み取ります。<T> VaultResponseSupport<T>
秘密のバックエンドから読み取ります。void
setSessionManager
(SessionManager sessionManager) SessionManager
を設定してください。Vault パスに書き込みます。クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.vault.core.VaultOperations から継承されたメソッド
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
およびSessionManager
を介して新しいVaultTemplate
を作成します。このコンストラクターはClientAuthentication
メカニズムを使用しません。authentication token header
を使用せずに Vault エージェントの認証を継承するために、Vault エージェントで使用することを目的としています。- パラメーター:
restTemplateBuilder
- null であってはなりません。- 導入:
- 2.2.1
VaultTemplate
- パラメーター:
restTemplateBuilder
- null であってはなりません。sessionManager
- null であってはなりません。- 導入:
- 2.2
メソッドの詳細
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
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
setSessionManager
SessionManager
を設定してください。- パラメーター:
sessionManager
- null であってはなりません。
afterPropertiesSet
public void afterPropertiesSet()- 次で指定:
- インターフェース
InitializingBean
のafterPropertiesSet
destroy
- 次で指定:
- インターフェース
DisposableBean
のdestroy
- 例外:
ExceptionSE
opsForKeyValue
public VaultKeyValueOperations opsForKeyValue(StringSE path, VaultKeyValueOperationsSupport.KeyValueBackend apiVersion) インターフェースからコピーされた説明:VaultOperations
VaultKeyValueOperations
を返します。- 次で指定:
- インターフェース
VaultOperations
のopsForKeyValue
- パラメーター:
path
- マウントパス。空または null にすることはできません。apiVersion
- 使用する API バージョン。null であってはなりません。- 戻り値:
- Vault Key/Value バックエンドとやり取りするための操作インターフェース。
opsForVersionedKeyValue
インターフェースからコピーされた説明:VaultOperations
- 次で指定:
- インターフェース
VaultOperations
のopsForVersionedKeyValue
- パラメーター:
path
- マウントパス- 戻り値:
- バージョン管理された Vault キー / 値 (バージョン 2) バックエンドとやり取りするための操作インターフェース。
opsForPki
- 次で指定:
- インターフェース
VaultOperations
のopsForPki
- 戻り値:
- Vault PKI バックエンドと対話するための操作インターフェース。
opsForPki
インターフェースからコピーされた説明:VaultOperations
PKI バックエンドが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
インターフェースからコピーされた説明:VaultOperations
Vault パスから読み取ります。このメソッドを使用したデータの読み取りは、リクエストボディを必要としない API 呼び出し / シークレットバックエンドに適しています。- 次で指定:
- インターフェース
VaultOperations
のread
- パラメーター:
path
- null であってはなりません。- 戻り値:
- データ。パスが存在しない場合は null になる可能性があります。
read
インターフェースからコピーされた説明:VaultOperations
秘密のバックエンドから読み取ります。このメソッドを使用したデータの読み取りは、リクエストボディを必要としないシークレットバックエンドに適しています。- 次で指定:
- インターフェース
VaultOperations
のread
- パラメーター:
path
- null であってはなりません。responseType
- null であってはなりません。- 戻り値:
- データ。パスが存在しない場合は null になる可能性があります。
list
インターフェースからコピーされた説明:VaultOperations
Vault パスからキーを列挙します。- 次で指定:
- インターフェース
VaultOperations
のlist
- パラメーター:
path
- null であってはなりません。- 戻り値:
- データ。パスが存在しない場合は null になる可能性があります。
write
インターフェースからコピーされた説明:VaultOperations
Vault パスに書き込みます。- 次で指定:
- インターフェース
VaultOperations
のwrite
- パラメーター:
path
- null であってはなりません。body
- ボディ、存在しない場合は null の可能性があります。- 戻り値:
- null の可能性があります。
delete
インターフェースからコピーされた説明:VaultOperations
パスを削除します。- 次で指定:
- インターフェース
VaultOperations
のdelete
- パラメーター:
path
- null であってはなりません。
doWithVault
インターフェースからコピーされた説明:VaultOperations
VaultRestOperationsCallback
を実行します。セッションを必要とせずに、RestOperations
を使用して Vault とやり取りできます。- 次で指定:
- インターフェース
VaultOperations
のdoWithVault
- パラメーター:
clientCallback
- リクエスト。- 戻り値:
RestOperationsCallback
戻り値。
doWithSession
インターフェースからコピーされた説明:VaultOperations
VaultRestOperationsCallback
を実行します。認証されたセッションで Vault と対話できるようにします。- 次で指定:
- インターフェース
VaultOperations
のdoWithSession
- パラメーター:
sessionCallback
- リクエスト。- 戻り値:
RestOperationsCallback
戻り値。