パッケージ jakarta.ws.rs.client

インターフェース Invocation


  • public interface Invocation
    クライアントリクエストの呼び出し。呼び出しは、準備されて実行の準備ができているリクエストです。呼び出しは、作成者と送信者の間の関心の分離を可能にする汎用(コマンド)インターフェースを提供します。特に、送信者は、呼び出しがどのように準備されたかを知る必要はありませんが、呼び出しがどのように(同期的または非同期的に)実行されるべきか、いつ実行されるべきかだけを知る必要があります。
    作成者:
    Marek Potociar, Santiago Pericas-Geertsen
    関連事項:
    Invocation.Builder
    • ネストされたクラスのサマリー

      ネストされたクラス  
      修飾子と型 インターフェース 説明
      static interface Invocation.Builder
      クライアントリクエスト呼び出しビルダー。
    • メソッドのサマリー

      すべてのメソッド   インスタンスメソッド   抽象メソッド  
      修飾子と型 メソッド 説明
      Responseinvoke()
      リクエストを同期的に呼び出し、レスポンスを受信します。
      <T> Tinvoke​(GenericType<T> responseType)
      リクエストを同期的に呼び出し、指定されたジェネリクス型のレスポンスを受け取ります。
      <T> Tinvoke​(ClassSE<T> responseType)
      リクエストを同期的に呼び出し、指定された型のレスポンスを受信します。
      Invocationproperty​(StringSE name, ObjectSE value)
      この呼び出しによって表されるリクエストのコンテキストで新しいプロパティを設定します。
      FutureSE<Response>submit()
      非同期呼び出しのリクエストを送信し、将来のレスポンスを受け取ります。
      <T> FutureSE<T>submit​(InvocationCallback<T> callback)
      非同期呼び出しのリクエストを送信し、InvocationCallback を登録して、呼び出しの将来の結果を処理します。
      <T> FutureSE<T>submit​(GenericType<T> responseType)
      非同期呼び出しのリクエストを送信し、指定されたジェネリクス型の将来のレスポンスを受け取ります。
      <T> FutureSE<T>submit​(ClassSE<T> responseType)
      非同期呼び出しのリクエストを送信し、指定された型の将来のレスポンスを受信します。
    • メソッドの詳細

      • property

        Invocation property​(StringSE name,
                            ObjectSE value)
        この呼び出しによって表されるリクエストのコンテキストで新しいプロパティを設定します。

        プロパティは ClientRequestContext.getProperty(String) または InterceptorContext.getProperty(String) を介して後で取得できます。指定された名前のプロパティがリクエストコンテキストですでに設定されている場合、プロパティの既存の値が更新されます。null 値をプロパティに設定すると、リクエストプロパティバッグからプロパティが効果的に削除されます。

        パラメーター:
        name - プロパティ名。
        value - (新規)プロパティ値。null 値は、指定された名前のプロパティを削除します。
        戻り値:
        更新された呼び出し。
        関連事項:
        Invocation.Builder.property(String, Object)
      • invoke

        Response invoke()
        リクエストを同期的に呼び出し、レスポンスを受信します。
        戻り値:
        リクエスト呼び出しの結果としての response オブジェクト。
        例外:
        ResponseProcessingException - 受信した HTTP レスポンスの処理が失敗した場合(たとえば、フィルターで、レスポンスエンティティデータを特定の Java 型のインスタンスに変換中に)。
        ProcessingException - リクエスト処理または後続の I/O 操作が失敗した場合。
      • invoke

        <T> T invoke​(ClassSE<T> responseType)
        リクエストを同期的に呼び出し、指定された型のレスポンスを受信します。
        型パラメーター:
        T - レスポンスタイプ
        パラメーター:
        responseType - レスポンスを変換する必要がある Java 型。
        戻り値:
        リクエスト呼び出しの結果として指定された型のレスポンスオブジェクト。
        例外:
        ResponseProcessingException - 受信した HTTP レスポンスの処理が失敗した場合(たとえば、フィルターで、レスポンスエンティティデータを特定の Java 型のインスタンスに変換中に)。
        ProcessingException - リクエスト処理または後続の I/O 操作が失敗した場合。
        WebApplicationException - サーバーから返されたレスポンスのレスポンスステータスコードが successful ではなく、指定されたレスポンス型が Response ではない場合。
      • invoke

        <T> T invoke​(GenericType<T> responseType)
        リクエストを同期的に呼び出し、指定されたジェネリクス型のレスポンスを受け取ります。
        型パラメーター:
        T - 一般的なレスポンス型
        パラメーター:
        responseType - レスポンスを変換する必要があるジェネリクス Java 型を表す型リテラル。
        戻り値:
        リクエスト呼び出しの結果として指定された汎用型のレスポンスオブジェクト。
        例外:
        ResponseProcessingException - 受信した HTTP レスポンスの処理が失敗した場合(たとえば、フィルターで、レスポンスエンティティデータを特定の Java 型のインスタンスに変換中に)。
        ProcessingException - リクエスト処理または後続の I/O 操作が失敗した場合。
        WebApplicationException - サーバーから返されたレスポンスのレスポンスステータスコードが successful でない場合。
      • submit

        FutureSE<Response> submit()
        非同期呼び出しのリクエストを送信し、将来のレスポンスを受け取ります。

        返された Future インスタンスで Future.get() メソッドを呼び出すと、呼び出し処理が失敗した場合にスローされた ProcessingException をラップする ExecutionExceptionSE がスローされる可能性があることに注意してください。正しく受信されたレスポンスの処理が失敗した場合、ラップされた処理例外は ResponseProcessingException 型になり、処理が失敗した Response インスタンスが含まれます。

        戻り値:
        リクエスト呼び出しの結果としての将来の response オブジェクト。
      • submit

        <T> FutureSE<T> submit​(ClassSE<T> responseType)
        非同期呼び出しのリクエストを送信し、指定された型の将来のレスポンスを受信します。

        返された Future インスタンスで Future.get() メソッドを呼び出すと、呼び出し処理が失敗した場合にスローされる ProcessingException、または受信したレスポンスステータスコードが successful でなく、指定された場合にスローされる WebApplicationException またはそのサブクラスのいずれかをラップする ExecutionExceptionSE がスローされる場合があることに注意してください。レスポンス型は Response ではありません。正しく受信されたレスポンスの処理が失敗した場合、ラップされた処理例外は ResponseProcessingException 型になり、処理が失敗した Response インスタンスが含まれます。

        型パラメーター:
        T - レスポンスタイプ
        パラメーター:
        responseType - レスポンスを変換する必要がある Java 型。
        戻り値:
        リクエスト呼び出しの結果としての、指定された型の将来のレスポンスオブジェクト。
      • submit

        <T> FutureSE<T> submit​(GenericType<T> responseType)
        非同期呼び出しのリクエストを送信し、指定されたジェネリクス型の将来のレスポンスを受け取ります。

        返された Future インスタンスで Future.get() メソッドを呼び出すと、呼び出し処理が失敗した場合にスローされる ProcessingException、または受信したレスポンスステータスコードが successful でなく、指定された場合にスローされる WebApplicationException またはそのサブクラスのいずれかをラップする ExecutionExceptionSE がスローされる場合があることに注意してください。レスポンス型は Response ではありません。正しく受信されたレスポンスの処理が失敗した場合、ラップされた処理例外は ResponseProcessingException 型になり、処理が失敗した Response インスタンスが含まれます。

        型パラメーター:
        T - 一般的なレスポンス型
        パラメーター:
        responseType - レスポンスを変換する必要があるジェネリクス Java 型を表す型リテラル。
        戻り値:
        リクエスト呼び出しの結果としての、指定された汎用型の将来のレスポンスオブジェクト。
      • submit

        <T> FutureSE<T> submit​(InvocationCallback<T> callback)
        非同期呼び出しのリクエストを送信し、InvocationCallback を登録して、呼び出しの将来の結果を処理します。

        返された Future インスタンスで Future.get() メソッドを呼び出すと、呼び出し処理が失敗した場合にスローされる ProcessingException、または受信したレスポンスステータスコードが successful および汎用でない場合にスローされる WebApplicationException またはそのサブクラスのいずれかをラップする ExecutionExceptionSE がスローされる場合があることに注意してください。提供されたレスポンスコールバックの型は Response ではありません。正しく受信されたレスポンスの処理が失敗した場合、ラップされた処理例外は ResponseProcessingException 型になり、処理が失敗した Response インスタンスが含まれます。

        型パラメーター:
        T - レスポンスタイプ
        パラメーター:
        callback - リクエスト呼び出し結果の非同期処理のための呼び出しコールバック。
        戻り値:
        リクエスト呼び出しの結果としての、指定された型の将来のレスポンスオブジェクト。