モジュール java.xml.ws
パッケージ javax.xml.soap

インタフェースSOAPHeader

  • すべてのスーパー・インタフェース:
    Element, Node, Node, 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​(QName qname)
                            throws SOAPException
        指定のqnameで初期化されたSOAPHeaderElementオブジェクトを新しく作成し、このSOAPHeaderオブジェクトに追加します。
        パラメータ:
        qname - 新規SOAPHeaderElementオブジェクトのqnameを持つQNameオブジェクト
        戻り値:
        このSOAPHeaderオブジェクトに挿入された新しいSOAPHeaderElementオブジェクト
        例外:
        SOAPException - SOAPエラーが発生した場合
        導入されたバージョン:
        1.6, SAAJ 1.3
        関連項目:
        addHeaderElement(Name)

      • examineMustUnderstandHeaderElements

        Iterator<SOAPHeaderElement> examineMustUnderstandHeaderElements​(String actor)
        指定されたactorを持ち、MustUnderstand属性の値がtrueと同じものを持つSOAPHeaderオブジェクト内のすべての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

        Iterator<SOAPHeaderElement> examineHeaderElements​(String actor)
        指定されたactorを持つこのSOAPHeaderオブジェクト内のすべてのSOAPHeaderElementオブジェクトについてのIteratorを返します。 actorは、メッセージが最終的な受信者に届く前に処理する必要のある中間の相手を示す、グローバル属性です。 アクターはメッセージを受信し、次のアクターに送信する前にメッセージを処理します。 デフォルトのアクターはメッセージの意図された最終的な受信者であり、アクター属性が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

        Iterator<SOAPHeaderElement> extractHeaderElements​(String actor)
        指定された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​(QName name)
                                         throws SOAPException
        指定の名前で初期化されたNotUnderstood SOAPHeaderElementオブジェクトを新しく作成し、このSOAPHeaderオブジェクトに追加します。 この操作は、SOAP 1.2でのみサポートされます。
        パラメータ:
        name - 認識されなかったSOAPHeaderElementオブジェクトの名前を持つQNameオブジェクト。
        戻り値:
        このSOAPHeaderオブジェクトに挿入された新しいSOAPHeaderElementオブジェクト
        例外:
        SOAPException - SOAPエラーが発生した場合。
        UnsupportedOperationException - これがSOAP 1.1 Headerの場合。
        導入されたバージョン:
        1.6, SAAJ 1.3

      • addUpgradeHeaderElement

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

      • addUpgradeHeaderElement

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

      • addUpgradeHeaderElement

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

      • examineAllHeaderElements

        Iterator<SOAPHeaderElement> examineAllHeaderElements​()
        このSOAPHeaderオブジェクト内のすべての属性SOAPHeaderElementオブジェクトについてのIteratorを返します。
        戻り値:
        このSOAPHeaderに含まれているすべてのSOAPHeaderElementオブジェクトのIteratorオブジェクト
        導入されたバージョン:
        1.6, SAAJ 1.2
        関連項目:
        extractAllHeaderElements()

      • extractAllHeaderElements

        Iterator<SOAPHeaderElement> extractAllHeaderElements​()
        SOAPHeaderオブジェクト内のすべてのSOAPHeaderElementオブジェクトについてのIteratorを返し、このSOAPHeaderオブジェクトから切り離します。
        戻り値:
        このSOAPHeaderに含まれているすべてのSOAPHeaderElementオブジェクトのIteratorオブジェクト
        導入されたバージョン:
        1.6, SAAJ 1.2
        関連項目:
        examineAllHeaderElements()