パッケージ jakarta.xml.soap

クラス SOAPConnection

  • 実装されているすべてのインターフェース:
    AutoCloseableSE
    public abstract class SOAPConnection
extends ObjectSE
implements AutoCloseableSE
    クライアントがリモートパーティに直接メッセージを送信するために使用できるポイントツーポイント接続（たとえば、URL で表されます）。

    SOAPConnection クラスはオプションです。一部の実装では、このインターフェースが実装されていない場合があります。その場合、SOAPConnectionFactory.newInstance() （以下を参照）を呼び出すと、UnsupportedOperationException がスローされます。

    クライアントは、次の例のように SOAPConnectionFactory オブジェクトを使用して SOAPConnection オブジェクトを取得できます。

    
      SOAPConnectionFactory factory = SOAPConnectionFactory.newInstance();
      SOAPConnection con = factory.createConnection();
    SOAPConnection オブジェクトを使用して、リクエスト / レスポンスパラダイムに従って URL に直接メッセージを送信できます。つまり、メッセージは call メソッドを使用して送信されます。このメソッドは、メッセージを送信してから、レスポンスを受け取るまで待機します。
    導入:
    1.6

    • コンストラクターの詳細

      • SOAPConnection

        protected SOAPConnection()
        デフォルトコンストラクター。

    • メソッドの詳細

      • call

        public abstract SOAPMessage call​(SOAPMessage request,
                                 ObjectSE to)
                          throws SOAPException
        指定されたメッセージを指定されたエンドポイントに送信し、レスポンスが返されるまでブロックします。
        パラメーター:
        request - 送信される SOAPMessage オブジェクト
        to - メッセージの送信先を識別する Object。型 java.lang.String および java.net.URL のオブジェクトをサポートする必要があります
        戻り値:
        送信されたメッセージへのレスポンスである SOAPMessage オブジェクト
        例外:
        SOAPException - SOAP エラーがある場合

      • get

        public SOAPMessage get​(ObjectSE to)
                throws SOAPException
        特定のエンドポイントからメッセージを取得し、受信するまでブロックします。
        パラメーター:
        to - リクエストの送信先を識別する Object。型 java.lang.String および java.net.URL のオブジェクトがサポートされている必要があります。
        戻り値:
        メッセージ取得リクエストへのレスポンスである SOAPMessage オブジェクト
        例外:
        SOAPException - SOAP エラーがある場合
        導入:
        1.6、SAAJ 1.3

      • setConnectTimeout

        public void setConnectTimeout​(int timeout)
        読み取りタイムアウトをミリ秒単位で指定されたタイムアウトに設定します。ゼロのタイムアウトは、無限のタイムアウトとして解釈されます。
        パラメーター:
        timeout - 使用するタイムアウト値をミリ秒単位で指定する int 
        例外:
        IllegalArgumentExceptionSE - タイムアウトパラメーターが負の場合
        導入:
        3.0

      • getConnectTimeout

        public int getConnectTimeout()
        接続タイムアウトの設定を返します。0 は無限のタイムアウトを意味します
        戻り値:
        接続タイムアウト値をミリ秒単位で示す int 
        導入:
        3.0

      • setReadTimeout

        public void setReadTimeout​(int timeout)
        読み取りタイムアウトをミリ秒単位で指定されたタイムアウトに設定します。ゼロのタイムアウトは、無限のタイムアウトとして解釈されます。
        パラメーター:
        timeout - 使用するタイムアウト値をミリ秒単位で指定する int 
        例外:
        IllegalArgumentExceptionSE - タイムアウトパラメーターが負の場合
        導入:
        3.0

      • getReadTimeout

        public int getReadTimeout()
        読み取りタイムアウトの設定を返します。0 は無限のタイムアウトを意味します
        戻り値:
        読み取りタイムアウト値をミリ秒単位で示す int 
        導入:
        3.0

      • close

        public abstract void close()
                    throws SOAPException
        この SOAPConnection オブジェクトを閉じます。
        次で指定:
        インターフェース AutoCloseableSE の close 
        例外:
        SOAPException - SOAP エラーがある場合