インターフェース RestClient.ResponseSpec

含まれているインターフェース:
RestClient
public static interface RestClient.ResponseSpec
交換後のレスポンス操作を指定するための契約。
導入:
6.1
作成者:
Arjen Poutsma, Sebastien Deleuze

  • メソッドの詳細

    • onStatus

      RestClient.ResponseSpec onStatus(PredicateSE<HttpStatusCode> statusPredicate, RestClient.ResponseSpec.ErrorHandler errorHandler)
      特定のエラーステータスコードをエラーハンドラーにマップする関数を提供します。

      デフォルトでは、一致するステータスハンドラーがない場合、ステータスコードが 400 以上のレスポンスは RestClientResponseException をスローします。

      errorHandler からスローされた IOExceptionsSE、UncheckedIOExceptionsSE、HttpMessageNotReadableExceptions は RestClientException でラップされることに注意してください。

      パラメーター:
      statusPredicate - レスポンスを一致させる
      errorHandler - 必ずではありませんが、通常は例外をスローするハンドラー
      戻り値:
      このビルダー

    • onStatus

      RestClient.ResponseSpec onStatus(ResponseErrorHandler errorHandler)
      特定のエラーステータスコードをエラーハンドラーにマップする関数を提供します。

      デフォルトでは、一致するステータスハンドラーがない場合、ステータスコードが 400 以上のレスポンスは RestClientResponseException をスローします。

      errorHandler からスローされた IOExceptionsSE、UncheckedIOExceptionsSE、HttpMessageNotReadableExceptions は RestClientException でラップされることに注意してください。

      パラメーター:
      errorHandler - エラーハンドラー
      戻り値:
      このビルダー

    • body

      <T> @Nullable T body(ClassSE<T> bodyType)
      ボディを指定された型のオブジェクトとして抽出します。
      型パラメーター:
      T - ボディ型
      パラメーター:
      bodyType - 戻り値の型
      戻り値:
      本文、またはレスポンス本文が利用できない場合は null 
      例外:
      RestClientResponseException - デフォルトでは、ステータスコード 4xx または 5xx のレスポンスを受信したときに実行されます。onStatus(Predicate, ErrorHandler) を使用して、エラーレスポンス処理をカスタマイズします。

    • body

      <T> @Nullable T body(ParameterizedTypeReference<T> bodyType)
      ボディを指定された型のオブジェクトとして抽出します。
      型パラメーター:
      T - ボディ型
      パラメーター:
      bodyType - 戻り値の型
      戻り値:
      本文、またはレスポンス本文が利用できない場合は null 
      例外:
      RestClientResponseException - デフォルトでは、ステータスコード 4xx または 5xx のレスポンスを受信したときに実行されます。onStatus(Predicate, ErrorHandler) を使用して、エラーレスポンス処理をカスタマイズします。

    • toEntity

      <T> ResponseEntity<T> toEntity(ClassSE<T> bodyType)
      指定された型のオブジェクトにデコードされた本体を持つ ResponseEntity を返します。
      型パラメーター:
      T - レスポンス本体型
      パラメーター:
      bodyType - 予想されるレスポンス本文型
      戻り値:
      デコードされたボディを持つ ResponseEntity 
      例外:
      RestClientResponseException - デフォルトでは、ステータスコード 4xx または 5xx のレスポンスを受信したときに実行されます。onStatus(Predicate, ErrorHandler) を使用して、エラーレスポンス処理をカスタマイズします。

    • toEntity

      <T> ResponseEntity<T> toEntity(ParameterizedTypeReference<T> bodyType)
      指定された型のオブジェクトにデコードされた本体を持つ ResponseEntity を返します。
      型パラメーター:
      T - レスポンス本体型
      パラメーター:
      bodyType - 予想されるレスポンス本文型
      戻り値:
      デコードされたボディを持つ ResponseEntity 
      例外:
      RestClientResponseException - デフォルトでは、ステータスコード 4xx または 5xx のレスポンスを受信したときに実行されます。onStatus(Predicate, ErrorHandler) を使用して、エラーレスポンス処理をカスタマイズします。

    • toBodilessEntity

      ResponseEntity<VoidSE> toBodilessEntity()
      本体なしで ResponseEntity を返します。
      戻り値:
      ResponseEntity
      例外:
      RestClientResponseException - デフォルトでは、ステータスコード 4xx または 5xx のレスポンスを受信したときに実行されます。onStatus(Predicate, ErrorHandler) を使用して、エラーレスポンス処理をカスタマイズします。

    • hint

      RestClient.ResponseSpec hint(StringSE key, ObjectSE value)
      指定された名前のヒントを、サポートする SmartHttpMessageConverter の指定された値に設定します。
      パラメーター:
      key - 追加するヒントのキー
      value - 追加するヒントの値
      戻り値:
      このビルダー
      導入:
      7.0