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

インターフェース WebTarget

すべてのスーパーインターフェース:
Configurable<WebTarget>
public interface WebTarget extends Configurable<WebTarget>
リソース URI によって識別されるリソースターゲット。
導入:
2.0
作成者:
Marek Potociar

  • 方法の概要

    修飾子と型
    メソッド
    説明
    URISE
    getUri()
    リソースを識別する URI を取得します。
    UriBuilder
    getUriBuilder()
    現在のリソースターゲットの URISE で初期化された URI ビルダーを取得します。
    WebTarget
    matrixParam(StringSE name, ObjectSE... values)
    現在のターゲットインスタンスの URI の現在の最終セグメントのマトリックスパラメーターの既存のセットにマトリックスパラメーターを追加して、新しい WebTarget インスタンスを作成します。
    WebTarget
    path(StringSE path)
    現在のターゲットインスタンスの URI にパスを追加して、新しい WebTarget インスタンスを作成します。
    WebTarget
    queryParam(StringSE name, ObjectSE... values)
    現在のターゲットインスタンスの URI でクエリパラメーターを構成して、新しい WebTarget インスタンスを作成します。
    Invocation.Builder
    request()
    ターゲットとなる Web リソースへのリクエストの作成を開始します。
    Invocation.Builder
    request(MediaType... acceptedResponseTypes)
    ターゲット Web リソースへのリクエストの作成を開始し、受け入れられるレスポンスメディア型を定義します。
    Invocation.Builder
    request(StringSE... acceptedResponseTypes)
    ターゲット Web リソースへのリクエストの作成を開始し、受け入れられるレスポンスメディア型を定義します。
    WebTarget
    resolveTemplate(StringSE name, ObjectSE value)
    指定された値を使用して、現在のターゲットインスタンスの URI 内の特定の name で URI テンプレートを解決することにより、新しい WebTarget インスタンスを作成します。
    WebTarget
    resolveTemplate(StringSE name, ObjectSE value, boolean encodeSlashInPath)
    指定された値を使用して、現在のターゲットインスタンスの URI 内の特定の name で URI テンプレートを解決することにより、新しい WebTarget インスタンスを作成します。
    WebTarget
    resolveTemplateFromEncoded(StringSE name, ObjectSE value)
    提供されたエンコードされた値を使用して、現在のターゲットインスタンスの URI 内の特定の name で URI テンプレートを解決することにより、新しい WebTarget インスタンスを作成します。
    WebTarget
    resolveTemplates(MapSE<StringSE,ObjectSE> templateValues)
    指定された名前と値のペアを使用して、現在のターゲットインスタンスの URI で 1 つ以上の URI テンプレートを解決することにより、新しい WebTarget インスタンスを作成します。
    WebTarget
    resolveTemplates(MapSE<StringSE,ObjectSE> templateValues, boolean encodeSlashInPath)
    指定された名前と値のペアを使用して、現在のターゲットインスタンスの URI で 1 つ以上の URI テンプレートを解決することにより、新しい WebTarget インスタンスを作成します。
    WebTarget
    resolveTemplatesFromEncoded(MapSE<StringSE,ObjectSE> templateValues)
    指定された名前エンコード値のペアを使用して、現在のターゲットインスタンスの URI で 1 つ以上の URI テンプレートを解決することにより、新しい WebTarget インスタンスを作成します。

    インターフェース jakarta.ws.rs.core.Configurable から継承されたメソッド

    getConfiguration, property, register, register, register, register, register, register, register, register

  • メソッドの詳細

    • getUri

      URISE getUri()
      リソースを識別する URI を取得します。
      戻り値:
      リソース URI。

    • getUriBuilder

      UriBuilder getUriBuilder()
      現在のリソースターゲットの URISE で初期化された URI ビルダーを取得します。返された URI ビルダーはターゲットから切り離されます。つまり、URI ビルダーでの更新は、元のターゲットの URI に影響を与えてはなりません（MUST NOT）。
      戻り値:
      初期化された URI ビルダー。

    • path

      WebTarget path(StringSE path)
      現在のターゲットインスタンスの URI にパスを追加して、新しい WebTarget インスタンスを作成します。

      最終パスを作成するとき、必要に応じて、既存のパスと指定されたパスの間に "/" 区切り文字が挿入されます。既存の "/" 文字は保持されるため、単一の値で複数の URI パスセグメントを表すことができます。

      現在の（親）ターゲットインスタンスの現在の構成のスナップショットが取得され、新しく構築された（子）ターゲットインスタンスによって継承されます。

      パラメーター:
      path - パス。URI テンプレートパラメーターを含めることができます。
      戻り値:
      新しいターゲットインスタンス。
      例外:
      NullPointerExceptionSE - パスが null の場合。

    • resolveTemplate

      WebTarget resolveTemplate(StringSE name, ObjectSE value)
      指定された値を使用して、現在のターゲットインスタンスの URI 内の特定の name で URI テンプレートを解決することにより、新しい WebTarget インスタンスを作成します。null テンプレートの名前または値が入力された場合、NullPointerExceptionSE がスローされます。

      現在の（親）ターゲットインスタンスの現在の構成のスナップショットが取得され、新しく構築された（子）ターゲットインスタンスによって継承されます。

      パラメーター:
      name - URI テンプレートの名前。
      value - テンプレートを解決するために使用される値。
      戻り値:
      新しいターゲットインスタンス。
      例外:
      NullPointerExceptionSE - 解決されたテンプレートの名前または値が null の場合。

    • resolveTemplate

      WebTarget resolveTemplate(StringSE name, ObjectSE value, boolean encodeSlashInPath)
      指定された値を使用して、現在のターゲットインスタンスの URI 内の特定の name で URI テンプレートを解決することにより、新しい WebTarget インスタンスを作成します。null テンプレートの名前または値が入力された場合、NullPointerExceptionSE がスローされます。

      現在の（親）ターゲットインスタンスの現在の構成のスナップショットが取得され、新しく構築された（子）ターゲットインスタンスによって継承されます。

      パラメーター:
      name - URI テンプレートの名前。
      value - テンプレートを解決するために使用される値。
      encodeSlashInPath - true の場合、テンプレートが URI パスコンポーネントに配置されていると、テンプレート値のスラッシュ（'/'）文字がエンコードされます。それ以外の場合、スラッシュ文字はパステンプレートにエンコードされません。
      戻り値:
      新しいターゲットインスタンス。
      例外:
      NullPointerExceptionSE - 解決されたテンプレートの名前または値が null の場合。

    • resolveTemplateFromEncoded

      WebTarget resolveTemplateFromEncoded(StringSE name, ObjectSE value)
      指定されたエンコード値を使用して、現在のターゲットインスタンスの URI で指定された name を使用して URI テンプレートを解決することにより、新しい WebTarget インスタンスを作成します。一致する名前のテンプレートは、指定された値に置き換えられます。値は、toString() メソッドを使用して String に変換され、関連する URI コンポーネントのルールに一致するようにエンコードされます。2 つの 16 進数が続かない、文字列化された値のすべての % 文字がエンコードされます。null テンプレートの名前または値が入力されると、NullPointerExceptionSE がスローされます。

      現在の（親）ターゲットインスタンスの現在の構成のスナップショットが取得され、新しく構築された（子）ターゲットインスタンスによって継承されます。

      パラメーター:
      name - URI テンプレートの名前。
      value - テンプレートの解決に使用されるエンコードされた値。
      戻り値:
      新しいターゲットインスタンス。
      例外:
      NullPointerExceptionSE - 解決されたテンプレートの名前または値が null の場合。

    • resolveTemplates

      WebTarget resolveTemplates(MapSE<StringSE,ObjectSE> templateValues)
      指定された名前と値のペアを使用して、現在のターゲットインスタンスの URI で 1 つ以上の URI テンプレートを解決することにより、新しい WebTarget インスタンスを作成します。空のパラメーターマップを使用したメソッドの呼び出しは無視されます。つまり、同じ WebTarget インスタンスが返されます。

      現在の（親）ターゲットインスタンスの現在の構成のスナップショットが取得され、新しく構築された（子）ターゲットインスタンスによって継承されます。

      パラメーター:
      templateValues - URI テンプレート名とその値のマップ。
      戻り値:
      入力された名前と値のマップが空の場合は、新しいターゲットインスタンスまたは同じターゲットインスタンス。
      例外:
      NullPointerExceptionSE - 名前と値のマップ、またはマップ内の名前または値のいずれかが null の場合。

    • resolveTemplates

      WebTarget resolveTemplates(MapSE<StringSE,ObjectSE> templateValues, boolean encodeSlashInPath)
      指定された名前と値のペアを使用して、現在のターゲットインスタンスの URI で 1 つ以上の URI テンプレートを解決することにより、新しい WebTarget インスタンスを作成します。空のパラメーターマップを使用したメソッドの呼び出しは無視されます。つまり、同じ WebTarget インスタンスが返されます。

      現在の（親）ターゲットインスタンスの現在の構成のスナップショットが取得され、新しく構築された（子）ターゲットインスタンスによって継承されます。

      パラメーター:
      templateValues - URI テンプレート名とその値のマップ。
      encodeSlashInPath - true の場合、テンプレートが URI パスコンポーネントに配置されていると、テンプレート値のスラッシュ（'/'）文字がエンコードされます。それ以外の場合、スラッシュ文字はパステンプレートにエンコードされません。
      戻り値:
      入力された名前と値のマップが空の場合は、新しいターゲットインスタンスまたは同じターゲットインスタンス。
      例外:
      NullPointerExceptionSE - 名前と値のマップ、またはマップ内の名前または値のいずれかが null の場合。

    • resolveTemplatesFromEncoded

      WebTarget resolveTemplatesFromEncoded(MapSE<StringSE,ObjectSE> templateValues)
      指定された名前でエンコードされた値のペアを使用して、現在のターゲットインスタンスの URI で 1 つ以上の URI テンプレートを解決することにより、新しい WebTarget インスタンスを作成します。提供されたマップのキーの 1 つと名前が一致するすべてのテンプレートは、提供されたマップの値に置き換えられます。値は、toString() メソッドを使用して String に変換され、関連する URI コンポーネントのルールに一致するようにエンコードされます。2 つの 16 進数が続かない、文字列化された値のすべての % 文字がエンコードされます。空のパラメーターマップを使用したメソッドの呼び出しは無視されます。つまり、同じ WebTarget インスタンスが返されます。

      現在の（親）ターゲットインスタンスの現在の構成のスナップショットが取得され、新しく構築された（子）ターゲットインスタンスによって継承されます。

      パラメーター:
      templateValues - URI テンプレート名とそれらのエンコードされた値のマップ。
      戻り値:
      入力された名前と値のマップが空の場合は、新しいターゲットインスタンスまたは同じターゲットインスタンス。
      例外:
      NullPointerExceptionSE - 名前と値のマップ、またはマップ内の名前またはエンコードされた値のいずれかが null の場合。

    • matrixParam

      WebTarget matrixParam(StringSE name, ObjectSE... values)
      現在のターゲットインスタンスの URI の現在の最終セグメントの既存のマトリックスパラメーターのセットにマトリックスパラメーターを追加して、新しい WebTarget インスタンスを作成します。複数の値が指定されている場合、パラメーターは値ごとに 1 回追加されます。単一の null 値が入力された場合、現在の最終パスセグメント内のその名前のすべてのパラメーターは、現在のターゲットから継承された最後のセグメントマトリックスパラメーターのコレクションから削除されます（存在する場合）。

      マトリックスパラメーターは特定のパスセグメントに関連付けられていることに注意してください。既存のマトリックスパラメーター名に値を追加しても、URI パス内のマトリックスパラメーターの位置には影響しません。

      現在の（親）ターゲットインスタンスの現在の構成のスナップショットが取得され、新しく構築された（子）ターゲットインスタンスによって継承されます。

      パラメーター:
      name - マトリックスパラメーター名には、URI テンプレートパラメーターを含めることができます。
      values - マトリックスパラメーター値。各オブジェクトは、toString() メソッドを使用して String に変換されます。文字列化された値には、URI テンプレートパラメーターが含まれる場合があります。
      戻り値:
      新しいターゲットインスタンス。
      例外:
      NullPointerExceptionSE - パラメーター名が null の場合、または複数の値が存在し、それらの値のいずれかが null である場合。
      関連事項:

    • queryParam

      WebTarget queryParam(StringSE name, ObjectSE... values)
      現在のターゲットインスタンスの URI にクエリパラメーターを設定して、新しい WebTarget インスタンスを作成します。複数の値が指定されている場合、パラメーターは値ごとに 1 回追加されます。単一の null 値が入力された場合、その名前のすべてのパラメーターは、現在のターゲットから継承されたクエリパラメーターのコレクションから削除されます（存在する場合）。

      現在の（親）ターゲットインスタンスの現在の構成のスナップショットが取得され、新しく構築された（子）ターゲットインスタンスによって継承されます。

      パラメーター:
      name - クエリパラメーター名。URI テンプレートパラメーターを含めることができます
      values - クエリパラメーター値の場合、各オブジェクトは toString() メソッドを使用して String に変換されます。文字列化された値には、URI テンプレートパラメーターが含まれる場合があります。
      戻り値:
      新しいターゲットインスタンス。
      例外:
      NullPointerExceptionSE - パラメーター名が null の場合、または複数の値が存在し、それらの値のいずれかが null である場合。

    • request

      Invocation.Builder request()
      ターゲットとなる Web リソースへのリクエストの作成を開始します。
      戻り値:
      このターゲットインスタンスによって参照される URI をターゲットとするリクエストのビルダー。

    • request

      Invocation.Builder request(StringSE... acceptedResponseTypes)
      ターゲット Web リソースへのリクエストの作成を開始し、受け入れられるレスポンスメディア型を定義します。

      このメソッドの呼び出しは、次と同じです。

       webTarget.request().accept(types);
      パラメーター:
      acceptedResponseTypes - 受け入れられたレスポンスメディア型。
      戻り値:
      このターゲットインスタンスによって参照される URI をターゲットとするリクエストのビルダー。

    • request

      Invocation.Builder request(MediaType... acceptedResponseTypes)
      ターゲット Web リソースへのリクエストの作成を開始し、受け入れられるレスポンスメディア型を定義します。

      このメソッドの呼び出しは、次と同じです。

       webTarget.request().accept(types);
      パラメーター:
      acceptedResponseTypes - 受け入れられたレスポンスメディア型。
      戻り値:
      このターゲットインスタンスによって参照される URI をターゲットとするリクエストのビルダー。