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

インターフェース Client

  • すべてのスーパーインターフェース:
    AutoCloseableSEConfigurable<Client>

    public interface Client
    extends Configurable<Client>, AutoCloseableSE

    クライアントは、返されたレスポンスを消費するためにクライアントリクエストを作成および実行するために使用される流れるような API への主要なエントリポイントです。

    クライアントは、クライアント側の通信インフラストラクチャを管理する重量級のオブジェクトです。Client インスタンスの初期化と破棄は、かなりコストのかかる操作になる可能性があります。アプリケーションで少数の Client インスタンスのみを構築することをお勧めします。リソースのリークを回避するために、クライアントインスタンスは破棄する前に properly closed である必要があります。
    導入:
    2.0
    作成者:
    Marek Potociar
    関連事項:
    Configurable
    • メソッドの詳細

      • close

        void close()

        クライアントインスタンスとそれに関連するすべてのリソースを閉じます。後続の呼び出しは効果がなく、無視されます。クライアントが閉じられると、クライアントインスタンスで他のメソッドを呼び出すと、IllegalStateExceptionSE がスローされます。

        このメソッドを呼び出すと、クライアントインスタンスによって生成されたすべての resource targets が事実上無効になります。クライアントが閉じられた後でそのようなターゲットでメソッドを呼び出すと、IllegalStateExceptionSE がスローされます。
        次で指定:
        インターフェース AutoCloseableSEclose 
      • target

        WebTarget target​(StringSE uri)
        新しい Web リソースターゲットをビルドします。
        パラメーター:
        uri - Web リソース URI。テンプレートパラメーターを含めることができます。null であってはなりません。
        戻り値:
        指定された URI にバインドされた Web リソースターゲット。
        例外:
        IllegalArgumentExceptionSE - 指定された文字列が有効な URI テンプレートではない場合。
        NullPointerExceptionSE - 指定された引数が null の場合。
      • target

        WebTarget target​(URISE uri)
        新しい Web リソースターゲットをビルドします。
        パラメーター:
        uri - Web リソース URI。null であってはなりません。
        戻り値:
        指定された URI にバインドされた Web リソースターゲット。
        例外:
        NullPointerExceptionSE - 指定された引数が null の場合。
      • target

        WebTarget target​(UriBuilder uriBuilder)
        新しい Web リソースターゲットをビルドします。
        パラメーター:
        uriBuilder - URI ビルダーとして表される Web リソース URI。null であってはなりません。
        戻り値:
        指定された URI にバインドされた Web リソースターゲット。
        例外:
        NullPointerExceptionSE - 指定された引数が null の場合。
      • target

        WebTarget target​(Link link)
        新しい Web リソースターゲットをビルドします。
        パラメーター:
        link - Web リソースへのリンク。null であってはなりません。
        戻り値:
        リンクされた Web リソースにバインドされた Web リソースターゲット。
        例外:
        NullPointerExceptionSE - 指定された引数が null の場合。
      • invocation

        Invocation.Builder invocation​(Link link)

        リンクから呼び出しビルダーを構築します。URI とリンクの型を使用して、呼び出しビルダーを初期化します。型は、HTTP Accept ヘッダー(存在する場合)の初期値として使用されます。

        パラメーター:
        link - 呼び出しを作成するためのリンク。null であってはなりません。
        戻り値:
        新しく作成された呼び出しビルダー。
        例外:
        NullPointerExceptionSE - リンクが null の場合。
      • getSslContext

        SSLContextSE getSslContext()
        現在のクライアントランタイムで使用するように構成された SSL コンテキストを取得します。
        戻り値:
        現在のクライアントランタイムで使用するように構成された SSL コンテキスト。
      • getHostnameVerifier

        HostnameVerifierSE getHostnameVerifier()
        ホスト名検証が構成されていない場合は、クライアントまたは null で構成されているホスト名検証を取得します。
        戻り値:
        クライアントのホスト名検証、または設定されていない場合は null