パッケージ jakarta.xml.soap

クラス SOAPPart

  • 実装されたすべてのインターフェース:
    NodeDocumentSENodeSE

    public abstract class SOAPPart
    extends ObjectSE
    implements DocumentSE, Node
    SOAPMessage オブジェクトの SOAP 固有の部分のコンテナー。すべてのメッセージには SOAP 部分が必要であるため、SOAPMessage オブジェクトが作成されると、自動的に SOAPPart オブジェクトが含まれます。

    SOAPPart オブジェクトは MIME パーツであり、MIME ヘッダー Content-Id、Content-Location、Content-Type を持っています。Content-Type の値は "text/xml" でなければならないため、SOAPPart オブジェクトには、値が "text/xml" に設定された Content-Type の MIME ヘッダーが自動的に含まれます。メッセージの SOAP 部分のコンテンツは XML 形式である必要があるため、値は "text/xml" である必要があります。"text/xml" 型ではないコンテンツは、SOAPPart オブジェクトではなく AttachmentPart オブジェクトに存在する必要があります。

    メッセージが送信されるとき、その SOAP 部分には、MIME ヘッダーの Content-Type が "text/xml" に設定されている必要があります。または、別の観点から見ると、受信するメッセージの SOAP 部分には、"text/xml" の値を持つ MIME ヘッダー Content-Type が必要です。

    クライアントは、メソッド SOAPMessage.getSOAPPart を呼び出すことにより、SOAPMessage オブジェクトの SOAPPart オブジェクトにアクセスできます。message が SOAPMessage オブジェクトである次のコード行は、メッセージの SOAP 部分を取得します。

    
       SOAPPart soapPart = message.getSOAPPart();
     

    SOAPPart オブジェクトには SOAPEnvelope オブジェクトが含まれ、SOAPEnvelope オブジェクトには SOAPBody オブジェクトと SOAPHeader オブジェクトが含まれます。SOAPPart メソッド getEnvelope を使用して、SOAPEnvelope オブジェクトを取得できます。

    導入:
    1.6
    • コンストラクターの詳細

      • SOAPPart

        protected SOAPPart()
        デフォルトコンストラクター。
    • メソッドの詳細

      • getEnvelope

        public abstract SOAPEnvelope getEnvelope()
                                          throws SOAPException
        この SOAPPart オブジェクトに関連付けられている SOAPEnvelope オブジェクトを取得します。SOAP エンベロープが取得されると、その内容を取得するために使用できます。
        戻り値:
        この SOAPPart オブジェクトの SOAPEnvelope オブジェクト
        例外:
        SOAPException - SOAP エラーがある場合
      • getContentId

        public StringSE getContentId()
        名前が "Content-Id" である MIME ヘッダーの値を取得します。
        戻り値:
        "Content-Id" という名前の MIME ヘッダーの値を提供する String 
        関連事項:
        setContentId(java.lang.String)
      • getContentLocation

        public StringSE getContentLocation()
        名前が "Content-Location" である MIME ヘッダーの値を取得します。
        戻り値:
        名前が "Content-Location" である MIME ヘッダーの値を与える String 
        関連事項:
        setContentLocation(java.lang.String)
      • setContentId

        public void setContentId​(StringSE contentId)
        "Content-Id" という名前の MIME ヘッダーの値を指定された String に設定します。
        パラメーター:
        contentId - MIME ヘッダー "Content-Id" の値を提供する String 
        例外:
        IllegalArgumentExceptionSE - コンテンツ ID の設定に問題がある場合
        関連事項:
        getContentId()
      • setContentLocation

        public void setContentLocation​(StringSE contentLocation)
        MIME ヘッダー "Content-Location" の値を指定された String に設定します。
        パラメーター:
        contentLocation - MIME ヘッダー "Content-Location" の値を指定する String 
        例外:
        IllegalArgumentExceptionSE - コンテンツの場所の設定に問題がある場合。
        関連事項:
        getContentLocation()
      • removeMimeHeader

        public abstract void removeMimeHeader​(StringSE header)
        指定された名前に一致するすべての MIME ヘッダーを削除します。
        パラメーター:
        header - 削除する MIME ヘッダーの名前を指定する String 
      • removeAllMimeHeaders

        public abstract void removeAllMimeHeaders()
        この SOAPEnvelope オブジェクトのすべての MimeHeader オブジェクトを削除します。
      • getMimeHeader

        public abstract StringSE[] getMimeHeader​(StringSE name)
        指定された String によって識別されるこの SOAPPart オブジェクト内の MimeHeader オブジェクトのすべての値を取得します。
        パラメーター:
        name - ヘッダーの名前。例: 「コンテンツ型」
        戻り値:
        指定されたヘッダーのすべての値を示す String 配列
        関連事項:
        setMimeHeader(java.lang.String, java.lang.String)
      • setMimeHeader

        public abstract void setMimeHeader​(StringSE name,
                                           StringSE value)
        指定されたヘッダー名に一致する最初のヘッダーエントリを変更して、その値が指定された値になるようにします。既存のヘッダーが一致しない場合は、指定された名前と値で新しいヘッダーを追加します。一致する場合、このメソッドは一致する最初のヘッダーの既存の値をすべてクリアし、代わりに指定された値を設定します。複数のヘッダーに指定された名前がある場合、このメソッドは最初のヘッダーの後に一致するすべてのヘッダーを削除します。

        RFC822 ヘッダーには、US-ASCII 文字のみを含めることができることに注意してください。

        パラメーター:
        name - 検索するヘッダー名を指定する String 
        value - 設定する値を指定する String。この値は、一致する最初のヘッダーの現在の値 (存在する場合) に置き換えられます。一致するものがない場合、この値は新しい MimeHeader オブジェクトの値になります。
        例外:
        IllegalArgumentExceptionSE - 指定された mime ヘッダーの名前または値に問題があった場合
        関連事項:
        getMimeHeader(java.lang.String)
      • addMimeHeader

        public abstract void addMimeHeader​(StringSE name,
                                           StringSE value)
        指定された名前と値で MimeHeader オブジェクトを作成し、この SOAPPart オブジェクトに追加します。指定された名前の MimeHeader がすでに存在する場合、このメソッドは指定された値を既存の値に追加します。

        RFC822 ヘッダーには、US-ASCII 文字のみを含めることができることに注意してください。

        パラメーター:
        name - ヘッダー名を指定する String 
        value - 設定または追加する値を指定する String 
        例外:
        IllegalArgumentExceptionSE - 指定された mime ヘッダーの名前または値に問題があった場合
      • getAllMimeHeaders

        public abstract IteratorSE<MimeHeader> getAllMimeHeaders()
        この SOAPPart オブジェクトのすべてのヘッダーを、MimeHeader オブジェクトのイテレーターとして取得します。
        戻り値:
        この SOAPPart オブジェクトのすべての Mime ヘッダーを含む Iterator オブジェクト
      • getMatchingMimeHeaders

        public abstract IteratorSE<MimeHeader> getMatchingMimeHeaders​(StringSE[] names)
        指定された配列の名前に一致するすべての MimeHeader オブジェクトを取得します。
        パラメーター:
        names - 返される MIME ヘッダーの名前を持つ String 配列
        戻り値:
        指定された配列内の名前のいずれかに一致するすべての MIME ヘッダー。Iterator オブジェクトとして返されます
      • getNonMatchingMimeHeaders

        public abstract IteratorSE<MimeHeader> getNonMatchingMimeHeaders​(StringSE[] names)
        指定された配列の名前と名前が一致しないすべての MimeHeader オブジェクトを取得します。
        パラメーター:
        names - 返されない MIME ヘッダーの名前を持つ String 配列
        戻り値:
        指定された配列内の名前のいずれかに一致するものを除く、この SOAPPart オブジェクト内のすべての MIME ヘッダー。一致しない MIME ヘッダーは、Iterator オブジェクトとして返されます。
      • setContent

        public abstract void setContent​(SourceSE source)
                                 throws SOAPException
        指定された Source オブジェクトからのデータで SOAPEnvelope オブジェクトのコンテンツを設定します。この Source には、有効な SOAP ドキュメントが含まれている必要があります。
        パラメーター:
        source - データを設定する javax.xml.transform.Source オブジェクト
        例外:
        SOAPException - ソースの設定に問題がある場合
        関連事項:
        getContent()
      • getContent

        public abstract SourceSE getContent()
                                   throws SOAPException
        SOAPEnvelope のコンテンツを JAXP Source オブジェクトとして返します。
        戻り値:
        javax.xml.transform.Source オブジェクトとしてのコンテンツ
        例外:
        SOAPException - 実装が指定された Source オブジェクトを変換できない場合
        関連事項:
        setContent(javax.xml.transform.Source)