インターフェース VaultClient
public interface VaultClient
Vault HTTP リクエストを実行し、基盤となる
RestClient を介して流れるような同期 API を公開するクライアント。 インスタンスを準備するには、静的ファクトリメソッド create()、create(String)、builder() を使用します。RestClient と同じ構成を使用する場合は、それぞれ builder(RestClient) または builder(RestTemplate) を使用します。
VaultClient は、VaultEndpoint が configured となるような相対パスで使用することを想定しています。エンドポイントがない場合、呼び出し元は各リクエストに対して絶対 URL を指定する必要があります。
レスポンス本文を含む例について
リクエスト本文の例については、以下を参照してください。
- 導入:
- 4.1
- 作成者:
- Mark Paluch
ネストされたクラスの概要
ネストされたクラス修飾子と型インターフェース説明static interfaceVaultClientを作成するための可変ビルダー。static interfaceVaultClient.PathSpec<S extends VaultClient.RequestHeadersSpec<?>>リクエストのパスを指定するための契約。static interface交換に至るまでのリクエストヘッダーと本文を指定するための契約。static interfaceリクエストのリクエストヘッダー、本文、パスを指定するための契約。static interfaceリクエストのリクエストヘッダーとパスを指定するための契約。static interface交換に至るまでのリクエストヘッダーを指定するための契約。static interface交換後のレスポンス操作を指定するための契約。方法の概要
修飾子と型メソッド説明static VaultClient.Builderbuilder()VaultClientビルダーを入手します。static VaultClient.Builderbuilder(RestClient restClient) 指定されたRestClientの構成に基づいてVaultClientビルダーを取得します。static VaultClient.Builderbuilder(RestTemplate restTemplate) 指定されたRestTemplateの構成に基づいてVaultClientビルダーを取得します。static VaultClientcreate()新しいVaultClientを作成します。static VaultClientデフォルトのベース URL を受け入れるcreate()のバリアント。static VaultClientcreate(VaultEndpoint endpoint) デフォルトのVaultEndpointを受け入れるcreate()のバリアント。static VaultClientcreate(VaultEndpointProvider endpointProvider) デフォルトのVaultEndpointProviderを受け入れるcreate()のバリアント。delete()HTTP DELETE リクエストの作成を開始します。get()HTTP GET リクエストの作成を開始します。method(HttpMethod method) 指定されたHttpMethodのリクエストの構築を開始します。mutate()このVaultClientから設定が複製される新しいVaultClientを作成するためのビルダーを返します。post()HTTP POST リクエストの作成を開始します。put()HTTP PUT リクエストの作成を開始します。
方法の詳細
get
VaultClient.RequestHeadersPathSpec<?> get()HTTP GET リクエストの作成を開始します。- 戻り値:
- 対象パスを指定するための仕様。
post
HTTP POST リクエストの作成を開始します。- 戻り値:
- 対象パスを指定するための仕様。
put
HTTP PUT リクエストの作成を開始します。- 戻り値:
- 対象パスを指定するための仕様。
delete
VaultClient.RequestHeadersPathSpec<?> delete()HTTP DELETE リクエストの作成を開始します。- 戻り値:
- 対象パスを指定するための仕様。
method
指定されたHttpMethodのリクエストの構築を開始します。- 戻り値:
- 対象パスを指定するための仕様。
mutate
VaultClient.Builder mutate()このVaultClientから設定が複製される新しいVaultClientを作成するためのビルダーを返します。create
新しいVaultClientを作成します。create
デフォルトのベース URL を受け入れるcreate()のバリアント。詳細については、VaultClient.Builder.endpoint(VaultEndpoint)を参照してください。- パラメーター:
baseUrl- すべてのリクエストのベース URI。- 関連事項:
create
デフォルトのVaultEndpointを受け入れるcreate()の派生版です。詳細はVaultClient.Builder.endpoint(VaultEndpoint)を参照してください。- パラメーター:
endpoint- すべての相対パスリクエストに対する Vault エンドポイント。- 関連事項:
create
デフォルトのVaultEndpointProviderを受け入れるcreate()の派生版です。詳細はVaultClient.Builder.endpoint(VaultEndpointProvider)を参照してください。- パラメーター:
endpointProvider- すべての相対パスリクエストに対するエンドポイントプロバイダ。- 関連事項:
builder
VaultClientビルダーを入手します。builder
指定されたRestTemplateの構成に基づいてVaultClientビルダーを取得します。RestTemplateは、String、byte[]、JSON 変換をサポートするために、適切なHttpMessageConvertersで構成する必要があります。さらに、テンプレートがベース URL を使用するように構成されている場合、構築されたVaultClientは相対パスで使用できます。返されるビルダーは、テンプレートの次の属性で構成されます。- パラメーター:
restTemplate- 返されるビルダー構成の基となる REST テンプレート。- 戻り値:
restTemplateの設定で初期化されたVaultClientビルダー。- 関連事項:
builder
指定されたRestClientの構成に基づいてVaultClientビルダーを取得します。RestClientは、文字列、バイト配列、JSON の変換をサポートするために、適切なHttpMessageConvertersで構成する必要があります。さらに、クライアントがベース URL を使用するように構成されている場合、構築済みのVaultClientを相対パスで使用できます。- パラメーター:
restClient- 返されるビルダー構成のベースとなるRestClient。- 戻り値:
restClientの設定で初期化されたVaultClientビルダー。