インターフェース VaultOperations
- すべての既知の実装クラス:
VaultTemplate
public interface VaultOperations
VaultTemplate
によって実装される、Vault 操作の基本セットを指定するインターフェース。これは、認証済みおよび未認証のコンテキストで Vault と対話するためのメインエントリポイントです。VaultOperations
では、コールバックメソッドを実行できます。コールバックは、session context
および without a session
内でリクエストを実行できます。
- 作成者:
- Mark Paluch, Lauren Voswinkel
- 関連事項:
メソッドのサマリー
修飾子と型メソッド説明void
パスを削除します。<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>
秘密のバックエンドから読み取ります。default VaultResponse
Vault パスに書き込みます。Vault パスに書き込みます。
メソッドの詳細
opsForKeyValue
VaultKeyValueOperations opsForKeyValue(StringSE path, VaultKeyValueOperationsSupport.KeyValueBackend apiVersion) VaultKeyValueOperations
を返します。- パラメーター:
path
- マウントパス。空または null にすることはできません。apiVersion
- 使用する API バージョン。null であってはなりません。- 戻り値:
- Vault Key/Value バックエンドとやり取りするための操作インターフェース。
- 導入:
- 2.1
opsForVersionedKeyValue
- パラメーター:
path
- マウントパス- 戻り値:
- バージョン管理された Vault キー / 値 (バージョン 2) バックエンドとやり取りするための操作インターフェース。
- 導入:
- 2.1
opsForPki
VaultPkiOperations opsForPki()- 戻り値:
- Vault PKI バックエンドと対話するための操作インターフェース。
opsForPki
PKI バックエンドがpki
とは異なるパスにマウントされている場合は、VaultPkiOperations
を返します。- パラメーター:
path
- マウントパス- 戻り値:
- Vault PKI バックエンドと対話するための操作インターフェース。
opsForSys
VaultSysOperations opsForSys()- 戻り値:
- 操作インターフェースの管理 Vault アクセス。
opsForToken
VaultTokenOperations opsForToken()- 戻り値:
- Vault トークンとやり取りするための操作インターフェース。
opsForTransform
VaultTransformOperations opsForTransform()- 戻り値:
- Vault 変換バックエンドと対話するための操作インターフェース。
- 導入:
- 2.3
opsForTransform
通過バックエンドがtransform
とは異なるパスにマウントされている場合は、VaultTransformOperations
を返します。- パラメーター:
path
- マウントパス- 戻り値:
- Vault 変換バックエンドと対話するための操作インターフェース。
- 導入:
- 2.3
opsForTransit
VaultTransitOperations opsForTransit()- 戻り値:
- Vault トランジットバックエンドと対話するための操作インターフェース。
opsForTransit
通過バックエンドがtransit
とは異なるパスにマウントされている場合は、VaultTransitOperations
を返します。- パラメーター:
path
- マウントパス- 戻り値:
- Vault トランジットバックエンドと対話するための操作インターフェース。
opsForWrapping
VaultWrappingOperations opsForWrapping()- 戻り値:
- Vault システム / 折り返し エンドポイントと対話するための操作インターフェース。
- 導入:
- 2.1
read
Vault パスから読み取ります。このメソッドを使用したデータの読み取りは、リクエストボディを必要としない API 呼び出し / シークレットバックエンドに適しています。- パラメーター:
path
- null であってはなりません。- 戻り値:
- データ。パスが存在しない場合は null になる可能性があります。
read
秘密のバックエンドから読み取ります。このメソッドを使用したデータの読み取りは、リクエストボディを必要としないシークレットバックエンドに適しています。- パラメーター:
path
- null であってはなりません。responseType
- null であってはなりません。- 戻り値:
- データ。パスが存在しない場合は null になる可能性があります。
list
Vault パスからキーを列挙します。- パラメーター:
path
- null であってはなりません。- 戻り値:
- データ。パスが存在しない場合は null になる可能性があります。
write
Vault パスに書き込みます。- パラメーター:
path
- null であってはなりません。- 戻り値:
- null の可能性があります。
- 導入:
- 2.0
write
Vault パスに書き込みます。- パラメーター:
path
- null であってはなりません。body
- ボディ、存在しない場合は null の可能性があります。- 戻り値:
- null の可能性があります。
delete
パスを削除します。- パラメーター:
path
- null であってはなりません。
doWithVault
@Nullable <T> T doWithVault(RestOperationsCallback<T> clientCallback) throws VaultException, RestClientException VaultRestOperationsCallback
を実行します。セッションを必要とせずに、RestOperations
を使用して Vault とやり取りできます。- パラメーター:
clientCallback
- リクエスト。- 戻り値:
RestOperationsCallback
戻り値。- 例外:
VaultException
-HttpStatusCodeException
が発生したとき。RestClientException
-RestOperations
からの例外。
doWithSession
@Nullable <T> T doWithSession(RestOperationsCallback<T> sessionCallback) throws VaultException, RestClientException VaultRestOperationsCallback
を実行します。認証されたセッションで Vault と対話できるようにします。- パラメーター:
sessionCallback
- リクエスト。- 戻り値:
RestOperationsCallback
戻り値。- 例外:
VaultException
-HttpStatusCodeException
が発生したとき。RestClientException
-RestOperations
からの例外。