インターフェース VaultClient.ResponseSpec
- 含まれているインターフェース:
- VaultClient
public static interface VaultClient.ResponseSpec
交換後のレスポンス操作を指定するための契約。
方法の概要
修飾子と型メソッド説明@Nullable VaultResponsebody()ボディを指定された型のオブジェクトとして抽出します。<T> @Nullable Tボディを指定された型のオブジェクトとして抽出します。<T> @Nullable Tbody(ParameterizedTypeReference<T> bodyType) ボディを指定された型のオブジェクトとして抽出します。onStatus(PredicateSE<HttpStatusCode> statusPredicate, RestClient.ResponseSpec.ErrorHandler errorHandler) 特定のエラーステータスコードをエラーハンドラーにマップする関数を提供します。必要な本体を指定された型のオブジェクトとして抽出します。<T> TrequiredBody(ClassSE<T> bodyType) 必要な本体を指定された型のオブジェクトとして抽出します。<T> TrequiredBody(ParameterizedTypeReference<T> bodyType) 必要な本体を指定された型のオブジェクトとして抽出します。本体なしでResponseEntityを返します。default ResponseEntity<VaultResponse>toEntity()本体を VaultResponse にデコードしたResponseEntityを返します。<T> ResponseEntity<T>指定された型のオブジェクトにデコードされた本体を持つResponseEntityを返します。<T> ResponseEntity<T>toEntity(ParameterizedTypeReference<T> bodyType) 指定された型のオブジェクトにデコードされた本体を持つResponseEntityを返します。wrap(DurationSE ttl) リクエストされた TTL を持つ cubbyhole トークンでレスポンスをラップします。
メソッドの詳細
onStatus
VaultClient.ResponseSpec onStatus(PredicateSE<HttpStatusCode> statusPredicate, RestClient.ResponseSpec.ErrorHandler errorHandler) 特定のエラーステータスコードをエラーハンドラーにマップする関数を提供します。デフォルトでは、一致するステータスハンドラーがない場合、ステータスコードが 400 以上のレスポンスは
VaultClientResponseExceptionをスローします。errorHandlerからスローされたIOExceptionsSE、UncheckedIOExceptionsSE、HttpMessageNotReadableExceptionsはVaultClientResponseExceptionでラップされることに注意してください。- パラメーター:
statusPredicate- レスポンスを一致させるerrorHandler- 必ずではありませんが、通常は例外をスローするハンドラー- 戻り値:
- このビルダー
wrap
リクエストされた TTL を持つ cubbyhole トークンでレスポンスをラップします。- パラメーター:
ttl- ラップされたレスポンスの存続時間。- 戻り値:
- トークンとラップされたレスポンスのメタデータを提供する cubbyhole
WrappedMetadata。 - 例外:
VaultClientResponseException- ステータスコードが 4xx または 5xx のレスポンスを受信した場合。IllegalStateExceptionSE- レスポンスボディが利用できない場合。
requiredBody
VaultResponse requiredBody()必要な本体を指定された型のオブジェクトとして抽出します。- 戻り値:
- レスポンスボディ、またはレスポンスボディが利用できない場合は
IllegalStateExceptionSE。 - 例外:
VaultClientResponseException- ステータスコードが 4xx または 5xx のレスポンスを受信した場合。NoSuchElementExceptionSE- レスポンスボディが利用できない場合。
body
@Nullable VaultResponse body()ボディを指定された型のオブジェクトとして抽出します。- 戻り値:
- レスポンスボディ、またはレスポンスボディが利用できない場合は
null。 - 例外:
VaultClientResponseException- ステータスコードが 4xx または 5xx のレスポンスを受信した場合。
requiredBody
必要な本体を指定された型のオブジェクトとして抽出します。- 戻り値:
- レスポンスボディ、またはレスポンスボディが利用できない場合は
IllegalStateExceptionSE。 - 例外:
VaultClientResponseException- ステータスコードが 4xx または 5xx のレスポンスを受信した場合。NoSuchElementExceptionSE- レスポンスボディが利用できない場合。
requiredBody
必要な本体を指定された型のオブジェクトとして抽出します。- 戻り値:
- レスポンスボディ、またはレスポンスボディが利用できない場合は
IllegalStateExceptionSE。 - 例外:
VaultClientResponseException- ステータスコードが 4xx または 5xx のレスポンスを受信した場合。NoSuchElementExceptionSE- レスポンスボディが利用できない場合。
body
ボディを指定された型のオブジェクトとして抽出します。- 型パラメーター:
T- 体型。- パラメーター:
bodyType- 戻り値の型。- 戻り値:
- 本文、またはレスポンス本文が利用できない場合は
null - 例外:
VaultClientResponseException- ステータスコードが 4xx または 5xx のレスポンスを受信した場合。
body
ボディを指定された型のオブジェクトとして抽出します。- 型パラメーター:
T- 体型。- パラメーター:
bodyType- 戻り値の型。- 戻り値:
- レスポンスボディ、またはレスポンスボディが利用できない場合は
null。 - 例外:
VaultClientResponseException- ステータスコードが 4xx または 5xx のレスポンスを受信した場合。
toEntity
本体を VaultResponse にデコードしたResponseEntityを返します。- 戻り値:
- 復号された本体を持つ
ResponseEntity。 - 例外:
VaultClientResponseException- ステータスコードが 4xx または 5xx のレスポンスを受信した場合。
toEntity
指定された型のオブジェクトにデコードされた本体を持つResponseEntityを返します。- 型パラメーター:
T- response body type.- パラメーター:
bodyType- the expected response body type.- 戻り値:
- デコードされたボディを持つ
ResponseEntity - 例外:
VaultClientResponseException- ステータスコードが 4xx または 5xx のレスポンスを受信した場合。
toEntity
指定された型のオブジェクトにデコードされた本体を持つResponseEntityを返します。- 型パラメーター:
T- response body type.- パラメーター:
bodyType- the expected response body type.- 戻り値:
- 復号された本体を持つ
ResponseEntity。 - 例外:
VaultClientResponseException- ステータスコードが 4xx または 5xx のレスポンスを受信した場合。
toBodilessEntity
ResponseEntity<VoidSE> toBodilessEntity()本体なしでResponseEntityを返します。- 戻り値:
ResponseEntity- 例外:
VaultClientResponseException- ステータスコードが 4xx または 5xx のレスポンスを受信した場合。