パッケージ jakarta.xml.soap

インターフェース SOAPHeader

  • すべてのスーパーインターフェース:
    ElementSE、Node、NodeSE、SOAPElement
    public interface SOAPHeader
extends SOAPElement
    SOAP ヘッダー要素の表現。SOAP ヘッダー要素は、アプリケーション固有のコンテンツがメッセージプロバイダーによって処理される方法に影響を与える XML データで構成されます。例: トランザクションセマンティクス、認証情報などは、SOAPHeader オブジェクトのコンテンツとして指定できます。

    SOAPEnvelope オブジェクトには、デフォルトで空の SOAPHeader オブジェクトが含まれています。オプションの SOAPHeader オブジェクトが不要な場合は、次のコード行で取得および削除できます。変数 se は SOAPEnvelope オブジェクトです。

    
      se.getHeader().detachNode();
    SOAPHeader オブジェクトは、SOAPEnvelope メソッド addHeader を使用して作成されます。新しいヘッダーを作成してエンベロープに追加するこのメソッドは、既存のヘッダーが削除された後にのみ呼び出すことができます。
    
      se.getHeader().detachNode();
      SOAPHeader sh = se.addHeader();

    SOAPHeader オブジェクトは、その直接の子として SOAPHeaderElement オブジェクトのみを持つことができます。メソッド addHeaderElement は、新しい HeaderElement オブジェクトを作成し、それを SOAPHeader オブジェクトに追加します。次のコード行では、メソッド addHeaderElement の引数は、新しい HeaderElement オブジェクトの名前である Name オブジェクトです。

    
      SOAPHeaderElement shElement = sh.addHeaderElement(name);
    導入:
    1.6
    関連事項:
    SOAPHeaderElement

    • メソッドの詳細

      • addHeaderElement

        SOAPHeaderElement addHeaderElement​(Name name)
                            throws SOAPException
        指定された名前で初期化された新しい SOAPHeaderElement オブジェクトを作成し、それをこの SOAPHeader オブジェクトに追加します。
        パラメーター:
        name - 新しい SOAPHeaderElement オブジェクトの名前を持つ Name オブジェクト
        戻り値:
        この SOAPHeader オブジェクトに挿入された新しい SOAPHeaderElement オブジェクト
        例外:
        SOAPException - SOAP エラーが発生した場合
        関連事項:
        addHeaderElement(javax.xml.namespace.QName)

      • addHeaderElement

        SOAPHeaderElement addHeaderElement​(QNameSE qname)
                            throws SOAPException
        指定された qname で初期化された新しい SOAPHeaderElement オブジェクトを作成し、それをこの SOAPHeader オブジェクトに追加します。
        パラメーター:
        qname - 新しい SOAPHeaderElement オブジェクトの qname を持つ QName オブジェクト
        戻り値:
        この SOAPHeader オブジェクトに挿入された新しい SOAPHeaderElement オブジェクト
        例外:
        SOAPException - SOAP エラーが発生した場合
        導入:
        1.6、SAAJ 1.3
        関連事項:
        addHeaderElement(Name)

      • examineMustUnderstandHeaderElements

        IteratorSE<SOAPHeaderElement> examineMustUnderstandHeaderElements​(StringSE actor)
        この SOAPHeader オブジェクト内の、指定されたアクターを持ち、値が true と同等の MustUnderstand 属性を持つすべての SOAPHeaderElement オブジェクトに対して Iterator を返します。

        SOAP 1.2 では、env:actor 属性が env:role 属性に置き換えられていますが、セマンティクスは基本的に同じです。

        パラメーター:
        actor - 検索する actor / role の URI を指定する String 
        戻り値:
        指定された actor / role を含み、MustUnderstand としてマークされているすべての SOAPHeaderElement オブジェクトの Iterator オブジェクト
        導入:
        1.6、SAAJ 1.2
        関連事項:
        examineHeaderElements(java.lang.String), extractHeaderElements(java.lang.String), SOAPConstants.URI_SOAP_ACTOR_NEXT

      • examineHeaderElements

        IteratorSE<SOAPHeaderElement> examineHeaderElements​(StringSE actor)
        指定されたアクターを持つこの SOAPHeader オブジェクト内のすべての SOAPHeaderElement オブジェクトに対して Iterator を返します。 アクターは、メッセージが最終的な受信者に到達する前にメッセージを処理する必要がある中間パーティを示すグローバル属性です。アクターはメッセージを受信して処理してから、次のアクターに送信します。デフォルトのアクターはメッセージの最終的な受信者であるため、SOAPHeader オブジェクトにアクター属性が含まれていない場合は、メッセージ本文とともに最終的な受信者に送信されます。

        SOAP 1.2 では、env:actor 属性が env:role 属性に置き換えられていますが、セマンティクスは基本的に同じです。

        パラメーター:
        actor - 検索する actor / role の URI を指定する String 
        戻り値:
        指定された actor / role を含むすべての SOAPHeaderElement オブジェクトの Iterator オブジェクト
        関連事項:
        extractHeaderElements(java.lang.String), SOAPConstants.URI_SOAP_ACTOR_NEXT

      • extractHeaderElements

        IteratorSE<SOAPHeaderElement> extractHeaderElements​(StringSE actor)
        指定されたアクターを持つこの SOAPHeader オブジェクト内のすべての SOAPHeaderElement オブジェクトに対して Iterator を返し、この SOAPHeader オブジェクトから切り離します。

        このメソッドにより、アクターは、それに適用される SOAPHeader オブジェクトの部分を処理し、メッセージを次のアクターに渡す前に削除できます。

        SOAP 1.2 では、env:actor 属性が env:role 属性に置き換えられていますが、セマンティクスは基本的に同じです。

        パラメーター:
        actor - 検索する actor / role の URI を指定する String 
        戻り値:
        指定された actor / role を含むすべての SOAPHeaderElement オブジェクトの Iterator オブジェクト
        関連事項:
        examineHeaderElements(java.lang.String), SOAPConstants.URI_SOAP_ACTOR_NEXT

      • addNotUnderstoodHeaderElement

        SOAPHeaderElement addNotUnderstoodHeaderElement​(QNameSE name)
                                         throws SOAPException
        指定された名前で初期化された新しい NotUnderstood SOAPHeaderElement オブジェクトを作成し、この SOAPHeader オブジェクトに追加します。この操作は、SOAP 1.2 でのみサポートされています。
        パラメーター:
        name - 理解できなかった SOAPHeaderElement オブジェクトの名前を持つ QName オブジェクト。
        戻り値:
        この SOAPHeader オブジェクトに挿入された新しい SOAPHeaderElement オブジェクト
        例外:
        SOAPException - SOAP エラーが発生した場合。
        UnsupportedOperationExceptionSE - これが SOAP 1.1 ヘッダーの場合。
        導入:
        1.6、SAAJ 1.3

      • addUpgradeHeaderElement

        SOAPHeaderElement addUpgradeHeaderElement​(IteratorSE<StringSE> supportedSOAPURIs)
                                   throws SOAPException
        サポートされている SOAP URI の指定されたリストで初期化された新しいアップグレード SOAPHeaderElement オブジェクトを作成し、この SOAPHeader オブジェクトに追加します。この操作は、SOAP 1.1 ヘッダーと SOAP 1.2 ヘッダーの両方でサポートされています。
        パラメーター:
        supportedSOAPURIs - サポートされている SOAP バージョンの URI を持つ Iterator オブジェクト。
        戻り値:
        この SOAPHeader オブジェクトに挿入された新しい SOAPHeaderElement オブジェクト
        例外:
        SOAPException - SOAP エラーが発生した場合。
        導入:
        1.6、SAAJ 1.3

      • addUpgradeHeaderElement

        SOAPHeaderElement addUpgradeHeaderElement​(StringSE[] supportedSoapUris)
                                   throws SOAPException
        サポートされている SOAP URI の指定された配列で初期化された新しいアップグレード SOAPHeaderElement オブジェクトを作成し、この SOAPHeader オブジェクトに追加します。この操作は、SOAP 1.1 ヘッダーと SOAP 1.2 ヘッダーの両方でサポートされています。
        パラメーター:
        supportedSoapUris - サポートされている SOAP バージョンの URI の配列。
        戻り値:
        この SOAPHeader オブジェクトに挿入された新しい SOAPHeaderElement オブジェクト
        例外:
        SOAPException - SOAP エラーが発生した場合。
        導入:
        1.6、SAAJ 1.3

      • addUpgradeHeaderElement

        SOAPHeaderElement addUpgradeHeaderElement​(StringSE supportedSoapUri)
                                   throws SOAPException
        指定されたサポートされている SOAP URI で初期化された新しいアップグレード SOAPHeaderElement オブジェクトを作成し、この SOAPHeader オブジェクトに追加します。この操作は、SOAP 1.1 ヘッダーと SOAP 1.2 ヘッダーの両方でサポートされています。
        パラメーター:
        supportedSoapUri - SOAP の URI サポートされているバージョン。
        戻り値:
        この SOAPHeader オブジェクトに挿入された新しい SOAPHeaderElement オブジェクト
        例外:
        SOAPException - SOAP エラーが発生した場合。
        導入:
        1.6、SAAJ 1.3

      • examineAllHeaderElements

        IteratorSE<SOAPHeaderElement> examineAllHeaderElements()
        この SOAPHeader オブジェクト内のすべての SOAPHeaderElement オブジェクトに対して Iterator を返します。
        戻り値:
        この SOAPHeader に含まれるすべての SOAPHeaderElement オブジェクトの Iterator オブジェクト
        導入:
        1.6、SAAJ 1.2
        関連事項:
        extractAllHeaderElements()

      • extractAllHeaderElements

        IteratorSE<SOAPHeaderElement> extractAllHeaderElements()
        この SOAPHeader オブジェクト内のすべての SOAPHeaderElement オブジェクトに対して Iterator を返し、この SOAPHeader オブジェクトから切り離します。
        戻り値:
        この SOAPHeader に含まれるすべての SOAPHeaderElement オブジェクトの Iterator オブジェクト
        導入:
        1.6、SAAJ 1.2
        関連事項:
        examineAllHeaderElements()